FreeMarker

Apache FreeMarker 是一个用于从 HTML 到电子邮件和其他任何类型的文本输出生成模板的引擎。Spring 框架内置了将 Spring MVC 与 FreeMarker 模板一起使用的集成。

视图配置

以下示例演示如何将 FreeMarker 配置为视图技术

Java
Kotlin

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		registry.freeMarker();
	}

	// Configure FreeMarker...

	@Bean
	public FreeMarkerConfigurer freeMarkerConfigurer() {
		FreeMarkerConfigurer configurer = new FreeMarkerConfigurer();
		configurer.setTemplateLoaderPath("/WEB-INF/freemarker");
		configurer.setDefaultCharset(StandardCharsets.UTF_8);
		return configurer;
	}
}

@Configuration
@EnableWebMvc
class WebConfig : WebMvcConfigurer {

	override fun configureViewResolvers(registry: ViewResolverRegistry) {
		registry.freeMarker()
	}

	// Configure FreeMarker...

	@Bean
	fun freeMarkerConfigurer() = FreeMarkerConfigurer().apply {
		setTemplateLoaderPath("/WEB-INF/freemarker")
		setDefaultCharset(StandardCharsets.UTF_8)
	}
}

以下示例演示如何在 XML 中配置相同的内容

<mvc:annotation-driven/>

<mvc:view-resolvers>
	<mvc:freemarker/>
</mvc:view-resolvers>

<!-- Configure FreeMarker... -->
<mvc:freemarker-configurer>
	<mvc:template-loader-path location="/WEB-INF/freemarker"/>
</mvc:freemarker-configurer>

或者，您还可以声明 FreeMarkerConfigurer bean 以完全控制所有属性，如下例所示

<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
	<property name="templateLoaderPath" value="/WEB-INF/freemarker/"/>
	<property name="defaultEncoding" value="UTF-8"/>
</bean>

您的模板需要存储在前面示例中显示的 FreeMarkerConfigurer 指定的目录中。根据前面的配置，如果您的控制器返回名为 welcome 的视图名称，则解析器将查找 /WEB-INF/freemarker/welcome.ftl 模板。

FreeMarker 配置

参见 Reactive Stack 中的等效项

您可以通过在 FreeMarkerConfigurer bean 上设置相应的 bean 属性，将 FreeMarker 的“设置”和“共享变量”直接传递到 FreeMarker Configuration 对象（由 Spring 管理）。freemarkerSettings 属性需要一个 java.util.Properties 对象，而 freemarkerVariables 属性需要一个 java.util.Map。以下示例演示如何使用 FreeMarkerConfigurer

<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
	<property name="templateLoaderPath" value="/WEB-INF/freemarker/"/>
	<property name="freemarkerVariables">
		<map>
			<entry key="xml_escape" value-ref="fmXmlEscape"/>
		</map>
	</property>
</bean>

<bean id="fmXmlEscape" class="freemarker.template.utility.XmlEscape"/>

有关设置和变量的详细信息，请参阅 FreeMarker 文档，因为它们适用于 Configuration 对象。

表单处理

Spring 提供了一个用于在 JSP 中使用的标签库，其中包含（除其他外）一个 <spring:bind/> 元素。此元素主要允许表单显示来自表单支持对象的 value，并在 web 或业务层显示来自 Validator 的验证失败结果。Spring 还支持 FreeMarker 中的相同功能，并提供其他便捷宏来生成表单输入元素本身。

绑定宏

参见 Reactive Stack 中的等效项

在 spring-webmvc.jar 文件中维护一组标准宏，以便它们始终可用于配置正确的应用程序。

Spring 模板库中定义的一些宏被认为是内部（私有）的，但宏定义中不存在此类范围，这使得所有宏都对调用代码和用户模板可见。以下部分仅关注您需要从模板中直接调用的宏。如果您希望直接查看宏代码，则该文件名为 spring.ftl，位于 org.springframework.web.servlet.view.freemarker 包中。

简单绑定

在基于 FreeMarker 模板的 HTML 表单中，这些表单充当 Spring MVC 控制器的表单视图，您可以使用类似于下一示例的代码绑定到字段值并以类似于 JSP 等效项的方式显示每个输入字段的错误消息。以下示例显示了一个 personForm 视图

<!-- FreeMarker macros have to be imported into a namespace.
	We strongly recommend sticking to 'spring'. -->
<#import "/spring.ftl" as spring/>
<html>
	...
	<form action="" method="POST">
		Name:
		<@spring.bind "personForm.name"/>
		<input type="text"
			name="${spring.status.expression}"
			value="${spring.status.value?html}"/><br />
		<#list spring.status.errorMessages as error> <b>${error}</b> <br /> </#list>
		<br />
		...
		<input type="submit" value="submit"/>
	</form>
	...
