脚本视图
Spring 框架内置了与任何可以在 JSR-223 Java 脚本引擎上运行的模板库集成的功能。我们在不同的脚本引擎上测试了以下模板库：
集成任何其他脚本引擎的基本规则是，它必须实现 ScriptEngine 和 Invocable 接口。
需求
您需要在类路径上拥有脚本引擎，具体细节因脚本引擎而异：
-
Nashorn JavaScript 引擎随 Java 8+ 提供。强烈建议使用最新的更新版本。
-
JRuby 应作为 Ruby 支持的依赖项添加。
-
Jython 应作为 Python 支持的依赖项添加。
-
应添加
org.jetbrains.kotlin:kotlin-script-util依赖项和一个包含org.jetbrains.kotlin.script.jsr223.KotlinJsr223JvmLocalScriptEngineFactory行的META-INF/services/javax.script.ScriptEngineFactory文件，以支持 Kotlin 脚本。有关更多详细信息，请参见 这个示例。
您需要拥有脚本模板库。对于 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
}
}
将 sharedEngine 属性设置为 false 是在使用非线程安全的脚本引擎与不为并发设计的模板库时所必需的，例如在 Nashorn 上运行的 Handlebars 或 React。在这种情况下，需要使用 Java SE 8 更新 60，因为 这个 bug，但通常建议在任何情况下使用最近的 Java SE 补丁版本。
polyfill.js 仅定义了 Handlebars 正常运行所需的 window 对象，如下所示：
var window = {};
这个基本的 render.js 实现会在使用模板之前进行编译。一个适合生产环境的实现还应该存储任何重复使用的缓存模板或预编译模板。你可以在脚本端进行此操作（并处理你需要的任何自定义 — 例如，管理模板引擎配置）。以下示例展示了如何做到这一点：
function render(template, model) {
var compiledTemplate = Handlebars.compile(template);
return compiledTemplate(model);
}