程序包 cn.taketoday.web.view.script

类 ScriptTemplateView

java.lang.Object

cn.taketoday.context.support.ApplicationObjectSupport

cn.taketoday.web.view.AbstractView

cn.taketoday.web.view.AbstractUrlBasedView

cn.taketoday.web.view.script.ScriptTemplateView

所有已实现的接口:

cn.taketoday.beans.factory.Aware, cn.taketoday.beans.factory.BeanNameAware, cn.taketoday.beans.factory.InitializingBean, cn.taketoday.context.ApplicationContextAware, View

public class ScriptTemplateView
extends AbstractUrlBasedView

An AbstractUrlBasedView subclass designed to run any template library based on a JSR-223 script engine.

If not set, each property is auto-detected by looking up a single ScriptTemplateConfig bean in the web application context and using it to obtain the configured properties.

The Nashorn JavaScript engine requires Java 8+ and may require setting the sharedEngine property to false in order to run properly. See ScriptTemplateConfigurer.setSharedEngine(Boolean) for more details.

从以下版本开始:

4.0

作者:

Sebastien Deleuze, Juergen Hoeller, Harry Yang

另请参阅:

• ScriptTemplateConfigurer
• ScriptTemplateViewResolver

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static final record	ScriptTemplateView.EngineKey	Key class for the enginesHolder ThreadLocal.

字段概要

字段

修饰符和类型	字段	说明
private Charset	charset
private static final Charset	DEFAULT_CHARSET
static final String	DEFAULT_CONTENT_TYPE	The default content type for the view.
private static final String	DEFAULT_RESOURCE_LOADER_PATH
private ScriptEngine	engine
private String	engineName
private static final cn.taketoday.core.NamedThreadLocal<Map<Object,ScriptEngine>>	enginesHolder
private Supplier<ScriptEngine>	engineSupplier
private String	renderFunction
private String	renderObject
private String[]	resourceLoaderPaths
private ScriptEngineManager	scriptEngineManager
private String[]	scripts
private Boolean	sharedEngine

从类继承的字段 cn.taketoday.context.support.ApplicationObjectSupport

applicationContext, log, messageSourceAccessor

从接口继承的字段 cn.taketoday.web.view.View

RESPONSE_STATUS_ATTRIBUTE, SELECTED_CONTENT_TYPE

构造器概要

构造器

构造器	说明
ScriptTemplateView()	Constructor for use as a bean.
ScriptTemplateView(String url)	Create a new ScriptTemplateView with the given URL.

方法概要

修饰符和类型	方法	说明
protected ScriptTemplateConfig	autodetectViewConfig()
boolean	checkResource(Locale locale)	Check whether the underlying resource that the configured URL points to actually exists.
protected ScriptEngine	createEngineFromName(String engineName)
private ScriptEngine	createEngineFromSupplier()
protected ScriptEngine	getEngine()
protected cn.taketoday.core.io.Resource	getResource(String location)
protected String	getTemplate(String path)
protected void	initApplicationContext(cn.taketoday.context.ApplicationContext context)
protected void	loadScripts(ScriptEngine engine)
protected void	prepareResponse(RequestContext context)	Prepare the given response for rendering.
protected void	renderMergedOutputModel(Map<String,Object> model, RequestContext request)	Subclasses must implement this method to actually render the view.
void	setCharset(Charset charset)	See ScriptTemplateConfigurer.setCharset(Charset) documentation.
void	setEngine(ScriptEngine engine)	See ScriptTemplateConfigurer.setEngine(ScriptEngine) documentation.
void	setEngineName(String engineName)	See ScriptTemplateConfigurer.setEngineName(String) documentation.
void	setEngineSupplier(Supplier<ScriptEngine> engineSupplier)	See ScriptTemplateConfigurer.setEngineSupplier(Supplier) documentation.
void	setRenderFunction(String functionName)	See ScriptTemplateConfigurer.setRenderFunction(String) documentation.
void	setRenderObject(String renderObject)	See ScriptTemplateConfigurer.setRenderObject(String) documentation.
void	setResourceLoaderPath(String resourceLoaderPath)	See ScriptTemplateConfigurer.setResourceLoaderPath(String) documentation.
void	setScripts(String... scripts)	See ScriptTemplateConfigurer.setScripts(String...) documentation.
void	setSharedEngine(Boolean sharedEngine)	See ScriptTemplateConfigurer.setSharedEngine(Boolean) documentation.

从类继承的方法 cn.taketoday.web.view.AbstractUrlBasedView

afterPropertiesSet, getUrl, isUrlRequired, setUrl, toString

从类继承的方法 cn.taketoday.web.view.AbstractView

addStaticAttribute, createMergedOutputModel, createTemporaryOutputStream, exposeModelAsRequestAttributes, formatViewName, generatesDownloadContent, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getRequestContextToExpose, getStaticAttributes, isExposePathVariables, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposeOutputRedirectModel, setExposePathVariables, setRequestContextAttribute, setResponseContentType, writeToResponse

