脚本视图

Spring Framework内置了与任何可以在JSR-223 Java脚本引擎之上运行的模板库集成的功能。我们已经在不同的脚本引擎上测试了以下模板库:

脚本库 脚本引擎

Handlebars

Nashorn

Mustache

Nashorn

React

Nashorn

EJS

Nashorn

ERB

JRuby

字符串模板

Jython

Kotlin脚本模板

Kotlin

集成任何其他脚本引擎的基本规则是它必须实现ScriptEngineInvocable接口。

要求

您需要在类路径上拥有脚本引擎,具体细节因脚本引擎而异:

  • Java 8+提供了Nashorn JavaScript引擎。强烈建议使用最新的可用更新版本。

  • 应将JRuby添加为Ruby支持的依赖项。

  • 应将Jython添加为Python支持的依赖项。

  • 为了支持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: 提供对应用程序上下文、区域设置、模板加载器和URL(自5.0起)的访问权限的RenderingContext

Mustache.render()与此签名兼容,因此您可以直接调用它。

如果您的模板技术需要一些定制,您可以提供一个实现自定义渲染函数的脚本。例如,Handlebars在使用模板之前需要编译模板,并且需要一个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)时。在这种情况下,由于此bug,需要Java SE 8更新60,但通常建议在任何情况下使用最新的Java SE补丁版本。

polyfill.js仅定义了Handlebars正常运行所需的window对象,如下所示:

var window = {};

这个基本的render.js实现在使用模板之前编译模板。一个生产就绪的实现还应该存储任何重复使用的缓存模板或预编译模板。您可以在脚本端执行此操作(并处理您需要的任何定制 - 管理模板引擎配置,例如)。以下示例展示了如何实现:

function render(template, model) {
	var compiledTemplate = Handlebars.compile(template);
	return compiledTemplate(model);
}

查看Spring Framework单元测试,Java资源,获取更多配置示例。