パッケージ org.springframework.web.reactive.result.view.freemarker

クラス FreeMarkerView

java.lang.ObjectSE
org.springframework.web.reactive.result.view.AbstractView
org.springframework.web.reactive.result.view.AbstractUrlBasedView
org.springframework.web.reactive.result.view.freemarker.FreeMarkerView
実装されたすべてのインターフェース:
Aware、BeanNameAware、InitializingBean、ApplicationContextAware、View
public class FreeMarkerView extends AbstractUrlBasedView
FreeMarker テンプレートエンジンを使用する View 実装。

次の構成プロパティを公開します。

  • url : FreeMarkerConfigurer の templateLoaderPath に対する FreeMarker テンプレートの位置。
  • encoding : FreeMarker テンプレートファイルを読み取るときにバイトシーケンスを文字シーケンスにデコードするために使用されるエンコーディング。デフォルトは FreeMarker Configuration によって決定されます。

アプリケーションコンテキストでアクセス可能な FreeMarkerConfigurer などの単一の FreeMarkerConfig オブジェクトに依存します。あるいは、FreeMarker Configuration を setConfiguration(freemarker.template.Configuration) 経由で直接設定することもできます。

注意 : レスポンスをレンダリングするときとクライアントがレスポンスを読み取るときに正しいエンコーディングが使用されるようにするには、次の手順を実行する必要があります。

ただし、FreeMarkerConfigurer は FreeMarker Configuration のデフォルトのエンコーディングを "UTF-8" に設定し、AbstractView はサポートされるメディア型をデフォルトで "text/html;charset=UTF-8" に設定することに注意してください。これらのデフォルト値はほとんどのアプリケーションに適していると考えられます。

メモ: Spring の FreeMarker サポートには FreeMarker 2.3.33 以上が必要です。

