1、理解视图解析
将控制器中请求处理的逻辑和视图中的渲染实现解耦是Spring MVC 的一个重要特性。如果控制器中的方法直接负责产生HTML的话,就很难在不影响请求处理逻辑的前提下,维护和更新视图。控制器方法和视图的实现会在模型内容上达成一致,这是两者的最大关联,除此之外,两者应该保持足够的距离。但是,如果控制器只通过逻辑视图来了解视图的话,那Spring该如何确定使用哪一个视图实现来渲染模型呢?这就是Spring视图解析器的任务了。 在之前的章节中,我们使用名为InternalResourceViewResolver的视图解析器。在它的配置中,为了得到视图的名字,会使用”/WEB-INF/views/”前缀和”.jsp”后缀,从而确定来渲染模型的JSP文件的物理位置。现在,我们回过头来看看视图解析器的基础知识以及Spring提供的其他视图解析器。
Spring MVC 定义了一个名为ViewResolver的接口,它大致如下所示:
public interface ViewResolver { View resolveViewName(String viewName, Locale locale) throws Exception; }
ViewResolver 方法,当提供一个 viewName 和 locale 以后,返回一个 View 实体。View 是另外一个接口:
package org.springframework.web.servlet; public interface View { String getContentType(); void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) throws Exception; }
View 接口的作用就是利用 model 数据,还有 request 和 response 对象渲染视图内容,然后返回给 response。 当然你在实际使用的过程中不会接触到这些内部的接口,因为 Spring 提供了很多视图技术的支持:FreeMarkerViewResolver, InternalResourceViewResolver, VelocityViewResolver等。
Spring 4和Spring 3.2支持表中的所有视图解析器。Spring 3.1支持除Tiles 3 TilesViewResolver之外的所有视图解析器。 Spring 3.2及更高版本支持上表中所有的视图解析器,虽然以下视图解析器有13种之多,但是java常用的也就下面几种: 其中最常用的当数InternalResourceViewResolver啦,常用它作为JSP的视图解析器,TilesViewResolver用于解析Apache Tiles视图,TreeMarkerViewResolver作为TreeMaker的视图解析器;VelocityViewResolver作为Velocity模板视图。通常JavaWeb项目会选择JSP作为视图层,所以InternalResourceViewResolver在JavaWeb项目中使用较为广泛。 最后还有一种视图Thymeleaf是一种替代JSP的新兴技术,Spring提供了Thymeleaf的原生模板(naturaltemplate)协作的视图解析器。
视图解析器 描述 BeanNameViewResolver 将视图解析为Spring应用上下文中的bean,其中bean的ID与视图的名字相同 ContentNegatiatingViewResolver 通过考虑客户端需要的内容类型来解析视图,委托给另外一个能给产生对应内容的视图解析器 FreeMarkerViewResolver 将视图解析为FreeMaker模板 InternalResourceViewResolver 将视图解析为Web应用的内部资源(一般为JSP) JasperReportsViewResolver 将视图解析为JasperReports定义 ResourceBundleViewResolver 将视图解析为资源bundle(一般为属性文件) TilesViewResolver 将视图解析为Apache Tile定义,其中tile ID与视图名称相同,主义有两个不同的TilesViewResolver实现,分别对应于Tiles2.0和tiles3.0 UrlBasedViewResolver 直接根据视图名称解析视图,视图的名称会匹配一个物理视图的定义 VelocityLayoutViewResolver 将视图解析为Velocity布局,从不同的Velocity模板中组合页面 VelocityViewResolver 将视图解析为Velocity模板 XmlViewResolver 将视图解析为特定XML文件中的bean定义。类似于BeanNameViewResolver XsltViewResolver 将视图解析为XSLT转化后得结果
2、InternalResourceViewResolver解析JSP视图
Spring提供了两种支持JSP视图的方式:
- InternalResourceViewResolver会将视图名解析为JSP文件。另外,如果在JSP页面中使用了JSP标准签库(JavaServer Pages Standard Tag library,JSTL)的话,InternalResourceViewResolver能够将视图名解析为JstlView形式的JSP文件,从而将JSTL本地化和资源bundle变量暴露给JSTL的格式化(formatting)和信息(message)标签
- Spring提供了连个JSP标签库,一个用于表单到模型的绑定,另一个提供了通用的工具类特性
配置适用于JSP的视图解析器
有一些视图解析器,如ResourceBundleViewResolver会直接将逻辑视图名映射为特定 的View接口实现,而InternalResourceViewResolver所采取的方式并不那么直接。它 遵循一种约定,会在视图名上添加前缀和后缀,进而确定一个Web应用中视图资源的物理路径。
作为样例,考虑一个简单的场景,假设逻辑视图名为home。通用的实践是将JSP文件放到Web 应用的WEB-INF目录下,防止对它的直接访问。如果我们将所有的JSP文件都放在“/WEBINF/views/”目录下,并且home页的JSP名为home.jsp,那么我们可以确定物理视图的路径就是 逻辑视图名home再加上“/WEB-INF/views/”前缀和“.jsp”后缀。
当使用@Bean注解的时候,我们可以按照如下的方式配置Internal-ResourceView Resolver,使其在解析视图时,遵循上述的约定。
@Bean public ViewResolver viewResolver() { // 配置JSP视图解析器 InternalResourceViewResolver resolver = new InternalResourceViewResolver(); resolver.setPrefix("/WEB-INF/views/"); resolver.setSuffix(".jsp"); return resolver; }
InternalResourceViewResolver配置就绪后,它就会将逻辑视图名解析为JSP文件,如下所示:
home将会解析为”/WEB-INF/views/home.jsp”
userList将会解析为”/WEB-INF/views/userList.jsp”
goods/detail将会解析为”/WEB-INF/views/goods/detail.jsp”
当逻辑视图名中包含斜线时,这个斜线也会带到资源的路径中。因此,它会对应到prefix属性所引用目录的子目录下的JSP文件。这样的话,我们就可以很方便地将视图模板组织为层级目录结构,而不是将它们都放到同一个目录之中。代替方案:
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/views/" p:suffix=".jsp"/>
3、配置Tiles视图解析器
首先需要配置TilesConfigurer的bean,它负责定位和加载Tile定义并协调生成Tiles,再者需要TilesViewResolver的bean将逻辑视图名称解析为Tile定义。
@Bean public TilesConfigurer tilesConfigurer() { TilesConfigurer tilesConfigurer = new TilesConfigurer(); // 也可以使用通配符“/WEB-INF/**/tiles.xml” tilesConfigurer.setDefinitions("/WEB-INF/layout/tiles.xml"); tilesConfigurer.setCheckRefresh(true); return tilesConfigurer; }
然后再定义tiles.xml文件和对应的文件即可。
4、配置Thymeleaf视图解析器
需要配置如下三个bean。
- ThymeleafViewResolver,将逻辑视图名解析为Thymeleaf模版视图。
- SpringTemplateEngine,处理模板并渲染结果。
- TemplateResolver,加载Thymeleaf模板。
添加bean至WebConfig中如下:
@Bean public ViewResolver viewResolver(SpringTemplateEngine templateEngine) { // 视图解析器 ThymeleafViewResolver viewResolver = new ThymeleafViewResolver(); viewResolver.setTemplateEngine(templateEngine); return viewResolver; } @Bean public SpringTemplateEngine templateEngine(TemplateResolver templateResolver) { // 模板引擎 SpringTemplateEngine templateEngine = new SpringTemplateEngine(); templateEngine.setTemplateResolver(templateResolver); return templateEngine; } @Bean public TemplateResolver templateResolver() { // 模板解析器 TemplateResolver templateResolver = new ServletContextTemplateResolver(); templateResolver.setPrefix("/WEB-INF/views/"); templateResolver.setSuffix(".html"); templateResolver.setTemplateMode("HTML5"); return templateResolver; }
在SpringBoot中集成Thymeleaf
pom文件:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency>
配置application.properties
# thymeleaf spring.thymeleaf.prefix=classpath:/templates/ spring.thymeleaf.check-template-location=true spring.thymeleaf.suffix=.html spring.thymeleaf.encoding=UTF-8 spring.thymeleaf.servlet.content-type=text/html spring.resources.static-locations=classpath:/static/,classpath:/templates/ spring.thymeleaf.mode=HTML5 spring.thymeleaf.cache=false
然后根据配置创建templates文件夹,.html文件即可。
5、thymeleaf 常用的表达式:
官网文档:
https://www.thymeleaf.org/doc/tutorials/3.0/usingthymeleaf.html#using-thtext-and-externalizing-text