</html>

<@spring.bind> 需要一个“path”参数，该参数由命令对象的名称（除非您在控制器配置中更改了它，否则为“command”）后跟一个点和要绑定到的命令对象上的字段的名称组成。您还可以使用嵌套字段，例如 command.address.street。bind 宏假定由 web.xml 中的 ServletContext 参数 defaultHtmlEscape 指定的默认 HTML 转义行为。

名为 <@spring.bindEscaped> 的宏的另一种形式接受第二个参数，该参数明确指定是否应在状态错误消息或值中使用 HTML 转义。您可以根据需要将其设置为 true 或 false。其他表单处理宏简化了 HTML 转义的使用，您应该尽可能使用这些宏。它们将在下一节中说明。

输入宏

FreeMarker 的其他便捷宏简化了绑定和表单生成（包括验证错误显示）。永远不需要使用这些宏来生成表单输入字段，并且您可以将它们与简单的 HTML 或我们之前突出显示的 Spring 绑定宏的直接调用混合使用。

下表显示了可用宏的 FreeMarker 模板 (FTL) 定义以及每个宏接受的参数列表

表 1. 宏定义表
宏	FTL 定义
`message`（根据 code 参数从资源包输出字符串）	<@spring.message code/>
`messageText`（根据 code 参数从资源包输出字符串，回退到 default 参数的值）	<@spring.messageText code, text/>
`url`（使用应用程序的上下文根前缀相对 URL）	<@spring.url relativeUrl/>
`formInput`（用于收集用户输入的标准输入字段）	<@spring.formInput path, attributes, fieldType/>
`formHiddenInput`（用于提交非用户输入的隐藏输入字段）	<@spring.formHiddenInput path, attributes/>
`formPasswordInput`（用于收集密码的标准输入字段。请注意，此类型的字段永远不会填充任何值。）	<@spring.formPasswordInput path, attributes/>
`formTextarea`（用于收集较长、自由格式文本输入的大文本字段）	<@spring.formTextarea path, attributes/>
`formSingleSelect`（选项的下拉框，允许选择单个必需值）	<@spring.formSingleSelect path, options, attributes/>
`formMultiSelect`（选项的列表框，允许用户选择 0 个或多个值）	<@spring.formMultiSelect path, options, attributes/>
`formRadioButtons`（一组单选按钮，允许从可用选项中进行单选）	<@spring.formRadioButtons path, options separator, attributes/>
`formCheckboxes`（一组复选框，允许选择0个或多个值）	<@spring.formCheckboxes path, options, separator, attributes/>
`formCheckbox`（单个复选框）	<@spring.formCheckbox path, attributes/>
`showErrors`（简化绑定字段的验证错误显示）	<@spring.showErrors separator, classOrStyle/>

在 FreeMarker 模板中，formHiddenInput 和 formPasswordInput 实际上并不是必需的，因为您可以使用普通的 formInput 宏，并指定 hidden 或 password 作为 fieldType 参数的值。

上述任何宏的参数都具有相同的含义

path：要绑定的字段的名称（例如，“command.name”）
options：一个包含所有可用值的 Map，可以在输入字段中进行选择。映射的键表示从表单回传并绑定到命令对象的的值。存储在键后面的映射对象是表单上显示给用户的标签，可能与表单回传的对应值不同。通常，这样的映射由控制器作为参考数据提供。您可以根据所需的行为使用任何 Map 实现。对于严格排序的映射，您可以使用带有适当 Comparator 的 SortedMap（例如 TreeMap），对于应按插入顺序返回值的任意映射，可以使用 LinkedHashMap 或来自 commons-collections 的 LinkedMap。
separator：当多个选项作为离散元素（单选按钮或复选框）可用时，用于分隔列表中每个元素的字符序列（例如 <br>）。
attributes：要在 HTML 标签本身内包含的任意标签或文本的附加字符串。此字符串由宏逐字回显。例如，在 textarea 字段中，您可以提供属性（例如“rows="5" cols="60"”），或者您可以传递样式信息，例如“style="border:1px solid silver"”。
classOrStyle：对于 showErrors 宏，包装每个错误的 span 元素使用的 CSS 类名称。如果未提供信息（或值为为空），则错误将包装在 <b></b> 标签中。

以下部分概述了宏的示例。

输入字段

