精盡Spring MVC原始碼分析 - RequestToViewNameTranslator 元件

月圓吖發表於2020-12-22
SpringMVC原始碼View元件

該系列文件是本人在學習 Spring MVC 的原始碼過程中總結下來的，可能對讀者不太友好，請結合我的原始碼註釋 Spring MVC 原始碼分析 GitHub 地址 進行閱讀

Spring 版本：5.2.4.RELEASE

該系列其他文件請檢視：《精盡 Spring MVC 原始碼分析 - 文章導讀》

RequestToViewNameTranslator 元件

RequestToViewNameTranslator 元件，檢視名稱轉換器，用於解析出請求的預設檢視名。就是說當 ModelAndView 物件不為 null，但是它的 View 物件為 null，則需要通過 RequestToViewNameTranslator 元件根據請求解析出一個預設的檢視名稱。

回顧

先來回顧一下在 DispatcherServlet 中處理請求的過程中哪裡使用到 RequestToViewNameTranslator 元件，可以回到《一個請求的旅行過程》中的 DispatcherServlet 的 doDispatch 方法中看看，如下：

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    HttpServletRequest processedRequest = request;
    try {
        ModelAndView mv = null;
        try {
            // ... 省略相關程式碼
            
            // <6> 真正的呼叫 handler 方法，也就是執行對應的方法，並返回檢視
            mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
            
            // ... 省略相關程式碼
            
            // <8> 無檢視的情況下設定預設檢視名稱
            applyDefaultViewName(processedRequest, mv);
            
            // ... 省略相關程式碼
        }
        catch (Exception ex) {
            dispatchException = ex; // <10> 記錄異常
        }
        // <11> 處理正常和異常的請求呼叫結果
        processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
    catch (Exception ex) { // <12> 已完成處理 攔截器 }
    finally { }
}

private void applyDefaultViewName(HttpServletRequest request, @Nullable ModelAndView mv) throws Exception {
    if (mv != null && !mv.hasView()) {
        String defaultViewName = getDefaultViewName(request);
        if (defaultViewName != null) {
            mv.setViewName(defaultViewName);
        }
    }
}

@Nullable
protected String getDefaultViewName(HttpServletRequest request) throws Exception {
    return (this.viewNameTranslator != null ? this.viewNameTranslator.getViewName(request) : null);
}

在上面方法的<8>處，會呼叫 applyDefaultViewName(HttpServletRequest request, @Nullable ModelAndView mv) 方法，如果返回的 ModelAndView 物件不為 null，但是他的 View 物件為 null，則需要通過 viewNameTranslator 的 getViewName(HttpServletRequest request) 方法，從請求中獲取預設的檢視名，如果獲取到了則設定到 ModelAndView 物件中

applyDefaultViewName(HttpServletRequest request, @Nullable ModelAndView mv) 這個方法還會在處理異常的時候呼叫，因為處理異常也返回 ModelAndView 物件，所以需要做“類似”的處理

RequestToViewNameTranslator 介面

org.springframework.web.servlet.RequestToViewNameTranslator，檢視名稱轉換器，用於解析出請求的預設檢視名，程式碼如下：

public interface RequestToViewNameTranslator {
	/**
	 * 根據請求，獲得其檢視名
	 */
	@Nullable
	String getViewName(HttpServletRequest request) throws Exception;
}

RequestToViewNameTranslator 介面體系的結構如下：

精盡Spring MVC原始碼分析 - RequestToViewNameTranslator 元件

Spring MVC 就提供一個實現類：org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator

我看了一下，Spring Boot 沒有提供其他的實現類

初始化過程

在 DispatcherServlet 的 initRequestToViewNameTranslator(ApplicationContext context) 方法，初始化 RequestToViewNameTranslator 元件，方法如下：

private void initRequestToViewNameTranslator(ApplicationContext context) {
    try {
        this.viewNameTranslator =
                context.getBean(REQUEST_TO_VIEW_NAME_TRANSLATOR_BEAN_NAME, RequestToViewNameTranslator.class);
        if (logger.isTraceEnabled()) {
            logger.trace("Detected " + this.viewNameTranslator.getClass().getSimpleName());
        }
        else if (logger.isDebugEnabled()) {
            logger.debug("Detected " + this.viewNameTranslator);
        }
    }
    catch (NoSuchBeanDefinitionException ex) {
        // We need to use the default.
        /**
         * 如果未找到，則獲取預設的 RequestToViewNameTranslator 物件
         * {@link org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator}
         */
        this.viewNameTranslator = getDefaultStrategy(context, RequestToViewNameTranslator.class);
        if (logger.isTraceEnabled()) {
            logger.trace("No RequestToViewNameTranslator '" + REQUEST_TO_VIEW_NAME_TRANSLATOR_BEAN_NAME +
                    "': using default [" + this.viewNameTranslator.getClass().getSimpleName() + "]");
        }
    }
}

  1. 獲得 Bean 名稱為 "viewNameTranslator"，型別為 RequestToViewNameTranslator 的 Bean ，將其設定為 viewNameTranslator

  2. 如果未獲得到，則獲得預設配置的 RequestToViewNameTranslator 實現類，呼叫 getDefaultStrategies(ApplicationContext context, Class<T> strategyInterface) 方法，就是從 DispatcherServlet.properties 檔案中讀取 RequestToViewNameTranslator 的預設實現類，如下：

    org.springframework.web.servlet.RequestToViewNameTranslator=org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator

DefaultRequestToViewNameTranslator

org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator 實現 RequestToViewNameTranslator 介面，預設且是唯一的 RequestToViewNameTranslator 實現類

構造方法

public class DefaultRequestToViewNameTranslator implements RequestToViewNameTranslator {

	private static final String SLASH = "/";
	/**
	 * 字首
	 */
	private String prefix = "";
	/**
	 * 字尾
	 */
	private String suffix = "";
	/**
	 * 分隔符
	 */
	private String separator = SLASH;
	/**
	 * 是否移除開頭 {@link #SLASH}
	 */
	private boolean stripLeadingSlash = true;
	/**
	 * 是否移除末尾 {@link #SLASH}
	 */
	private boolean stripTrailingSlash = true;
	/**
	 * 是否移除擴充名
	 */
	private boolean stripExtension = true;
	/**
	 * URL 路徑工具類
	 */
	private UrlPathHelper urlPathHelper = new UrlPathHelper();
}

getViewName

實現 getViewName(HttpServletRequest request) 方法，程式碼如下：

@Override
public String getViewName(HttpServletRequest request) {
    // 獲得請求路徑
    String lookupPath = this.urlPathHelper.getLookupPathForRequest(request);
    // 獲得檢視名
    return (this.prefix + transformPath(lookupPath) + this.suffix);
}

@Nullable
protected String transformPath(String lookupPath) {
    String path = lookupPath;
    // 移除開頭 SLASH
    if (this.stripLeadingSlash && path.startsWith(SLASH)) {
        path = path.substring(1);
    }
    // 移除末尾 SLASH
    if (this.stripTrailingSlash && path.endsWith(SLASH)) {
        path = path.substring(0, path.length() - 1);
    }
    // 移除擴充名
    if (this.stripExtension) {
        path = StringUtils.stripFilenameExtension(path);
    }
    // 替換分隔符
    if (!SLASH.equals(this.separator)) {
        path = StringUtils.replace(path, SLASH, this.separator);
    }
    return path;
}
  1. 通過 urlPathHelper 獲取該請求的請求路徑
  2. 呼叫 transformPath(String lookupPath) 方法，獲得檢視名，並新增前字尾（預設都是空的）。實際上就是你的請求 URI

總結

本文對 Spring MVC 的RequestToViewNameTranslator 元件進行了分析，檢視名稱轉換器，用於解析出請求的預設檢視名。當 ModelAndView 物件不為 null，但是它的 View 物件為 null，則需要通過 RequestToViewNameTranslator 元件根據請求解析出一個預設的檢視名稱。預設的 DefaultRequestToViewNameTranslator 實現類返回的就是請求的 URI。

我們目前最常用的 @ResponseBody 註解，對應的 RequestResponseBodyMethodProcessor 返回值處理器，所得到的 ModelAndView 物件為 null，所以不會用到該元件，也不會進行檢視渲染，前後端分離嘛~

很輕鬆~ 哈哈 ?

參考文章：芋道原始碼《精盡 Spring MVC 原始碼分析》

相關文章