SpringBoot同时支持多个视图解析器jsp+html+其他模版引擎!

JAVA herman 702浏览
公告:“业余草”微信公众号提供免费CSDN下载服务(只下Java资源),关注业余草微信公众号,添加作者微信:codedq,发送下载链接帮助你免费下载!
本博客日IP超过2000,PV 3000 左右,急需赞助商。
极客时间所有课程通过我的二维码购买后返现24元微信红包,请加博主新的微信号:codedq,之前的微信号好友位已满,备注:返现
受密码保护的文章请关注“业余草”公众号,回复关键字“0”获得密码
所有面试题(java、前端、数据库、springboot等)一网打尽,请关注文末小程序
视频教程免费领

SpringBoot同时支持多个视图解析器jsp+html+其他模版引擎!

有一个不算老的项目,经历过几波人迭代,源码维护的一塌糊涂。视图这一块,用的有 jsp,html,freemarker 等。视图不统一,导致启用 html 后,就不能访问 jsp 和 freemarker。这些具备互斥的因素,导致项目跑了 3 个,通过 Nginx 来适配。

今天,我给大家分享一种办法,让 SpringBoot 项目,同时支持多种模版引擎。

先说一下,这里没有新技术,新发明。只是根据 WebMvc 视图解析器的原理进行略微的改造。

我们都知道,在 SpringMVC 中有 3 个主要的类:DispatherServlet(前端控制器)、ViewResolver(视图解析器)、View(视图类)。

下面是一个简单的视图解析的流程。

SpringMVC执行流程

由图可知,如果我们要支持多个视图,就需要配置多个视图解析器。比如:ThymeleafViewResolver、InternalResourceViewResolver(系统默认实现)、ContentNegotiatingViewResolver、BeanNameViewResolver等。

DispatcherServlet 在选择视图解析器的时候,以优先级为处理原则,此优先级是根据该 ViewResolver 实现 Ordered 接口或者使用 @Order 注解赋值,数字最小优先级越高为原则。

然后对应视图解析器会返回一个具体的 View 类。最终通过3、4步骤渲染成 HTML 或者是 XML 等视图内容。

下图就是具体的排序方法,viewResolvers 是一个 List 集合。

SpringMVC视图解析器排序

排完序后,匹配 View 对象的方法,遍历 viewResolvers,匹配到第一个 View 对象,则返回。

SpringMVC视图解析器匹配View

因此,当配置多个视图,需要同时支持多个视图时,就会发生一些 404(当我们配置多个视图解析器时,出现只支持一种视图解析器器,其他类型产生 404)。

以 ThymeleafViewResolver 为例,在 ThymeleafAutoConfiguration 中,可以看到它的 Order 为 Ordered.LOWEST_PRECEDENCE – 5。

ThymeleafViewResolver 源码

而 SpringBoot 自动注入的 InternalResourceViewResolver 的优先级为最低级。

注意:这里指的是自动注入,就是在我们不经过任何改造的情况下,是属于最低级的。

InternalResourceViewResolver 优先级
@Bean
public InternalResourceViewResolver viewResolver() {
InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
    viewResolver.setPrefix("/WEB-INF/");
    viewResolver.setSuffix(".jsp");
    viewResolver.setOrder(0);
    viewResolver.setContentType("text/html;charset=UTF-8");
    return viewResolver;
}

由于,匹配到一个 View 对象,就立即返回。导致你不管配置了多少个视图解析器,返回的 View 可能都不是正确的,这就导致了 404 的出现。

那么有没有可能动态的调整排序,或者动态的指定视图解析器就成了关键。好在,SpringMVC 给我们留下了口子。我们只需要间的重写一个 InternalResourceView 即可。

public class HandleResourceViewExists extends InternalResourceView {
    @Override
    public boolean checkResource(Locale locale) {
        File file = new File(this.getServletContext().getRealPath("/") + getUrl());
        //判断页面是否存在
        return file.exists(); 
    }
}

通过上面的代码,我们先检查一下对应的模版文件是否存在。然后通过下面的代码,动态的调整视图解析器。

@Bean
public InternalResourceViewResolver htmlViewResolver() {
    InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
    viewResolver.setPrefix("/");
    //设置检查器
    viewResolver.setViewClass(HandleResourceViewExists.class); 
    viewResolver.setSuffix(".html");
    viewResolver.setOrder(0);
    viewResolver.setContentType("text/html;charset=UTF-8");
    return viewResolver;
}

@Bean
public InternalResourceViewResolver viewResolver() {
    InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
    //设置检查器
    viewResolver.setViewClass(HandleResourceViewExists.class);
    viewResolver.setPrefix("/WEB-INF/");
    viewResolver.setSuffix(".jsp");
    viewResolver.setOrder(0);
    viewResolver.setContentType("text/html;charset=UTF-8");
    return viewResolver;
}

更多视图的做法类似,我就不在贴代码了。这里给大家提供了一个思路,如果通过调试代码,发现问题,解决问题。

我是业余草,欢迎大家关注,留言评论!

业余草公众号

最后,欢迎关注我的个人微信公众号:业余草(yyucao)!可加作者微信号1:xmtxtt(5000人已满),微信号2:xttblog(5000人已满),微信号3:codedq(超3800)。备注:“1”,添加博主微信拉你进微信群。备注错误不会同意好友申请。再次感谢您的关注!后续有精彩内容会第一时间发给您!原创文章投稿请发送至532009913@qq.com邮箱。商务合作也可添加作者微信进行联系!

本文原文出处:业余草: » SpringBoot同时支持多个视图解析器jsp+html+其他模版引擎!