快捷導航

SpringBoot視圖解析實現(xiàn)原理深入分析

更新時間：2022年10月08日 10:09:02 作者：Decade0712

視圖解析其實就是SpringBoot某一個controller的方法執(zhí)行完成之后，它是跳轉(zhuǎn)到那個頁面。由于我們springboot項目默認打包為jar包，是形成壓縮包的形式，而jsp又不支持壓縮，所以我們SpringBoot不知JSP的，需要引入第三方模板引擎才可以處理

一、寫在前面

前面我們分析了Spring boot是如何解析請求參數(shù)和如何處理相應信息的

那么它是如何進行視圖解析，找到我們要跳轉(zhuǎn)的視圖并進行視圖渲染的呢？

二、寫個demo

為了研究視圖解析原理，我們寫一個測試代碼

首先是控制器類IndexController.java

package com.decade.controller;
import com.decade.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import javax.servlet.http.HttpSession;
@Controller
public class IndexController {
    /**
     * 來登錄頁
     * @return 跳轉(zhuǎn)登錄頁
     */
    @GetMapping(value = {"/","/login"})
    public String loginPage(){
        return "login";
    }
    @PostMapping("/login")
    public String main(User user, HttpSession session, Model model){
        if(StringUtils.hasLength(user.getUserName()) && "123456".equals(user.getPassword())){
            //把登陸成功的用戶保存到session中
            session.setAttribute("loginUser", user);
            //登錄成功重定向到main.html;  重定向防止刷新首頁時表單重復提交
            return "redirect:/main.html";
        }else {
            model.addAttribute("msg","賬號密碼錯誤");
            //回到登錄頁面
            return "login";
        }
    }
    /**
     * 去main頁面
     * @return 跳轉(zhuǎn)主頁面
     */
    @GetMapping("/main.html")
    public String mainPage(HttpSession session,Model model){
        //是否登錄。  攔截器，過濾器
        Object loginUser = session.getAttribute("loginUser");
        if(loginUser != null){
            return "main";
        }else {
            //回到登錄頁面
            model.addAttribute("msg","請重新登錄");
            return "login";
        }
    }
}

login.html放于templates文件夾下

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
    <meta name="description" content="">
    <meta name="author" content="ThemeBucket">
    <link rel="shortcut icon" href="#" rel="external nofollow"  type="image/png">
    <title>Login</title>
    <link href="css/style.css" rel="external nofollow"  rel="stylesheet">
    <link href="css/style-responsive.css" rel="external nofollow"  rel="stylesheet">
    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
    <!--[if lt IE 9]>
    <script src="js/html5shiv.js"></script>
    <script src="js/respond.min.js"></script>
    <![endif]-->
</head>
<body class="login-body">
<div class="container">
    <form class="form-signin" action="index.html" method="post" th:action="@{/login}">
        <div class="form-signin-heading text-center">
            <h1 class="sign-title">Sign In</h1>
            <img src="images/login-logo.png" alt=""/>
        </div>
        <div class="login-wrap">
            <label style="color: red" th:text="${msg}"></label>
            <input type="text" name="userName" class="form-control" placeholder="User ID" autofocus>
            <input type="password" name="password" class="form-control" placeholder="Password">
            <button class="btn btn-lg btn-login btn-block" type="submit">
                <i class="fa fa-check"></i>
            </button>
            <div class="registration">
                Not a member yet?
                <a class="" href="registration.html" rel="external nofollow" >
                    Signup
                </a>
            </div>
            <label class="checkbox">
                <input type="checkbox" value="remember-me"> Remember me
                <span class="pull-right">
                    <a data-toggle="modal" href="#myModal" rel="external nofollow" > Forgot Password?</a>
                </span>
            </label>
        </div>
        <!-- Modal -->
        <div aria-hidden="true" aria-labelledby="myModalLabel" role="dialog" tabindex="-1" id="myModal" class="modal fade">
            <div class="modal-dialog">
                <div class="modal-content">
                    <div class="modal-header">
                        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
                        <h4 class="modal-title">Forgot Password ?</h4>
                    </div>
                    <div class="modal-body">
                        <p>Enter your e-mail address below to reset your password.</p>
                        <input type="text" name="email" placeholder="Email" autocomplete="off" class="form-control placeholder-no-fix">
                    </div>
                    <div class="modal-footer">
                        <button data-dismiss="modal" class="btn btn-default" type="button">Cancel</button>
                        <button class="btn btn-primary" type="button">Submit</button>
                    </div>
                </div>
            </div>
        </div>
        <!-- modal -->
    </form>
