76.8 自定义ViewResolvers

ViewResolver是Spring MVC的核心组件,它负责转换@Controller中的视图名称到实际的View实现。注意ViewResolvers主要用在UI应用中,而不是REST风格的服务(View不是用来渲染@ResponseBody的)。Spring有很多你可以选择的ViewResolver实现,并且Spring自己对如何选择相应实现也没发表意见。另一方面,Spring Boot会根据classpath上的依赖和应用上下文为你安装一或两个ViewResolver实现。DispatcherServlet使用所有在应用上下文中找到的解析器(resolvers),并依次尝试每一个直到它获取到结果,所以如果你正在添加自己的解析器,那就要小心顺序和你的解析器添加的位置。

WebMvcAutoConfiguration将会为你的上下文添加以下ViewResolvers

  • 名为defaultViewResolverInternalResourceViewResolver,它会定位可以使用DefaultServlet渲染的物理资源(比如静态资源和JSP页面)。它在视图名上应用了一个前缀和后缀(默认都为空,但你可以通过spring.view.prefixspring.view.suffix设置),然后查找在servlet上下文中具有该路径的物理资源,可以通过提供相同类型的bean覆盖它。

  • 名为beanNameViewResolverBeanNameViewResolver,它是视图解析器链的一个非常有用的成员,可以在View解析时收集任何具有相同名称的beans,没必要覆盖或替换它。

  • 名为viewResolverContentNegotiatingViewResolver,它只会在实际View类型的beans出现时添加。这是一个'master'解析器,它的职责会代理给其他解析器,它会尝试找到客户端发送的一个匹配'Accept'的HTTP头部。这有一篇关于ContentNegotiatingViewResolver的博客,你也可以也查看下源码。通过定义一个名叫'viewResolver'的bean,你可以关闭自动配置的ContentNegotiatingViewResolver

  • 如果使用Thymeleaf,你将有一个id为thymeleafViewResolverThymeleafViewResolver,它会通过加前缀和后缀的视图名来查找资源(外部配置为spring.thymeleaf.prefixspring.thymeleaf.suffix,对应的默认为'classpath:/templates/'和'.html')。你可以通过提供相同名称的bean来覆盖它。

  • 如果使用FreeMarker,你将有一个名为freeMarkerViewResolverFreeMarkerViewResolver,它会使用加前缀和后缀。它通过在视图名周围加上前缀和后缀来查找加载器路径中的资源(加载器路径外化为spring.freemarker.templateLoaderPath,默认值为classpath:/templates/)。前缀外部化为spring.freemarker.prefix,后缀外部化为spring.freemarker.suffix。前缀和后缀的默认值为空和.ftl。你可以通过提供同名的bean来覆盖FreeMarkerViewResolver

  • 如果使用Groovy模板(实际上只要你把groovy-templates添加到classpath下),你将有一个名为groovyTemplateViewResolverGroovy TemplateViewResolver。它会使用加前缀和后缀(外部属性为spring.groovy.template.prefixspring.groovy.template.suffix,对应的默认值为classpath:/templates/.tpl)的视图名从加载路径下查找资源。你可以通过提供同名的bean来覆盖它。

更多详情,可查看下列章节:

最后更新于