SpringBoot同時(shí)支持多個(gè)視圖解析器jsp+html+其他模版引擎！

有一個(gè)不算老的項(xiàng)目，經(jīng)歷過幾波人迭代，源碼維護(hù)的一塌糊涂。視圖這一塊，用的有 jsp，html，freemarker 等。視圖不統(tǒng)一，導(dǎo)致啟用 html 后，就不能訪問 jsp 和 freemarker。這些具備互斥的因素，導(dǎo)致項(xiàng)目跑了 3 個(gè)，通過 Nginx 來適配。

今天，我給大家分享一種辦法，讓 SpringBoot 項(xiàng)目，同時(shí)支持多種模版引擎。

先說一下，這里沒有新技術(shù)，新發(fā)明。只是根據(jù) WebMvc 視圖解析器的原理進(jìn)行略微的改造。

我們都知道，在 SpringMVC 中有 3 個(gè)主要的類：DispatherServlet(前端控制器)、ViewResolver(視圖解析器)、View(視圖類)。

下面是一個(gè)簡(jiǎn)單的視圖解析的流程。

 

由圖可知，如果我們要支持多個(gè)視圖，就需要配置多個(gè)視圖解析器。比如：ThymeleafViewResolver、InternalResourceViewResolver（系統(tǒng)默認(rèn)實(shí)現(xiàn)）、ContentNegotiatingViewResolver、BeanNameViewResolver等。

DispatcherServlet 在選擇視圖解析器的時(shí)候，以優(yōu)先級(jí)為處理原則，此優(yōu)先級(jí)是根據(jù)該 ViewResolver 實(shí)現(xiàn) Ordered 接口或者使用 @Order 注解賦值，數(shù)字最小優(yōu)先級(jí)越高為原則。

然后對(duì)應(yīng)視圖解析器會(huì)返回一個(gè)具體的 View 類。最終通過3、4步驟渲染成 HTML 或者是 XML 等視圖內(nèi)容。

下圖就是具體的排序方法，viewResolvers 是一個(gè) List 集合。

 

排完序后，匹配 View 對(duì)象的方法，遍歷 viewResolvers，匹配到第一個(gè) View 對(duì)象，則返回。

 

因此，當(dāng)配置多個(gè)視圖，需要同時(shí)支持多個(gè)視圖時(shí)，就會(huì)發(fā)生一些 404(當(dāng)我們配置多個(gè)視圖解析器時(shí)，出現(xiàn)只支持一種視圖解析器器，其他類型產(chǎn)生 404)。

以 ThymeleafViewResolver 為例，在 ThymeleafAutoConfiguration 中，可以看到它的 Order 為 Ordered.LOWEST_PRECEDENCE - 5。

 

而 SpringBoot 自動(dòng)注入的 InternalResourceViewResolver 的優(yōu)先級(jí)為最低級(jí)。

注意：這里指的是自動(dòng)注入，就是在我們不經(jīng)過任何改造的情況下，是屬于最低級(jí)的。

 

@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;
}

由于，匹配到一個(gè) View 對(duì)象，就立即返回。導(dǎo)致你不管配置了多少個(gè)視圖解析器，返回的 View 可能都不是正確的，這就導(dǎo)致了 404 的出現(xiàn)。

那么有沒有可能動(dòng)態(tài)的調(diào)整排序，或者動(dòng)態(tài)的指定視圖解析器就成了關(guān)鍵。好在，SpringMVC 給我們留下了口子。我們只需要間的重寫一個(gè) InternalResourceView 即可。

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

通過上面的代碼，我們先檢查一下對(duì)應(yīng)的模版文件是否存在。然后通過下面的代碼，動(dòng)態(tài)的調(diào)整視圖解析器。

@Bean
public InternalResourceViewResolver htmlViewResolver() {
    InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
    viewResolver.setPrefix("/");
    //設(shè)置檢查器
    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();
    //設(shè)置檢查器
    viewResolver.setViewClass(HandleResourceViewExists.class);
    viewResolver.setPrefix("/WEB-INF/");
    viewResolver.setSuffix(".jsp");
    viewResolver.setOrder(0);
    viewResolver.setContentType("text/html;charset=UTF-8");
    return viewResolver;
}

這里給大家提供了一個(gè)思路，如果通過調(diào)試代碼，發(fā)現(xiàn)問題，解決問題。