パッケージ org.springframework.web.servlet.view.groovy

クラス GroovyMarkupConfigurer

java.lang.ObjectSE
groovy.text.markup.TemplateConfiguration
org.springframework.web.servlet.view.groovy.GroovyMarkupConfigurer
実装されたすべてのインターフェース:
Aware、InitializingBean、ApplicationContextAware、GroovyMarkupConfig
public class GroovyMarkupConfigurer extends groovy.text.markup.TemplateConfiguration implements GroovyMarkupConfig, ApplicationContextAware, InitializingBean
Groovy の TemplateConfiguration の拡張と、Web アプリケーションで使用するための MarkupTemplateEngine を作成するための Spring MVC の GroovyMarkupConfig の実装。このクラスを構成する最も基本的な方法は、"resourceLoaderPath" を設定することです。例:

 // Add the following to an @Configuration class

 @Bean
 public GroovyMarkupConfig groovyMarkupConfigurer() {
     GroovyMarkupConfigurer configurer = new GroovyMarkupConfigurer();
     configurer.setResourceLoaderPath("classpath:/WEB-INF/groovymarkup/");
     return configurer;
 }
デフォルトでは、この Bean は以下を使用して MarkupTemplateEngine を作成します。
  • 参照付きの Groovy テンプレートをロードするための親 ClassLoader
  • 基本クラス TemplateConfiguration のデフォルト構成
  • テンプレートファイルを解決するための TemplateResolver 
MarkupTemplateEngine インスタンスをこの Bean に直接提供できます。その場合、他のすべてのプロパティは効果的に無視されません。

この Bean は、レンダリングに Spring MVC GroovyMarkupView を使用するすべてのアプリケーションのアプリケーションコンテキストに含める必要があります。これは、Groovy のマークアップテンプレートを構成するためだけに存在します。アプリケーションコンポーネントから直接参照されることを意図したものではありません。Bean の名前に依存せずに GroovyMarkupView が見つけられる GroovyMarkupConfig を実装します。各 DispatcherServlet は、必要に応じて独自の GroovyMarkupConfigurer を定義できます。

MarkupTemplateEngine では、リソースキャッシュがデフォルトで有効になっていることに注意してください。必要に応じて、TemplateConfiguration.setCacheTemplates(boolean) を使用して構成します。

Spring の Groovy マークアップテンプレートのサポートには、Groovy 2.3.1 以上が必要です。

