# 1.9 View技术
Spring MVC中视图技术的使用是可插入的，无论您决定使用Thymeleaf，Groovy标记模板，JSP还是其他技术，主要取决于配置更改。 本章介绍与Spring MVC集成的视图技术。 我们假设您已经熟悉View Resolution。
## 1.9.1 Thymeleaf
Thymeleaf是一种现代的服务器端Java模板引擎，它强调可以通过双击在浏览器中预览的自然HTML模板，这对于独立处理UI模板（例如，由设计人员）而无需使用非常有用。 正在运行的服务器。 如果要替换JSP，Thymeleaf提供了最广泛的功能集之一，以使这种过渡更加容易。 Thymeleaf是积极开发和维护的。 有关更完整的介绍，请参见Thymeleaf项目主页。
Thymeleaf与Spring MVC的集成由Thymeleaf项目管理。 该配置涉及一些Bean声明，例如ServletContextTemplateResolver，SpringTemplateEngine和ThymeleafViewResolver。 有关更多详细信息，请参见Thymeleaf + Spring。
## 1.9.2 FreeMarker
Apache FreeMarker是一个模板引擎，用于生成从HTML到电子邮件等的任何类型的文本输出。 Spring框架具有内置的集成，可以将Spring MVC与FreeMarker模板一起使用。
**View配置**
以下示例显示如何将FreeMarker配置为一种视图技术：
```java
@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");
return configurer;
}
}
```
以下示例显示了如何在XML中进行配置：
```markup
```
另外，您也可以声明FreeMarkerConfigurer bean，以完全控制所有属性，如以下示例所示：
```markup
```
您的模板需要存储在上例所示的FreeMarkerConfigurer指定的目录中。 给定上述配置，如果您的控制器返回欢迎的视图名称，则解析器将查找/WEB-INF/freemarker/welcome.ftl模板。
**FreeMarker Configuration**
您可以通过在FreeMarkerConfigurer bean上设置适当的bean属性，将FreeMarker的“设置”和“ SharedVariables”直接传递给FreeMarker配置对象（由Spring管理）。 freemarkerSettings属性需要一个java.util.Properties对象，而freemarkerVariables属性需要一个java.util.Map。 以下示例显示了如何执行此操作：
```markup
```
有关设置和变量应用于Configuration对象的详细信息，请参见FreeMarker文档。
**表格处理**
Spring提供了一个供JSP使用的标签库，其中包含一个\元素。该元素主要允许表单显示来自表单支持对象的值，并显示来自Web或业务层中Validator的验证失败的结果。 Spring还支持FreeMarker中的相同功能，并带有用于生成表单输入元素本身的附加便利宏。
**绑定宏**
spring-webmvc.jar文件中为这两种语言维护了一组标准宏，因此它们始终可用于经过适当配置的应用程序。
Spring库中定义的某些宏被视为内部（私有）宏，但是在宏定义中不存在这种范围，使所有宏对调用代码和用户模板可见。以下各节仅关注您需要在模板中直接调用的宏。如果您希望直接查看宏代码，则该文件名为spring.ftl，位于org.springframework.web.servlet.view\.freemarker包中。
**简单绑定**
在充当Spring MVC控制器的表单视图的HTML表单（vm或ftl模板）中，您可以使用类似于下一个示例的代码绑定到字段值，并以类似于JSP的方式显示每个输入字段的错误消息。当量。以下示例显示了先前配置的personForm视图：
```markup
<#import "/spring.ftl" as spring/>
...
...
```
<@ spring.bind>需要一个'path'参数，该参数由命令对象的名称（除非您在FormController属性中进行了更改，否则为'command'）组成，后跟一个句点和字段的名称。您希望绑定到的命令对象。您还可以使用嵌套字段，例如command.address.street。 bind宏假定由web.xml中的ServletContext参数defaultHtmlEscape指定的默认HTML转义行为。
名为<@ spring.bindEscaped>的宏的可选形式带有第二个参数，并明确指定在状态错误消息或值中应使用HTML转义。您可以根据需要将其设置为true或false。附加的表单处理宏可简化HTML转义的使用，并且您应尽可能使用这些宏。下一节将对它们进行说明。
**输入宏**
两种语言的附加便利宏均简化了绑定和表单生成（包括验证错误显示）。从来没有必要使用这些宏来生成表单输入字段，并且您可以将它们与简单的HTML混合或匹配，或者直接调用我们之前强调的spring绑定宏。
下表可用的宏显示了每个FTL定义和参数列表：
| macro | FTL definition |
| ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- |
| message (output a string from a resource bundle based on the code parameter) | <@spring.message code/> |
| messageText (output a string from a resource bundle based on the code parameter, falling back to the value of the default parameter) | <@spring.messageText code, text/> |
| url (prefix a relative URL with the application’s context root) | <@spring.url relativeUrl/> |
| formInput (standard input field for gathering user input) | <@spring.formInput path, attributes, fieldType/> |
| formHiddenInput (hidden input field for submitting non-user input) | <@spring.formHiddenInput path, attributes/> |
| formPasswordInput (standard input field for gathering passwords. Note that no value is ever populated in fields of this type.) | <@spring.formPasswordInput path, attributes/> |
| formTextarea (large text field for gathering long, freeform text input) | <@spring.formTextarea path, attributes/> |
| formSingleSelect (drop down box of options that let a single required value be selected) | <@spring.formSingleSelect path, options, attributes/> |
| formMultiSelect (a list box of options that let the user select 0 or more values) | <@spring.formMultiSelect path, options, attributes/> |
| formRadioButtons (a set of radio buttons that let a single selection be made from the available choices) | <@spring.formRadioButtons path, options separator, attributes/> |
| formCheckboxes (a set of checkboxes that let 0 or more values be selected) | <@spring.formCheckboxes path, options, separator, attributes/> |
| formCheckbox (a single checkbox) | <@spring.formCheckbox path, attributes/> |
| showErrors (simplify display of validation errors for the bound field) | <@spring.showErrors separator, classOrStyle/> |
* 在FTL（FreeMarker）中，实际上并不需要formHiddenInput和formPasswordInput，因为您可以使用常规的formInput宏，将hidden或password指定为fieldType参数的值。
以上任何宏的参数都具有一致的含义：
* path：要绑定的字段名称（即“ command.name”）
* options：可以在输入字段中选择的所有可用值的映射。映射的键表示从表单回发并绑定到命令对象的值。针对键存储的地图对象是在表单上显示给用户的标签，并且可能与表单回发的相应值不同。通常，这种地图由控制器作为参考数据提供。您可以使用任何Map实现，具体取决于所需的行为。对于严格排序的地图，可以将SortedMap（例如TreeMap）与合适的Comparator一起使用；对于应按插入顺序返回值的任意地图，请使用Commons-collection中的LinkedHashMap或LinkedMap。
* 分隔符：当多个选项可用作离散元素（单选按钮或复选框）时，用于分隔列表中的每个字符的字符序列（例如\ ）。
* 属性：HTML标记本身包含的任意标记或文本的附加字符串。该字符串实际上是由宏回显的。例如，在textarea字段中，您可以提供属性（例如'rows =“ 5” cols =“ 60”'），也可以传递样式信息，例如'style =“ border：1px solid silver”。
* classOrStyle：对于showErrors宏，包装每个错误的span元素使用的CSS类的名称。如果未提供任何信息（或该值为空），则错误将包装在\ \标记中。
以下各节概述了宏的示例（某些在FTL中，有些在VTL中）。两种语言之间存在用法差异的地方，在注解中进行了说明。
**输入栏位** formInput宏带有path参数（command.name）和一个附加的attribute参数（在后面的示例中为空）。该宏与所有其他表单生成宏一起，对path参数执行隐式Spring绑定。绑定保持有效，直到发生新的绑定为止，因此showErrors宏无需再次传递path参数。它在最后创建绑定的字段上进行操作。
showErrors宏采用分隔符参数（用于分隔给定字段上的多个错误的字符），并且还接受第二个参数-这次是类名或样式属性。注意，FreeMarker可以为attributes参数指定默认值。下面的示例演示如何使用formInput和showWErrors宏：
```markup
<@spring.formInput "command.name"/>
<@spring.showErrors " "/>
```
下一个示例显示表单片段的输出，生成名称字段，并在提交表单后在字段中没有值的情况下显示验证错误。 验证通过Spring的Validation框架进行。
生成的HTML类似于以下示例：
```markup
Name:
required
```
HTML 如下所示：
```markup
```
spring-webmvc.jar中包含spring-form.tld标记库描述符（TLD）。有关单个标签的全面参考，请浏览API参考或查看标签库说明。
**HTTP方法转换**
REST的一个关键原则是使用“统一接口”。这意味着可以使用相同的四种HTTP方法（GET，PUT，POST和DELETE）来操纵所有资源（URL）。对于每种方法，HTTP规范都定义了确切的语义。例如，GET应该始终是安全的操作，这意味着它没有副作用，而PUT或DELETE应该是幂等的，这意味着您可以一遍又一遍地重复这些操作，但是最终结果应该相同。虽然HTTP定义了这四种方法，但HTML仅支持两种：GET和POST。幸运的是，有两种可能的解决方法：您可以使用JavaScript进行PUT或DELETE，或者可以使用“ real”方法作为附加参数（在HTML表单中建模为隐藏的输入字段）进行POST。 Spring的HiddenHttpMethodFilter使用了后一种技巧。该过滤器是一个普通的Servlet过滤器，因此，它可以与任何Web框架（不仅仅是Spring MVC）结合使用。将此过滤器添加到web.xml，然后将带有隐藏方法参数的POST转换为相应的HTTP方法请求。
为了支持HTTP方法转换，Spring MVC表单标签已更新为支持设置HTTP方法。例如，以下代码片段来自“宠物诊所”样本：
```markup
```
前面的示例执行HTTP POST，并将“真实” DELETE方法隐藏在请求参数后面。 它由在web.xml中定义的HiddenHttpMethodFilter拾取，如以下示例所示：
```markup
httpMethodFilterorg.springframework.web.filter.HiddenHttpMethodFilterhttpMethodFilterpetclinic
```
以下示例显示了相应的@Controller方法：
```java
@RequestMapping(method = RequestMethod.DELETE)
public String deletePet(@PathVariable int ownerId, @PathVariable int petId) {
this.clinic.deletePet(petId);
return "redirect:/owners/" + ownerId;
}
```
**HTML5标签**
Spring表单标签库允许输入动态属性，这意味着您可以输入任何HTML5特定的属性。
表单输入标签支持输入文本以外的类型属性。 这旨在允许呈现新的HTML5特定输入类型，例如电子邮件，日期，范围等。 请注意，由于默认类型为text，因此不需要输入type ='text'。
## 1.9.6 Tiles
您可以像使用其他视图技术一样，将Tiles集成到使用Spring的Web应用程序中。 本节以广泛的方式描述如何执行此操作。
> 本节重点介绍org.springframework.web.servlet.view\.tiles3软件包中Spring对Tiles版本3的支持。
**依存关系**
为了能够使用Tiles，您必须在Tiles 3.0.1或更高版本上添加一个依赖项，并将其传递依赖项添加到您的项目中。
**Configuration**
为了能够使用Tiles，必须使用包含定义的文件对其进行配置（有关定义和其他Tiles概念的基本信息，请参见 在春季，这是通过使用TilesConfigurer完成的。 以下示例ApplicationContext配置说明了如何执行此操作：
```markup
/WEB-INF/defs/general.xml/WEB-INF/defs/widgets.xml/WEB-INF/defs/administrator.xml/WEB-INF/defs/customer.xml/WEB-INF/defs/templates.xml
```
前面的示例定义了五个包含定义的文件。 这些文件都位于WEB-INF / defs目录中。 在WebApplicationContext初始化时，将加载文件，并初始化定义工厂。 完成之后，定义文件中包含的Tiles可以用作Spring Web应用程序中的视图。 为了能够使用视图，您必须拥有一个ViewResolver以及与Spring一起使用的任何其他视图技术。 您可以使用UrlBasedViewResolver和ResourceBundleViewResolver这两个实现中的任何一个。
您可以通过添加下划线然后添加语言环境来指定特定于语言环境的Tiles定义，如以下示例所示：
```markup
/WEB-INF/defs/tiles.xml/WEB-INF/defs/tiles_fr_FR.xml
```
通过上述配置，tile\_fr\_FR.xml用于具有fr\_FR语言环境的请求，默认情况下使用tile.xml。
> 由于下划线用于指示语言环境，因此建议不要在图块定义的文件名中使用下划线。
**UrlBasedViewResolver**
UrlBasedViewResolver为其要解析的每个视图实例化给定的viewClass。 以下bean定义了一个UrlBasedViewResolver：
```markup
```
**ResourceBundleViewResolver**
必须为ResourceBundleViewResolver提供一个属性文件，该文件包含解析程序可以使用的视图名称和视图类。 以下示例显示了ResourceBundleViewResolver的bean定义以及相应的视图名称和视图类（摘自Pet Clinic示例）：
```markup
```
```java
...
welcomeView.(class)=org.springframework.web.servlet.view.tiles3.TilesView
welcomeView.url=welcome (this is the name of a Tiles definition)
vetsView.(class)=org.springframework.web.servlet.view.tiles3.TilesView
vetsView.url=vetsView (again, this is the name of a Tiles definition)
findOwnersForm.(class)=org.springframework.web.servlet.view.JstlView
findOwnersForm.url=/WEB-INF/jsp/findOwners.jsp
...
```
使用ResourceBundleViewResolver时，可以轻松地混合使用不同的视图技术。
请注意，TilesView类支持JSTL（JSP标准标记库）。
SimpleSpringPreparerFactory和SpringBeanPreparerFactory 作为一项高级功能，Spring还支持两个特殊的Tiles PreparerFactory实现。有关如何在Tiles定义文件中使用ViewPreparer引用的详细信息，请参见Tiles文档。
您可以指定SimpleSpringPreparerFactory以根据指定的准备器类自动连接ViewPreparer实例，应用Spring的容器回调以及应用配置的Spring BeanPostProcessor。如果已激活Spring的上下文范围的注解配置，则将自动检测和应用ViewPreparer类中的注解。请注意，这与默认的PreparerFactory一样，期望Tiles定义文件中的preparer类。
您可以指定SpringBeanPreparerFactory以对指定的准备程序名称（而不是类）进行操作，从而从DispatcherServlet的应用程序上下文中获取相应的Spring bean。在这种情况下，完整的bean创建过程由Spring应用程序上下文控制，从而允许使用显式依赖项注入配置，作用域bean等。注意，您需要为每个准备器名称定义一个Spring bean定义（在Tiles定义中使用）。下面的示例演示如何在TilesConfigurer bean上定义SpringBeanPreparerFactory属性：
```markup
/WEB-INF/defs/general.xml/WEB-INF/defs/widgets.xml/WEB-INF/defs/administrator.xml/WEB-INF/defs/customer.xml/WEB-INF/defs/templates.xml
```
## 1.9.7 RSS and Atom
AbstractAtomFeedView和AbstractRssFeedView都继承自AbstractFeedView基类，分别用于提供Atom和RSS Feed视图。 它们基于java.net的ROME项目，位于org.springframework.web.servlet.view\.feed包中。
AbstractAtomFeedView要求您实现buildFeedEntries（）方法，并可选地覆盖buildFeedMetadata（）方法（默认实现为空）。 以下示例显示了如何执行此操作：
```java
public class SampleContentAtomView extends AbstractAtomFeedView {
@Override
protected void buildFeedMetadata(Map model,
Feed feed, HttpServletRequest request) {
// implementation omitted
}
@Override
protected List buildFeedEntries(Map model,
HttpServletRequest request, HttpServletResponse response) throws Exception {
// implementation omitted
}
}
```
相似的要求适用于实现AbstractRssFeedView，如以下示例所示：
```java
public class SampleContentRssView extends AbstractRssFeedView {
@Override
protected void buildFeedMetadata(Map model,
Channel feed, HttpServletRequest request) {
// implementation omitted
}
@Override
protected List buildFeedItems(Map model,
HttpServletRequest request, HttpServletResponse response) throws Exception {
// implementation omitted
}
}
```
如果需要访问Locale，则buildFeedItems（）和buildFeedEntries（）方法会传递HTTP请求。 仅针对Cookie或其他HTTP标头的设置传入HTTP响应。 方法返回后，提要将自动写入响应对象。
有关创建Atom视图的示例，请参见Alef Arendsen的Spring Team Blog条目。
## 1.9.8 PDF and Excel
Spring提供了返回HTML以外的输出的方法，包括PDF和Excel电子表格。本节介绍如何使用这些功能。
**Document view简介**
HTML页面并非始终是用户查看模型输出的最佳方法，而Spring使从模型数据动态生成PDF文档或Excel电子表格变得简单。该文档是视图，并从服务器以正确的内容类型进行流传输，以（希望）使客户端PC能够运行其电子表格或PDF查看器应用程序作为响应。
为了使用Excel视图，您需要将Apache POI库添加到您的类路径中。为了生成PDF，您需要添加（最好是）OpenPDF库。
> 如果可能，您应该使用基础文档生成库的最新版本。特别是，我们强烈建议您使用OpenPDF（例如，OpenPDF 1.2.12）而不是过时的原始iText 2.1.7，因为OpenPDF会得到积极维护并修复了不可信任PDF内容的重要漏洞。
**PDF views**
单词列表的简单PDF视图可以扩展org.springframework.web.servlet.view\.document.AbstractPdfView并实现buildPdfDocument（）方法，如以下示例所示：
```java
public class PdfWordList extends AbstractPdfView {
protected void buildPdfDocument(Map model, Document doc, PdfWriter writer,
HttpServletRequest request, HttpServletResponse response) throws Exception {
List words = (List) model.get("wordList");
for (String word : words) {
doc.add(new Paragraph(word));
}
}
}
```
控制器可以从外部视图定义（按名称引用）返回此视图，也可以从处理程序方法返回为视图实例。
**Excel view**
从Spring Framework 4.2开始，提供org.springframework.web.servlet.view\.document.AbstractXlsView作为Excel视图的基类。 它基于Apache POI，具有取代过时的AbstractExcelView类的专用子类（AbstractXlsxView和AbstractXlsxStreamingView）。
编程模型类似于AbstractPdfView，其中buildExcelDocument（）作为中央模板方法，控制器能够从外部定义（按名称）或从处理程序方法作为View实例返回这种视图。
## 1.9.9 Jackson
Spring提供了对Jackson JSON库的支持。
**基于Jackson的JSON MVC视图**
MappingJackson2JsonView使用Jackson library的ObjectMapper将响应内容呈现为JSON。默认情况下，模型映射的全部内容（特定于框架的类除外）均编码为JSON。对于需要过滤地图内容的情况，可以使用modelKeys属性指定一组特定的模型属性进行编码。您也可以使用extractValueFromSingleKeyModel属性，以将单键模型中的值直接提取并序列化，而不是作为模型属性的映射。
您可以根据需要使用Jackson提供的注解来自定义JSON映射。当需要进一步控制时，可以在需要为特定类型提供自定义JSON序列化器和反序列化器的情况下，通过ObjectMapper属性注入自定义ObjectMapper。
**基于Jackson的XML视图**
MappingJackson2XmlView使用Jackson XML扩展程序的XmlMapper将响应内容呈现为XML。如果模型包含多个条目，则应使用modelKey bean属性显式设置要序列化的对象。如果模型包含单个条目，则会自动序列化。
您可以根据需要使用JAXB或Jackson提供的注解自定义XML映射。当需要进一步控制时，可以通过ObjectMapper属性注入自定义XmlMapper，对于自定义XML，需要为特定类型提供序列化器和反序列化器的情况。
## 1.9.10 XML Marshalling
MarshallingView使用XML Marshaller（在org.springframework.oxm包中定义）将响应内容呈现为XML。 您可以使用MarshallingView实例的modelKey bean属性显式设置要编组的对象。 或者，视图遍历所有模型属性，并封送Marshaller支持的第一个类型。 有关org.springframework.oxm包中功能的更多信息，请参见使用O / X映射器编组XML。
## 1.9.11 XSLT Views
XSLT是XML的一种转换语言，在Web应用程序中作为一种视图技术而流行。 如果您的应用程序自然处理XML，或者您的模型可以轻松转换为XML，则XSLT可以作为视图技术的不错选择。 下一节显示了如何将XML文档生成为模型数据，以及如何在Spring Web MVC应用程序中使用XSLT对其进行转换。
这个例子是一个普通的Spring应用程序，它在Controller中创建一个单词列表并将它们添加到模型图中。 返回该地图以及XSLT视图的视图名称。 有关Spring Web MVC的Controller界面的详细信息，请参见带注解的控制器。 XSLT控制器将单词列表转换为准备转换的简单XML文档。
**Beans**
Configuration是简单Spring Web应用程序的标准配置：MVC配置必须定义XsltViewResolver bean和常规MVC注解配置。 以下示例显示了如何执行此操作：
```java
@EnableWebMvc
@ComponentScan
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Bean
public XsltViewResolver xsltViewResolver() {
XsltViewResolver viewResolver = new XsltViewResolver();
viewResolver.setPrefix("/WEB-INF/xsl/");
viewResolver.setSuffix(".xslt");
return viewResolver;
}
}
```
**Controller**
我们还需要一个封装了词生成逻辑的控制器。
控制器逻辑封装在@Controller类中，其处理程序方法定义如下：
```java
@Controller
public class XsltController {
@RequestMapping("/")
public String home(Model model) throws Exception {
Document document = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();
Element root = document.createElement("wordList");
List words = Arrays.asList("Hello", "Spring", "Framework");
for (String word : words) {
Element wordNode = document.createElement("word");
Text textNode = document.createTextNode(word);
wordNode.appendChild(textNode);
root.appendChild(wordNode);
}
model.addAttribute("wordList", root);
return "home";
}
}
```
到目前为止，我们仅创建了一个DOM文档并将其添加到Model映射中。 请注意，您还可以将XML文件作为资源加载并使用它代替自定义DOM文档。
有可用的软件包自动“对象化”对象图，但是在Spring中，您可以完全灵活地以任何选择的方式从模型中创建DOM。 这样可以防止XML转换在模型数据的结构中扮演过多的角色，这在使用工具来管理DOMification流程时是一种危险。
**Transformation**
最后，XsltViewResolver解析"home” XSLT模板文件，并将DOM文档合并到其中以生成我们的视图。 如XsltViewResolver配置所示，XSLT模板位于WEB-INF / xsl目录的war文件中，并以xslt文件扩展名结尾。
以下示例显示了XSLT转换：
```markup
Hello!
My First Words
```
前面的转换呈现为以下HTML：
```markup
Hello!
My First Words
Hello
Spring
Framework
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.flydean.com/spring-framework-documentation5/webservlet/1.spring-web-mvc/1.9view-technologies.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.