脚本视图

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

脚本库 脚本引擎

Handlebars

Nashorn

Mustache

Nashorn

React

Nashorn

EJS

Nashorn

ERB

JRuby

字符串模板

Jython

Kotlin 脚本模板

Kotlin

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

要求

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

  • 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 renderingContextRenderingContext,它提供对应用程序上下文、区域设置、模板加载器和 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。在这种情况下,由于此错误,需要 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 框架单元测试,Java资源,以获取更多配置示例。