java.lang.Object
- org.springframework.web.reactive.result.view.script.ScriptTemplateConfigurer

所有已实现的接口:: ScriptTemplateConfig

public class ScriptTemplateConfigurer
extends Object
implements ScriptTemplateConfig

An implementation of the Spring WebFlux ScriptTemplateConfig for creating a ScriptEngine for use in a web application.

 // Add the following to an @Configuration class
 @Bean
 public ScriptTemplateConfigurer mustacheConfigurer() {
    ScriptTemplateConfigurer configurer = new ScriptTemplateConfigurer();
    configurer.setEngineName("nashorn");
    configurer.setScripts("mustache.js");
    configurer.setRenderObject("Mustache");
    configurer.setRenderFunction("render");
    return configurer;
 }

NOTE: It is possible to use non thread-safe script engines with templating libraries not designed for concurrency, like Handlebars or React running on Nashorn, by setting the sharedEngine property to false.

从以下版本开始:: 5.0
作者:: Sebastien Deleuze
另请参阅:: ScriptTemplateView

构造器概要
构造器
构造器说明
ScriptTemplateConfigurer()
Default constructor.
ScriptTemplateConfigurer(String engineName)
Create a new ScriptTemplateConfigurer using the given engine name.

方法概要

所有方法实例方法具体方法
修饰符和类型	方法	说明
`Charset`	`getCharset()`	Return the charset used to read script and template files.
`ScriptEngine`	`getEngine()`	Return the `ScriptEngine` to use by the views.
`String`	`getEngineName()`	Return the engine name that will be used to instantiate the `ScriptEngine`.
`Supplier<ScriptEngine>`	`getEngineSupplier()`	Return the engine supplier that will be used to instantiate the `ScriptEngine`.
`String`	`getRenderFunction()`	Return the render function name (optional).
`String`	`getRenderObject()`	Return the object where the render function belongs (optional).
`String`	`getResourceLoaderPath()`	Return the resource loader path(s) via a Spring resource location.
`String[]`	`getScripts()`	Return the scripts to be loaded by the script engine (library or user provided).
`Boolean`	`isSharedEngine()`	Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.
`void`	`setCharset(Charset charset)`	Set the charset used to read script and template files
`void`	`setEngine(ScriptEngine engine)`	Set the `ScriptEngine` to use by the view.
`void`	`setEngineName(String engineName)`	Set the engine name that will be used to instantiate the `ScriptEngine`.
`void`	`setEngineSupplier(Supplier<ScriptEngine> engineSupplier)`	Set the `ScriptEngine` supplier to use by the view, usually used with `setSharedEngine(Boolean)` set to `false`.
`void`	`setRenderFunction(String renderFunction)`	Set the render function name (optional).
`void`	`setRenderObject(String renderObject)`	Set the object where the render function belongs (optional).
`void`	`setResourceLoaderPath(String resourceLoaderPath)`	Set the resource loader path(s) via a Spring resource location.
`void`	`setScripts(String... scriptNames)`	Set the scripts to be loaded by the script engine (library or user provided).
`void`	`setSharedEngine(Boolean sharedEngine)`	When set to `false`, a new `ScriptEngine` instance will be created for each request, else the same instance will be reused.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ScriptTemplateConfigurer
```
public ScriptTemplateConfigurer()
```
    Default constructor.
  - ScriptTemplateConfigurer
```
public ScriptTemplateConfigurer(String engineName)
```
    Create a new ScriptTemplateConfigurer using the given engine name.
- 方法详细资料
  - setEngine
```
public void setEngine(@Nullable
                      ScriptEngine engine)
```
    Set the ScriptEngine to use by the view. If renderFunction is specified, the script engine must implement Invocable. You must define engine or engineName, not both.
    When the sharedEngine flag is set to false, you should not specify the script engine with this setter, but with the setEngineName(String) or setEngineSupplier(Supplier) (since it implies multiple lazy instantiations of the script engine).
    另请参阅:
    setEngineName(String), setEngineSupplier(Supplier)
  - getEngine
```
@Nullable
public ScriptEngine getEngine()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the ScriptEngine to use by the views.
    指定者:
    getEngine 在接口中 ScriptTemplateConfig
  - setEngineSupplier
```
public void setEngineSupplier(@Nullable
                              Supplier<ScriptEngine> engineSupplier)
```
    Set the ScriptEngine supplier to use by the view, usually used with setSharedEngine(Boolean) set to false. If renderFunction is specified, the script engine must implement Invocable. You must either define engineSupplier, engine or engineName.
    从以下版本开始:
    5.2
    另请参阅:
    setEngine(ScriptEngine), setEngineName(String)
  - getEngineSupplier
```
@Nullable
public Supplier<ScriptEngine> getEngineSupplier()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the engine supplier that will be used to instantiate the ScriptEngine.
    指定者:
    getEngineSupplier 在接口中 ScriptTemplateConfig
  - setEngineName
