← 返回学习路线

SYSTEM

视图解析

Java基础视图解析system
src/content/notes/system/视图解析.md

视图解析

返回解析

请求处理:

@GetMapping("/params")
public String param(){
	return "forward:/success";
    //return "redirect:/success";
}

进入执行方法逻辑 ServletInvocableHandlerMethod#invokeAndHandle,进入 this.returnValueHandlers.handleReturnValue:

public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType,
                              ModelAndViewContainer mavContainer, NativeWebRequest webRequest)  {
	// 获取合适的返回值处理器:调用 if (handler.supportsReturnType(returnType))判断是否支持
    HandlerMethodReturnValueHandler handler = selectHandler(returnValue, returnType);
    if (handler == null) {
        throw new IllegalArgumentException();
    }
    // 使用处理器处理返回值
    handler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
}
  • ViewNameMethodReturnValueHandler#supportsReturnType:

    public boolean supportsReturnType(MethodParameter returnType) {
        Class<?> paramType = returnType.getParameterType();
        // 返回值是否是 void 或者是 CharSequence 字符序列,这里是字符序列
        return (void.class == paramType || CharSequence.class.isAssignableFrom(paramType));
    }
  • ViewNameMethodReturnValueHandler#handleReturnValue:

    public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType,
                                  ModelAndViewContainer mavContainer, 
                                  NativeWebRequest webRequest) throws Exception {
    	// 返回值是字符串,是 return "forward:/success"
        if (returnValue instanceof CharSequence) {
            String viewName = returnValue.toString();
            // 【把视图名称设置进入 ModelAndViewContainer 中】
            mavContainer.setViewName(viewName);
            // 判断是否是重定向数据 `viewName.startsWith("redirect:")`
            if (isRedirectViewName(viewName)) {
                // 如果是重定向,设置是重定向指令
                mavContainer.setRedirectModelScenario(true);
            }
        }
        else if (returnValue != null) {
            // should not happen
            throw new UnsupportedOperationException();
        }
    }

结果派发

doDispatch() 中的 processDispatchResult:处理派发结果

private void processDispatchResult(HttpServletRequest request, HttpServletResponse response,
                                   @Nullable HandlerExecutionChain mappedHandler, 
                                   @Nullable ModelAndView mv,
                                   @Nullable Exception exception) throws Exception {
    boolean errorView = false;
    if (exception != null) {
    }
    // mv 是 ModelAndValue
    if (mv != null && !mv.wasCleared()) {
        // 渲染视图
        render(mv, request, response);
        if (errorView) {
            WebUtils.clearErrorRequestAttributes(request);
        }
    }
    else {}  
}

DispatcherServlet#render:

  • Locale locale = this.localeResolver.resolveLocale(request):国际化相关

  • String viewName = mv.getViewName():视图名字,是请求转发 forward:/success(响应数据解析并存入 ModelAndView)

  • view = resolveViewName(viewName, mv.getModelInternal(), locale, request):解析视图

    • for (ViewResolver viewResolver : this.viewResolvers):遍历所有的视图解析器

      view = viewResolver.resolveViewName(viewName, locale):根据视图名字解析视图,调用内容协商视图处理器 ContentNegotiatingViewResolver 的方法

      • attrs = RequestContextHolder.getRequestAttributes():获取请求的相关属性信息

      • requestedMediaTypes = getMediaTypes(((ServletRequestAttributes) attrs).getRequest()):获取最佳匹配的媒体类型,函数内进行了匹配的逻辑

      • candidateViews = getCandidateViews(viewName, locale, requestedMediaTypes):获取候选的视图对象

        • for (ViewResolver viewResolver : this.viewResolvers):遍历所有的视图解析器

        • View view = viewResolver.resolveViewName(viewName, locale):解析视图

          AbstractCachingViewResolver#resolveViewName:

          • returnview = createView(viewName, locale):UrlBasedViewResolver#createView

            请求转发:实例为 InternalResourceView

            • if (viewName.startsWith(FORWARD_URL_PREFIX)):视图名字是否是 forward: 的前缀

            • forwardUrl = viewName.substring(FORWARD_URL_PREFIX.length()):名字截取前缀

            • view = new InternalResourceView(forwardUrl):新建 InternalResourceView 对象并返回

            • return applyLifecycleMethods(FORWARD_URL_PREFIX, view):Spring 中的初始化操作

            重定向:实例为 RedirectView

            • if (viewName.startsWith(REDIRECT_URL_PREFIX)):视图名字是否是 redirect: 的前缀
            • redirectUrl = viewName.substring(REDIRECT_URL_PREFIX.length()):名字截取前缀
            • RedirectView view = new RedirectView():新建 RedirectView 对象并返回
      • bestView = getBestView(candidateViews, requestedMediaTypes, attrs):选出最佳匹配的视图对象

  • view.render(mv.getModelInternal(), request, response):页面渲染

    • mergedModel = createMergedOutputModel(model, request, response):把请求域中的数据封装到 model

    • prepareResponse(request, response):响应前的准备工作,设置一些响应头

    • renderMergedOutputModel(mergedModel, getRequestToExpose(request), response):渲染输出的数据

      getRequestToExpose(request):获取 Servlet 原生的方式

      请求转发 InternalResourceView 的逻辑:请求域中的数据不丢失

      • exposeModelAsRequestAttributes(model, request):暴露 model 作为请求域的属性
        • model.forEach():遍历 Model 中的数据
        • request.setAttribute(name, value):设置到请求域中
      • exposeHelpers(request):自定义接口
      • dispatcherPath = prepareForRendering(request, response):确定调度分派的路径,此例是 /success
      • rd = getRequestDispatcher(request, dispatcherPath):获取 Servlet 原生的 RequestDispatcher 实现转发
      • rd.forward(request, response):实现请求转发

      重定向 RedirectView 的逻辑:请求域中的数据会丢失

      • targetUrl = createTargetUrl(model, request):获取目标 URL
        • enc = request.getCharacterEncoding():设置编码 UTF-8
        • appendQueryProperties(targetUrl, model, enc):添加一些属性,比如 url + ?name=123&&age=324
      • sendRedirect(request, response, targetUrl, this.http10Compatible):重定向
        • response.sendRedirect(encodedURL):使用 Servlet 原生方法实现重定向