formInput 宏采用 path 参数（command.name）和一个额外的 attributes 参数（在即将到来的示例中为空）。该宏以及所有其他表单生成宏都会对路径参数执行隐式 Spring 绑定。绑定保持有效，直到发生新的绑定，因此 showErrors 宏不需要再次传递路径参数——它对最后创建绑定的字段进行操作。

showErrors 宏采用分隔符参数（用于分隔给定字段上的多个错误的字符），并接受第二个参数——这次是类名或样式属性。请注意，FreeMarker 可以为 attributes 参数指定默认值。以下示例显示了如何使用 formInput 和 showErrors 宏

<@spring.formInput "command.name"/>
<@spring.showErrors "<br>"/>

下一个示例显示表单片段的输出，生成名称字段并在表单提交且字段中没有值后显示验证错误。验证通过 Spring 的 Validation 框架进行。

生成的 HTML 类似于以下示例

Name:
<input type="text" name="name" value="">
<br>
	<b>required</b>
<br>
<br>

formTextarea 宏的工作方式与 formInput 宏相同，并接受相同的参数列表。通常，第二个参数（attributes）用于传递样式信息或 textarea 的 rows 和 cols 属性。

选择字段

您可以使用四个选择字段宏在 HTML 表单中生成常见的 UI 值选择输入

formSingleSelect
formMultiSelect
formRadioButtons
formCheckboxes

这四个宏中的每一个都接受一个包含表单字段的值和对应于该值的标签的 Map 选项。值和标签可以相同。

下一个示例是 FTL 中的单选按钮。表单支持对象为此字段指定了“London”的默认值，因此无需进行验证。当渲染表单时，要选择的整个城市列表作为参考数据提供给模型，名称为“cityMap”。以下清单显示了示例

...
Town:
<@spring.formRadioButtons "command.address.town", cityMap, ""/><br><br>

前面的清单渲染了一行单选按钮，每个 cityMap 中的值一个，并使用 "" 作为分隔符。没有提供其他属性（宏的最后一个参数丢失）。cityMap 对映射中的每个键值对使用相同的 String。映射的键是表单实际提交为 POST 请求参数的内容。映射值是用户看到的标签。在前面的示例中，给定三个知名城市的列表和表单支持对象中的默认值，HTML 类似于以下内容

Town:
<input type="radio" name="address.town" value="London">London</input>
<input type="radio" name="address.town" value="Paris" checked="checked">Paris</input>
<input type="radio" name="address.town" value="New York">New York</input>

如果您的应用程序期望通过内部代码（例如）处理城市，您可以创建具有适当键的代码映射，如下例所示

Java
Kotlin

protected Map<String, ?> referenceData(HttpServletRequest request) throws Exception {
	Map<String, String> cityMap = new LinkedHashMap<>();
	cityMap.put("LDN", "London");
	cityMap.put("PRS", "Paris");
	cityMap.put("NYC", "New York");

	Map<String, Object> model = new HashMap<>();
	model.put("cityMap", cityMap);
	return model;
}

protected fun referenceData(request: HttpServletRequest): Map<String, *> {
	val cityMap = linkedMapOf(
			"LDN" to "London",
			"PRS" to "Paris",
			"NYC" to "New York"
	)
	return hashMapOf("cityMap" to cityMap)
}

现在，代码生成的输出中，单选按钮的值是相关的代码，但用户仍然可以看到更友好的城市名称，如下所示

Town:
<input type="radio" name="address.town" value="LDN">London</input>
<input type="radio" name="address.town" value="PRS" checked="checked">Paris</input>
<input type="radio" name="address.town" value="NYC">New York</input>

HTML 转义

前面描述的表单宏的默认用法会生成符合 HTML 4.01 标准的 HTML 元素，并使用 web.xml 文件中定义的 HTML 转义的默认值，如 Spring 的绑定支持所用。要使元素符合 XHTML 标准或覆盖默认的 HTML 转义值，您可以在模板中（或在模型中，这些值对模板可见）指定两个变量。在模板中指定它们的优点是，可以在模板处理的后期将它们更改为不同的值，以针对表单中的不同字段提供不同的行为。

要切换到标签的 XHTML 兼容性，请为名为 xhtmlCompliant 的模型或上下文变量指定 true 值，如下例所示

<#-- for FreeMarker -->
<#assign xhtmlCompliant = true>

处理此指令后，Spring 宏生成的任何元素现在都符合 XHTML 标准。

以类似的方式，您可以为每个字段指定 HTML 转义，如下例所示

<#-- until this point, default HTML escaping is used -->

<#assign htmlEscape = true>
<#-- next field will use HTML escaping -->
<@spring.formInput "command.name"/>

<#assign htmlEscape = false in spring>
<#-- all future fields will be bound with HTML escaping off -->