脚本视图
要求
你的类路径中需要包含脚本引擎,具体取决于脚本引擎的不同
-
Java 8+ 提供了 Nashorn JavaScript 引擎。强烈建议使用最新的可用更新版本。
-
对于 Ruby 支持,应将 JRuby 添加为依赖。
-
对于 Python 支持,应将 Jython 添加为依赖。
-
对于 Kotlin 脚本支持,应添加
org.jetbrains.kotlin:kotlin-script-util
依赖以及包含org.jetbrains.kotlin.script.jsr223.KotlinJsr223JvmLocalScriptEngineFactory
行的META-INF/services/javax.script.ScriptEngineFactory
文件。有关更多详细信息,请参阅此示例。
你需要包含脚本模板库。对于 JavaScript,一种方法是通过 WebJars。
脚本模板
你可以声明一个 ScriptTemplateConfigurer
bean 来指定要使用的脚本引擎、要加载的脚本文件、用于渲染模板的函数等等。以下示例使用 Mustache 模板和 Nashorn JavaScript 引擎:
-
Java
-
Kotlin
@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
registry.scriptTemplate();
}
@Bean
public ScriptTemplateConfigurer configurer() {
ScriptTemplateConfigurer configurer = new ScriptTemplateConfigurer();
configurer.setEngineName("nashorn");
configurer.setScripts("mustache.js");
configurer.setRenderObject("Mustache");
configurer.setRenderFunction("render");
return configurer;
}
}
@Configuration
@EnableWebMvc
class WebConfig : WebMvcConfigurer {
override fun configureViewResolvers(registry: ViewResolverRegistry) {
registry.scriptTemplate()
}
@Bean
fun configurer() = ScriptTemplateConfigurer().apply {
engineName = "nashorn"
setScripts("mustache.js")
renderObject = "Mustache"
renderFunction = "render"
}
}
以下示例展示了 XML 中的相同配置:
<mvc:annotation-driven/>
<mvc:view-resolvers>
<mvc:script-template/>
</mvc:view-resolvers>
<mvc:script-template-configurer engine-name="nashorn" render-object="Mustache" render-function="render">
<mvc:script location="mustache.js"/>
</mvc:script-template-configurer>
控制器对于 Java 和 XML 配置看起来没有区别,如下例所示:
-
Java
-
Kotlin
@Controller
public class SampleController {
@GetMapping("/sample")
public String test(Model model) {
model.addAttribute("title", "Sample title");
model.addAttribute("body", "Sample body");
return "template";
}
}
@Controller
class SampleController {
@GetMapping("/sample")
fun test(model: Model): String {
model["title"] = "Sample title"
model["body"] = "Sample body"
return "template"
}
}
以下示例展示了 Mustache 模板:
<html>
<head>
<title>{{title}}</title>
</head>
<body>
<p>{{body}}</p>
</body>
</html>
调用渲染函数时使用以下参数:
-
String template
:模板内容 -
Map model
:视图模型 -
RenderingContext renderingContext
:RenderingContext
,用于访问应用程序上下文、区域设置、模板加载器和 URL(从 5.0 版本开始)
Mustache.render()
原生兼容此签名,因此你可以直接调用它。
如果你的模板技术需要一些定制,你可以提供一个实现自定义渲染函数的脚本。例如,Handlerbars 需要在使用前编译模板,并且需要一个 polyfill 来模拟服务器端脚本引擎中不可用的一些浏览器功能。
以下示例展示了如何做到这一点:
-
Java
-
Kotlin
@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
@Override
public void configureViewResolvers(ViewResolverRegistry registry) {
registry.scriptTemplate();
}
@Bean
public ScriptTemplateConfigurer configurer() {
ScriptTemplateConfigurer configurer = new ScriptTemplateConfigurer();
configurer.setEngineName("nashorn");
configurer.setScripts("polyfill.js", "handlebars.js", "render.js");
configurer.setRenderFunction("render");
configurer.setSharedEngine(false);
return configurer;
}
}
@Configuration
@EnableWebMvc
class WebConfig : WebMvcConfigurer {
override fun configureViewResolvers(registry: ViewResolverRegistry) {
registry.scriptTemplate()
}
@Bean
fun configurer() = ScriptTemplateConfigurer().apply {
engineName = "nashorn"
setScripts("polyfill.js", "handlebars.js", "render.js")
renderFunction = "render"
isSharedEngine = false
}
}
当使用非线程安全的脚本引擎(例如在 Nashorn 上运行的 Handlebars 或 React)以及未设计用于并发的模板库时,需要将 sharedEngine 属性设置为 false 。在这种情况下,由于这个 bug,需要 Java SE 8 update 60,但无论如何通常建议使用最新的 Java SE 修补版本。 |
polyfill.js
仅定义了 Handlebars 正常运行所需的 window
对象,如下所示:
var window = {};
这个基本的 render.js
实现在使用模板前对其进行编译。一个生产就绪的实现还应该存储任何重用的缓存模板或预编译模板。你可以在脚本端进行此操作(并处理所需的任何定制——例如,管理模板引擎配置)。以下示例展示了如何做到这一点:
function render(template, model) {
var compiledTemplate = Handlebars.compile(template);
return compiledTemplate(model);
}