</div>
<script src="js/jquery-1.10.2.min.js"></script>
<script src="js/bootstrap.min.js"></script>
<script src="js/modernizr.min.js"></script>
</body>
</html>

三、流程解析

我們在登錄頁隨機輸入用戶名和錯誤的密碼，然后點擊登錄

我們跟蹤斷點，他還是進入到DispatcherServlet這個類下的doDispatch()方法

然后我們走到RequestMappingHandlerAdapter類下的handleInternal()—>invokeHandlerMethod()

設(shè)置參數(shù)解析器和返回值處理器

在這里，它就會走到ServletInvocableHandlerMethod類下的invokeAndHandle()方法，通過this.invokeForRequest(webRequest, mavContainer, providedArgs)去調(diào)用控制器類中的具體方法

我們發(fā)現(xiàn)，如果方法的參數(shù)是一個自定義類型對象（例如demo中的User），調(diào)用完具體方法后，我們會把他放在ModelAndViewContainer中

斷點繼續(xù)深入，我們走到了HandlerMethodReturnValueHandlerComposite類下的handleReturnValue()，這里它會使用this.selectHandler(returnValue, returnType)去獲取自己適合的返回值解析器

然后我們進入到ViewNameMethodReturnValueHandler這個返回值解析器

public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
    if (returnValue instanceof CharSequence) {
    	// 獲取視圖名稱
        String viewName = returnValue.toString();
        mavContainer.setViewName(viewName);
        // 判斷是否是重定向頁面
        if (this.isRedirectViewName(viewName)) {
            mavContainer.setRedirectModelScenario(true);
        }
    } else if (returnValue != null) {
        throw new UnsupportedOperationException("Unexpected return type: " + returnType.getParameterType().getName() + " in method: " + returnType.getMethod());
    }
}

重點：我們可以發(fā)現(xiàn)，目標方法處理的過程中，所有數(shù)據(jù)都會被放在 ModelAndViewContainer 里面。包括數(shù)據(jù)和視圖地址

經(jīng)過上述處理之后，我們返回到RequestMappingHandlerAdapter類中

ModelAndView var15 = this.getModelAndView(mavContainer, modelFactory, webRequest);

這行代碼會將ModelAndViewContainer 中的數(shù)據(jù)放到ModelAndView中

然后返回到DispatcherServlet這個類中，處理派發(fā)結(jié)果（頁面該如何響應）的關(guān)鍵代碼this.processDispatchResult(processedRequest, response, mappedHandler, mv, (Exception)dispatchException);

我們進入該方法進行分析

this.render(mv, request, response); 進行頁面渲染邏輯

String viewName = mv.getViewName();獲取視圖名稱

view = this.resolveViewName(viewName, mv.getModelInternal(), locale, request);循環(huán)遍歷當前系統(tǒng)中所有的視圖解析器嘗試是否能根據(jù)當前返回值得到View對象，符合條件的視圖解析器為ContentNegotiatingViewResolver（ContentNegotiationViewResolver 里面包含了下面所有的視圖解析器，內(nèi)部還是利用下面所有視圖解析器得到視圖對象），最后返回的視圖對象為ThymeleafView

下面是幾種不同返回值所對應的視圖對象

返回值以 forward: 開始： new InternalResourceView(forwardUrl); —> 轉(zhuǎn)發(fā)，底層為request.getRequestDispatcher(path).forward(request, response);
返回值以 redirect: 開始： new RedirectView() —> render底層就是重定向
返回值是普通字符串： new ThymeleafView（）—>通過對應的解析處理，并通過writer輸出流寫出到頁面