精盡Spring MVC源碼分析 – RequestToViewNameTranslator 組件
- 2020 年 12 月 22 日
- 筆記
- Spring MVC, 源碼解析, 精盡Spring MVC源碼分析
該系列文檔是本人在學習 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 就提供一個實現類：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() + "]");
}
}
}
-
獲得 Bean 名稱為 “viewNameTranslator”，類型為 RequestToViewNameTranslator 的 Bean ，將其設置為
viewNameTranslator -
如果未獲得到，則獲得默認配置的 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;
}
- 通過
urlPathHelper獲取該請求的請求路徑 - 調用
transformPath(String lookupPath)方法，獲得視圖名，並添加前後綴（默認都是空的）。實際上就是你的請求 URI
總結
本文對 Spring MVC 的RequestToViewNameTranslator 組件進行了分析，視圖名稱轉換器，用於解析出請求的默認視圖名。當 ModelAndView 對象不為 null，但是它的 View 對象為 null，則需要通過 RequestToViewNameTranslator 組件根據請求解析出一個默認的視圖名稱。默認的 DefaultRequestToViewNameTranslator 實現類返回的就是請求的 URI。
我們目前最常用的 @ResponseBody 註解，對應的 RequestResponseBodyMethodProcessor 返回值處理器，所得到的 ModelAndView 對象為 null，所以不會用到該組件，也不會進行視圖渲染，前後端分離嘛~
很輕鬆~ 哈哈
參考文章：芋道源碼《精盡 Spring MVC 源碼分析》