導入:
4.1
作成者:
Brian Clozel, Rossen Stoyanchev
関連事項:

  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    GroovyMarkupConfigurer()

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    afterPropertiesSet()
    すべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。
    protected ClassLoaderSE
    createTemplateClassLoader()
    テンプレートをロードおよびコンパイルするときに親 ClassLoader として使用する Groovy の親 ClassLoader を作成します。
    protected groovy.text.markup.MarkupTemplateEngine
    createTemplateEngine()
    protected ApplicationContext
    getApplicationContext()
    StringSE
    getResourceLoaderPath()
    groovy.text.markup.MarkupTemplateEngine
    getTemplateEngine()
    現在の Web アプリケーションコンテキストの Groovy MarkupTemplateEngine を返します。
    protected URLSE
    resolveTemplate(ClassLoaderSE classLoader, StringSE templatePath)
    指定されたテンプレートパスからテンプレートを解決します。
    void
    setApplicationContext(ApplicationContext applicationContext)
    このオブジェクトが実行される ApplicationContext を設定します。
    void
    setLocale(LocaleSE locale)
    テンプレートを解決するために考慮されるロケールは現在の HTTP リクエストのロケールであるため、このメソッドは使用しないでください。
    void
    setResourceLoaderPath(StringSE resourceLoaderPath)
    Spring リソースの場所を介して Groovy マークアップテンプレートのリソースローダーパスを設定します。
    void
    setTemplateEngine(groovy.text.markup.MarkupTemplateEngine templateEngine)
    Groovy マークアップテンプレート Web 構成に使用するように事前構成済みの MarkupTemplateEngine を設定します。

    クラス groovy.text.markup.TemplateConfiguration から継承されたメソッド

    getAutoIndentString, getBaseTemplateClass, getDeclarationEncoding, getLocale, getNewLineString, isAutoEscape, isAutoIndent, isAutoNewLine, isCacheTemplates, isExpandEmptyElements, isUseDoubleQuotes, setAutoEscape, setAutoIndent, setAutoIndentString, setAutoNewLine, setBaseTemplateClass, setCacheTemplates, setDeclarationEncoding, setExpandEmptyElements, setNewLineString, setUseDoubleQuotes

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

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

    • GroovyMarkupConfigurer

      public GroovyMarkupConfigurer()

  • メソッドの詳細

    • setResourceLoaderPath

      public void setResourceLoaderPath(StringSE resourceLoaderPath)
      Spring リソースの場所を介して Groovy マークアップテンプレートのリソースローダーパスを設定します。パスのコンマ区切りリストとして複数の場所を受け入れます。Spring の ResourceLoader で理解されているように、"file:" や "classpath:" などの標準 URL と疑似 URL がサポートされています。ApplicationContext で実行する場合、相対パスを使用できます。

    • getResourceLoaderPath

      public StringSE getResourceLoaderPath()

    • setTemplateEngine

      public void setTemplateEngine(groovy.text.markup.MarkupTemplateEngine templateEngine)
      Groovy マークアップテンプレート Web 構成に使用するように事前構成済みの MarkupTemplateEngine を設定します。

      この設定の他のすべての Bean プロパティは無視されるため、このエンジンインスタンスは手動で設定する必要があることに注意してください。

    • getTemplateEngine

      public groovy.text.markup.MarkupTemplateEngine getTemplateEngine()
      インターフェースからコピーされた説明: GroovyMarkupConfig
      現在の Web アプリケーションコンテキストの Groovy MarkupTemplateEngine を返します。1 つのサーブレットに固有の場合もあれば、ルートコンテキストで共有される場合もあります。
      次で指定:
      インターフェース GroovyMarkupConfig の getTemplateEngine 
      戻り値:
      Groovy MarkupTemplateEngine エンジン

    • setApplicationContext

      public void setApplicationContext(ApplicationContext applicationContext)
      インターフェースからコピーされた説明: ApplicationContextAware
      このオブジェクトが実行される ApplicationContext を設定します。通常、この呼び出しはオブジェクトの初期化に使用されます。

      通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet() またはカスタム init メソッドなどの init コールバックの前に呼び出されます。ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)、ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher) および MessageSourceAware の後に呼び出されます（該当する場合）。

      次で指定:
      インターフェース ApplicationContextAware の setApplicationContext 
      パラメーター:
      applicationContext - このオブジェクトによって使用される ApplicationContext オブジェクト
      関連事項:

    • getApplicationContext

      protected ApplicationContext getApplicationContext()

    • setLocale

      public void setLocale(LocaleSE locale)
      テンプレートを解決するために考慮されるロケールは現在の HTTP リクエストのロケールであるため、このメソッドは使用しないでください。
      オーバーライド:
      クラス groovy.text.markup.TemplateConfiguration の setLocale 

    • afterPropertiesSet

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

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

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

    • createTemplateEngine

      protected groovy.text.markup.MarkupTemplateEngine createTemplateEngine() throws IOExceptionSE
      例外:
      IOExceptionSE

    • createTemplateClassLoader

      protected ClassLoaderSE createTemplateClassLoader() throws IOExceptionSE
      テンプレートをロードおよびコンパイルするときに親 ClassLoader として使用する Groovy の親 ClassLoader を作成します。
      例外:
      IOExceptionSE

    • resolveTemplate

      protected URLSE resolveTemplate(ClassLoaderSE classLoader, StringSE templatePath) throws IOExceptionSE
      指定されたテンプレートパスからテンプレートを解決します。

      デフォルトの実装では、LocaleContextHolder で取得した現在のリクエストに関連付けられているロケールを使用して、テンプレートファイルを検索します。実際には、エンジンレベルで設定されたロケールは無視されます。

      例外:
      IOExceptionSE
      関連事項: