ウェブアプリケーション Thymeleafアダプタ¶
ウェブアプリケーションで、テンプレートエンジンに Thymeleaf(外部サイト) を使用するためのアダプタを提供する。
モジュール一覧¶
<!-- ウェブアプリケーション Thymeleafアダプタ -->
<dependency>
<groupId>com.nablarch.integration</groupId>
<artifactId>nablarch-web-thymeleaf-adaptor</artifactId>
</dependency>
ちなみに
Thymeleafのバージョン3.0.9.RELEASEを使用してテストを行っている。 バージョンを変更する場合は、プロジェクト側でテストを行い問題ないことを確認すること。
ウェブアプリケーション Thymeleafアダプタを使用するための設定を行う¶
本アダプタを使用するためには、コンポーネント設定ファイルで ThymeleafResponseWriter をHttpResponseHandler へ設定する。
ThymeleafResponseWriter にはThymeleafが提供する TemplateEngine を設定する必要がある。
コンポーネント設定ファイルの設定例を以下に示す。
<component name="templateEngine" class="org.thymeleaf.TemplateEngine" autowireType="None">
<property name="templateResolver">
<component class="org.thymeleaf.templateresolver.ClassLoaderTemplateResolver">
<property name="prefix" value="template/"/>
</component>
</property>
</component>
<component name="thymeleafResponseWriter"
class="nablarch.fw.web.handler.responsewriter.thymeleaf.ThymeleafResponseWriter"
autowireType="None">
<property name="templateEngine" ref="templateEngine" />
</component>
<component name="httpResponseHandler"
class="nablarch.fw.web.handler.HttpResponseHandler">
<property name="customResponseWriter" ref="thymeleafResponseWriter"/>
<!-- その他の設定は省略 -->
</component>
ちなみに
ITemplateResolver インタフェースの実装クラスに、
org.thymeleaf.templateresolver.ServletContextTemplateResolver が存在するが、
以下の理由により、システムリポジトリ にコンポーネントとして登録できない。
- コンストラクタ引数に
javax.servlet.ServletContextが必須である(デフォルトコンストラクタを持たない)。 - システムリポジトリ構築時には
javax.servlet.ServletContextにアクセスできず、ファクトリ によるオブジェクト生成もできない。
このため、 ServletContextTemplateResolver ではなく、 ClassLoaderTemplateResolver 等の別の実装クラスを使用すること。
処理対象判定について¶
ThymeleafResponseWriter はHttpResponse のコンテンツパスの内容によって、
テンプレートエンジンを使用してレスポンス出力を行うか否かを判断する。
デフォルトではコンテンツパスが .html で終了している場合、処理対象と判定しテンプレートエンジンによる出力を行う。
例えば、アクションクラスで以下のように HttpResponse を返却したとする。
return new HttpResponse("template/index.html");
この場合、コンテンツパス(template/index.html)は .html で終了しているため、
テンプレートエンジンの出力対象と判定される。
処理対象と判定されなかった場合は、テンプレートエンジンによる出力は行われず、サーブレットフォワードが実行される。
例えば、以下の例では、コンテンツパスが .html で終了していないため、サーブレットフォワードが実行される。
return new HttpResponse("/path/to/anotherServlet");
この処理対象判定条件は設定変更が可能である。プロパティpathPattern に、判定に使用する正規表現が設定できる(デフォルト値は .*\.html )。この正規表現にコンテンツパスがマッチした場合、テンプレートエンジンの処理対象と判定される。
重要
Thymeleafでは、テンプレートのパスを解決する際、サフィックスを省略する設定ができるが、 本アダプタを使用する場合はサフィックスの省略は行わないこと。
- OK:
return new HttpResponse("index.html"); - NG:
return new HttpResponse("index");
サフィックスを省略した場合、セッションストアからリクエストスコープへの移送が行われず、 テンプレートからセッションストアの値を参照できなくなる。
テンプレートエンジンを使用する¶
テンプレートエンジンを使用するには、テンプレートファイルを作成、配置する必要がある。
テンプレートファイルを配置する場所は TemplateEngine の設定によって異なる。
前節で示した設定例の場合、テンプレートファイルはクラスパスからロードされる。
また、 ClassLoaderTemplateResolver のプロパティ prefix に template/ というようにプレフィックスが設定されているので、
クラスパス上の template ディレクトリ配下にテンプレートファイルを配置することになる。
配置したテンプレートを使ってレスポンスを出力するには、テンプレートファイルへのパスを指定した HttpResponse をアクションクラスの戻り値として返却する。
例えば、 src/main/resources/template 配下に、index.html というテンプレートファイルを配置したとする。
この場合、このテンプレートファイルはクラスパス上では template/index.html に位置するので、
アクションクラスで、このパスを指定した HttpResponse を返却する。
先の設定例のように、プレフィックスの指定をしている場合は、プレフィックスを省略したパスを指定する。
return new HttpResponse("index.html");
プレフィックスを指定しない場合は、パスを省略せずそのまま指定する。
return new HttpResponse("template/index.html");
これにより、配置したテンプレートファイルを用いてレスポンスが出力される。