从类继承的方法 cn.taketoday.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, obtainApplicationContext, requiredContextClass, setApplicationContext, unwrapContext, unwrapFactory

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

The default content type for the view.

另请参阅:

• 常量字段值

DEFAULT_CHARSET

private static final Charset DEFAULT_CHARSET

DEFAULT_RESOURCE_LOADER_PATH

private static final String DEFAULT_RESOURCE_LOADER_PATH

另请参阅:

• 常量字段值

enginesHolder

private static final cn.taketoday.core.NamedThreadLocal<Map<Object,ScriptEngine>> enginesHolder

engine

@Nullable
private ScriptEngine engine

engineSupplier

@Nullable
private Supplier<ScriptEngine> engineSupplier

engineName

@Nullable
private String engineName

sharedEngine

@Nullable
private Boolean sharedEngine

scripts

@Nullable
private String[] scripts

renderObject

@Nullable
private String renderObject

renderFunction

@Nullable
private String renderFunction

charset

@Nullable
private Charset charset

resourceLoaderPaths

@Nullable
private String[] resourceLoaderPaths

scriptEngineManager

@Nullable
private volatile ScriptEngineManager scriptEngineManager

构造器详细资料

ScriptTemplateView

public ScriptTemplateView()

Constructor for use as a bean.

另请参阅:

• AbstractUrlBasedView.setUrl(java.lang.String)

ScriptTemplateView

public ScriptTemplateView(String url)

Create a new ScriptTemplateView with the given URL.

方法详细资料

setEngine

public void setEngine(ScriptEngine engine)

See ScriptTemplateConfigurer.setEngine(ScriptEngine) documentation.

setEngineSupplier

public void setEngineSupplier(Supplier<ScriptEngine> engineSupplier)

See ScriptTemplateConfigurer.setEngineSupplier(Supplier) documentation.

setEngineName

public void setEngineName(String engineName)

See ScriptTemplateConfigurer.setEngineName(String) documentation.

setSharedEngine

public void setSharedEngine(Boolean sharedEngine)

See ScriptTemplateConfigurer.setSharedEngine(Boolean) documentation.

setScripts

public void setScripts(String... scripts)

See ScriptTemplateConfigurer.setScripts(String...) documentation.

setRenderObject

public void setRenderObject(String renderObject)

See ScriptTemplateConfigurer.setRenderObject(String) documentation.

setRenderFunction

public void setRenderFunction(String functionName)

See ScriptTemplateConfigurer.setRenderFunction(String) documentation.

setCharset

public void setCharset(Charset charset)

See ScriptTemplateConfigurer.setCharset(Charset) documentation.

setResourceLoaderPath

public void setResourceLoaderPath(String resourceLoaderPath)

See ScriptTemplateConfigurer.setResourceLoaderPath(String) documentation.

initApplicationContext

protected void initApplicationContext(cn.taketoday.context.ApplicationContext context)

覆盖:

initApplicationContext 在类中 cn.taketoday.context.support.ApplicationObjectSupport

getEngine

protected ScriptEngine getEngine()

createEngineFromName

protected ScriptEngine createEngineFromName(String engineName)

createEngineFromSupplier

private ScriptEngine createEngineFromSupplier()

loadScripts

protected void loadScripts(ScriptEngine engine)

getResource

@Nullable
protected cn.taketoday.core.io.Resource getResource(String location)

autodetectViewConfig

protected ScriptTemplateConfig autodetectViewConfig()
                                             throws cn.taketoday.beans.BeansException

抛出:

cn.taketoday.beans.BeansException

checkResource

public boolean checkResource(Locale locale)

从类复制的说明: AbstractUrlBasedView

Check whether the underlying resource that the configured URL points to actually exists.

覆盖:

checkResource 在类中 AbstractUrlBasedView

参数:

locale - the desired Locale that we're looking for

返回:

true if the resource exists (or is assumed to exist); false if we know that it does not exist

prepareResponse

protected void prepareResponse(RequestContext context)

从类复制的说明: AbstractView

Prepare the given response for rendering.

The default implementation applies a workaround for an IE bug when sending download content via HTTPS.

覆盖:

prepareResponse 在类中 AbstractView

参数:

context - current HTTP request context

renderMergedOutputModel

protected void renderMergedOutputModel(Map<String,Object> model,
 RequestContext request)
                                throws Exception

从类复制的说明: AbstractView

Subclasses must implement this method to actually render the view.

The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.

指定者:

renderMergedOutputModel 在类中 AbstractView

参数:

model - combined output Map (never null), with dynamic values taking precedence over static attributes

request - current HTTP request context

抛出:

Exception - if rendering failed

getTemplate

protected String getTemplate(String path)
                      throws IOException

抛出:

IOException