導入:
5.0
作成者:
Rossen Stoyanchev, Sam Brannen

  • フィールドの詳細

  • コンストラクターの詳細

    • FreeMarkerView

      public FreeMarkerView()

  • メソッドの詳細

    • setConfiguration

      public void setConfiguration(@Nullable freemarker.template.Configuration configuration)
      このビューで使用される FreeMarker Configuration を設定します。

      通常、このプロパティは直接設定されません。代わりに、FreeMarker 構成を取得するために使用される Spring アプリケーションコンテキストで単一の FreeMarkerConfig が期待されます。

    • getConfiguration

      @Nullable protected freemarker.template.Configuration getConfiguration()
      このビューで使用される FreeMarker Configuration を取得します。

    • obtainConfiguration

      protected freemarker.template.Configuration obtainConfiguration()
      実際の使用のために FreeMarker Configuration を取得します。
      戻り値:
      FreeMarker 構成 (非 null)
      例外:
      IllegalStateExceptionSE - Configuration オブジェクトセットがない場合
      関連事項:

    • setEncoding

      public void setEncoding(@Nullable StringSE encoding)
      このビューの FreeMarker テンプレートファイルを読み取るときに、バイトシーケンスを文字シーケンスにデコードするために使用するエンコーディングを設定します。

      デフォルトでは null に設定され、エンコードを決定するために FreeMarker Configuration を使用する必要があることを示します。

      非 null エンコーディングは、FreeMarker Configuration によって決定されたデフォルトのエンコーディングをオーバーライドします。

      ここでまたは FreeMarker Configuration でエンコーディングが明示的に設定されていない場合、FreeMarker はプラットフォームファイルエンコーディング (JVM システムプロパティ file.encoding で定義) を使用してテンプレートファイルを読み取ります。プラットフォームファイルエンコーディングが定義されていない場合は UTF-8 を使用します。ただし、FreeMarkerConfigurer は FreeMarker Configuration のデフォルトエンコーディングを "UTF-8" に設定することに注意してください。

      すべてのテンプレートが共通のエンコーディングを共有する場合は、テンプレートごとにではなく、FreeMarker Configuration でエンコーディングを指定することをお勧めします。

      指定されたエンコーディングまたはデフォルトのエンコーディングはテンプレートのレンダリングには使用されないことに注意してください。代わりに、レンダリングプロセスに明示的なエンコーディングを指定する必要があります。詳細については、クラスレベルのドキュメントの注記を参照してください。

      関連事項:

    • setCharset

      public void setCharset(@Nullable CharsetSE charset)
      このビューの FreeMarker テンプレートファイルを読み取るときに、バイトシーケンスを文字シーケンスにデコードするために使用される CharsetSE を設定します。

      詳細は setEncoding(String) を参照してください。

      導入:
      6.2
      関連事項:

    • getEncoding

      @Nullable protected StringSE getEncoding()
      このビューの FreeMarker テンプレートファイルを読み取るときにバイトシーケンスを文字シーケンスにデコードするために使用されるエンコーディングを取得するか、エンコーディングを決定するために FreeMarker Configuration を使用する必要があることを示す null を取得します。
      関連事項:

    • setExposeSpringMacroHelpers

      public void setExposeSpringMacroHelpers(boolean exposeSpringMacroHelpers)
      "springMacroRequestContext" という名前で、Spring のマクロライブラリが使用する RequestContext を公開するかどうかを設定します。

      デフォルトは true です。

      Spring の FreeMarker のデフォルトマクロに必要です。Spring ヘルパーマクロを利用する場合を除き、これは HTML フォームを使用するテンプレートには必要ないことに注意してください。

      導入:
      5.2
      関連事項:

    • afterPropertiesSet

      public void afterPropertiesSet() throws ExceptionSE
      インターフェースからコピーされた説明: InitializingBean
      すべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。

      このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。

      次で指定:
      インターフェース InitializingBean の afterPropertiesSet 
      オーバーライド:
      クラス AbstractUrlBasedView の afterPropertiesSet 
      例外:
      ExceptionSE - 構成の誤り（必須プロパティの設定の失敗など）の場合、またはその他の理由で初期化が失敗した場合

    • autodetectConfiguration

      protected FreeMarkerConfig autodetectConfiguration() throws BeansException
      ApplicationContext で FreeMarkerConfig オブジェクトを自動検出します。
      戻り値:
      このビューに使用する FreeMarkerConfig インスタンス
      例外:
      BeansException - FreeMarkerConfig インスタンスが見つからなかった場合
      関連事項:

    • checkResourceExists

      public boolean checkResourceExists(LocaleSE locale)
      このビューに使用される FreeMarker テンプレートが存在し、有効であることを確認してください。

      オーバーライドして動作をカスタマイズできます。たとえば、複数のテンプレートを単一のビューにレンダリングする場合などです。

      次で指定:
      クラス AbstractUrlBasedView の checkResourceExists 
      パラメーター:
      locale - 探している希望のロケール
      戻り値:
      リソースが存在する場合は false、存在しないことがわかっている場合は false 

    • resourceExists

      public reactor.core.publisher.Mono<BooleanSE> resourceExists(LocaleSE locale)
      このビューに使用される FreeMarker テンプレートが存在し、有効であることを確認してください。

      オーバーライドして動作をカスタマイズできます。たとえば、複数のテンプレートを単一のビューにレンダリングする場合などです。

      オーバーライド:
      クラス AbstractUrlBasedView の resourceExists 
      パラメーター:
      locale - 探している希望のロケール
      戻り値:
      リソースが存在する場合は false、存在しないことがわかっている場合は false 
      導入:
      6.1

    • getModelAttributes

      protected reactor.core.publisher.Mono<MapSE<StringSE,ObjectSE>> getModelAttributes(@Nullable MapSE<StringSE,?> model, ServerWebExchange exchange)
      Spring FreeMarker マクロで使用する RequestContext を潜在的に公開し、このメソッドの継承された実装に委譲することにより、レンダリングに使用するモデルを準備します。
      オーバーライド:
      クラス AbstractView の getModelAttributes 
      導入:
      5.2
      関連事項:

    • renderInternal

      protected reactor.core.publisher.Mono<VoidSE> renderInternal(MapSE<StringSE,ObjectSE> renderAttributes, @Nullable MediaType contentType, ServerWebExchange exchange)
      クラスからコピーされた説明: AbstractView
      ビューを実際にレンダリングするには、サブクラスでこのメソッドを実装する必要があります。
      次で指定:
      クラス AbstractView の renderInternal 
      パラメーター:
      renderAttributes - 静的な属性よりも動的な値が優先される、結合された出力マップ（非 null）
      contentType - レンダリングするために選択されたコンテンツ型。サポートされているメディア型のいずれかと一致する必要があります
      exchange - 現在の交換
      戻り値:
      レンダリングが成功したときと成功したかどうかを表す Mono 

    • getTemplateModel

      protected freemarker.template.SimpleHash getTemplateModel(MapSE<StringSE,ObjectSE> model, ServerWebExchange exchange)
      指定されたモデルマップの FreeMarker テンプレートモデルを作成します。

      デフォルトの実装は SimpleHash を構築します。

      パラメーター:
      model - レンダリングに使用するモデル
      exchange - 現在の交換
      戻り値:
      SimpleHash またはそのサブクラスとしての FreeMarker テンプレートモデル

    • getObjectWrapper

      protected freemarker.template.ObjectWrapper getObjectWrapper()
      設定された FreeMarker ObjectWrapper を取得します。指定されていない場合はデフォルトのラッパーを取得します。
      関連事項:
      • Configurable.getObjectWrapper()

    • lookupTemplate

      protected reactor.core.publisher.Mono<freemarker.template.Template> lookupTemplate(LocaleSE locale)
      指定されたロケールで、設定されている場合は設定されたエンコーディングを使用して、このビューによってレンダリングされる FreeMarker Template を取得します。

      デフォルトでは、"url" Bean プロパティで指定されたテンプレートが取得され、テンプレートの検索が操作をブロックする可能性があるため、返された mono は制限されたエラスティックスケジューラにサブスクライブされます。

      パラメーター:
      locale - 現在のロケール
      戻り値:
      レンダリングする FreeMarker テンプレート
      導入:
      6.1