```
public void setEngineName(@Nullable
                          String engineName)
```
    Set the engine name that will be used to instantiate the ScriptEngine. If renderFunction is specified, the script engine must implement Invocable. You must define engine or engineName, not both.
    另请参阅:
    setEngine(ScriptEngine), setEngineSupplier(Supplier)
  - getEngineName
```
@Nullable
public String getEngineName()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the engine name that will be used to instantiate the ScriptEngine.
    指定者:
    getEngineName 在接口中 ScriptTemplateConfig
  - setSharedEngine
```
public void setSharedEngine(@Nullable
                            Boolean sharedEngine)
```
    When set to false, a new ScriptEngine instance will be created for each request, else the same instance will be reused. This flag should be set to false for those using non thread-safe script engines with templating libraries not designed for concurrency, like Handlebars or React running on Nashorn for example.
    When this flag is set to false, the script engine must be specified using setEngineName(String). Using setEngine(ScriptEngine) is not possible because multiple instances of the script engine need to be created for each request.
    另请参阅:
    THREADING ScriptEngine parameter
  - isSharedEngine
```
@Nullable
public Boolean isSharedEngine()
```
    从接口复制的说明: ScriptTemplateConfig
    Return whether to use a shared engine for all threads or whether to create thread-local engine instances for each thread.
    指定者:
    isSharedEngine 在接口中 ScriptTemplateConfig
  - setScripts
```
public void setScripts(@Nullable
                       String... scriptNames)
```
    Set the scripts to be loaded by the script engine (library or user provided). Since resourceLoaderPath default value is "classpath:", you can load easily any script available on the classpath.
    For example, in order to use a JavaScript library available as a WebJars dependency and a custom "render.js" file, you should call configurer.setScripts("/META-INF/resources/webjars/library/version/library.js", "com/myproject/script/render.js");.
    另请参阅:
    setResourceLoaderPath(java.lang.String), WebJars
  - getScripts
```
@Nullable
public String[] getScripts()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the scripts to be loaded by the script engine (library or user provided).
    指定者:
    getScripts 在接口中 ScriptTemplateConfig
  - setRenderObject
```
public void setRenderObject(@Nullable
                            String renderObject)
```
    Set the object where the render function belongs (optional). For example, in order to call Mustache.render(), renderObject should be set to "Mustache" and renderFunction to "render".
  - getRenderObject
```
@Nullable
public String getRenderObject()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the object where the render function belongs (optional).
    指定者:
    getRenderObject 在接口中 ScriptTemplateConfig
  - setRenderFunction
```
public void setRenderFunction(@Nullable
                              String renderFunction)
```
    Set the render function name (optional). If not specified, the script templates will be evaluated with ScriptEngine.eval(String, Bindings).
    This function will be called with the following parameters:
    String template: the template content
    Map model: the view model
    RenderingContext context: the rendering context
    另请参阅:
    RenderingContext
  - getRenderFunction
```
@Nullable
public String getRenderFunction()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the render function name (optional). If not specified, the script templates will be evaluated with ScriptEngine.eval(String, Bindings).
    指定者:
    getRenderFunction 在接口中 ScriptTemplateConfig
  - setCharset
```
public void setCharset(@Nullable
                       Charset charset)
```
    Set the charset used to read script and template files. (UTF-8 by default).
  - getCharset
```
@Nullable
public Charset getCharset()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the charset used to read script and template files.
    指定者:
    getCharset 在接口中 ScriptTemplateConfig
  - setResourceLoaderPath
```
public void setResourceLoaderPath(@Nullable
                                  String resourceLoaderPath)
```
    Set the resource loader path(s) via a Spring resource location. Accepts multiple locations as a comma-separated list of paths. Standard URLs like "file:" and "classpath:" and pseudo URLs are supported as understood by Spring's ResourceLoader. Relative paths are allowed when running in an ApplicationContext.
    Default is "classpath:".
  - getResourceLoaderPath
```
@Nullable
public String getResourceLoaderPath()
```
    从接口复制的说明: ScriptTemplateConfig
    Return the resource loader path(s) via a Spring resource location.
    指定者:
    getResourceLoaderPath 在接口中 ScriptTemplateConfig

构造器	说明
`ScriptTemplateConfigurer()`	Default constructor.
`ScriptTemplateConfigurer(String engineName)`	Create a new ScriptTemplateConfigurer using the given engine name.

类 ScriptTemplateConfigurer

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ScriptTemplateConfigurer

ScriptTemplateConfigurer

方法详细资料

setEngine

getEngine

setEngineSupplier

getEngineSupplier

setEngineName

getEngineName

setSharedEngine

isSharedEngine

setScripts

getScripts

setRenderObject

getRenderObject

setRenderFunction

getRenderFunction

setCharset

getCharset

setResourceLoaderPath

getResourceLoaderPath