Controller handler方法支持返回类型

时间:2013-08-14 21:15:58

标签: java spring spring-mvc

在学习Spring框架时,我注意到在 Spring in Action 一书中,作者没有在控制器中使用ModelandView方法返回类型。作者声明控制器方法为String的返回类型,方法中的return子句只返回一个字符串,如return "/views/theview";

有人可以详细说明其工作原理的内部差异吗?

3 个答案:

答案 0 :(得分:4)

这是深入了解。

Spring提供了一个DispatcherServlet类,通常可以处理您的所有请求。它在doDispatch(HttpServletRequest request, HttpServletResponse response)方法

中执行此操作
// Actually invoke the handler.
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());

其中mv是最终的ModelAndView对象,ha是使用@RequestMapping注释的控制器方法的包装。

这通常会经过一堆结束于ServletInvocableHandlerMethod.invokeAndHandle

的方法调用
at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle
at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandleMethod
at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal
at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle
at org.springframework.web.servlet.DispatcherServlet.doDispatch

查看来源

public final void invokeAndHandle(ServletWebRequest webRequest,
                ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {

    Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs);

    setResponseStatus(webRequest);

    if (returnValue == null) {
        if (isRequestNotModified(webRequest) || hasResponseStatus() || mavContainer.isRequestHandled()) {
            mavContainer.setRequestHandled(true);
            return;
        }
    } else if (StringUtils.hasText(this.responseReason)) {
        mavContainer.setRequestHandled(true);
        return;
    }

    mavContainer.setRequestHandled(false);

    try {
        this.returnValueHandlers.handleReturnValue(returnValue, getReturnValueType(returnValue), mavContainer, webRequest);
    }
    catch (Exception ex) {
        if (logger.isTraceEnabled()) {
            logger.trace(getReturnValueHandlingErrorMessage("Error handling return value", returnValue), ex);
        }
        throw ex;
    }
}

returnValue是您的@RequestMapping方法返回的对象。它经历了

this.returnValueHandlers.handleReturnValue

其中Spring确定HandlerMethodReturnValueHandler来处理该对象。

public void handleReturnValue(
        Object returnValue, MethodParameter returnType,
        ModelAndViewContainer mavContainer, NativeWebRequest webRequest)
        throws Exception {

    HandlerMethodReturnValueHandler handler = getReturnValueHandler(returnType); // returns the appropriate handler
    Assert.notNull(handler, "Unknown return value type [" + returnType.getParameterType().getName() + "]");
    handler.handleReturnValue(returnValue, returnType, mavContainer, webRequest);
}

getReturnValueHandler(returnType);返回适当的处理程序。 HandlerMethodReturnValueHandler是一个supportsReturnType方法的接口,如果处理程序支持该类型(trueStringView,{ResponseEntity,则返回HandlerMethodReturnValueHandler {3}})。因此,该方法返回它找到的第一个支持该类型并运行它的处理程序。

Spring在初始化时注册了Model的大量实现。基本上所有etc. (look for supported return types)

例如,如果返回一个String,Spring将使用known implementing classes in its javadoc来处理响应。

现在,要使用哪种返回类型取决于您。如果您想返回Model以便在jsp视图中使用请求属性,可以让Spring将Model实例传递给您的方法,也可以自己创建ModelAndView对象并将其传递给您返回的{{1}}。在大多数情况下,这是一种风格问题。

答案 1 :(得分:0)

功能明智没有区别,这些都是等价的:

@RequestMapping(..)
public String requestMapping1(Model model){
    model.addAttribute("attr1", attr1);
    return "viewName";
}

@RequestMapping(..)
public ModelAndView requestMapping2(){
    ModelAndView modelAndView = new ModelAndView("viewName");
    modelAndView.addObject("attr1", attr1);
    return modelAndView;
}

然而,首选的方法是前者,这就是为什么作者没有在书样本中使用后者的原因。

答案 2 :(得分:0)

在Spring源代码中,您可以看到此类org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter。在方法public ModelAndView getModelAndView(...)中,您可以了解sping-mvc如何生成ModelAandView对象。

if (returnValue instanceof HttpEntity) { // returnValue is returned Value of Handler method
            handleHttpEntityResponse((HttpEntity<?>) returnValue, webRequest);
            return null;
        }
        else if (AnnotationUtils.findAnnotation(handlerMethod, ResponseBody.class) != null) {
            handleResponseBody(returnValue, webRequest);
            return null;
        }
        else if (returnValue instanceof ModelAndView) {
            ModelAndView mav = (ModelAndView) returnValue;
            mav.getModelMap().mergeAttributes(implicitModel);
            return mav;
        }
        else if (returnValue instanceof Model) {
            return new ModelAndView().addAllObjects(implicitModel).addAllObjects(((Model) returnValue).asMap());
        }
        else if (returnValue instanceof View) {
            return new ModelAndView((View) returnValue).addAllObjects(implicitModel);
        }
        else if (AnnotationUtils.findAnnotation(handlerMethod, ModelAttribute.class) != null) {
            addReturnValueAsModelAttribute(handlerMethod, handlerType, returnValue, implicitModel);
            return new ModelAndView().addAllObjects(implicitModel);
        }
        else if (returnValue instanceof Map) {
            return new ModelAndView().addAllObjects(implicitModel).addAllObjects((Map) returnValue);
        }
        else if (returnValue instanceof String) { // String is here, return new ModelAndView
            return new ModelAndView((String) returnValue).addAllObjects(implicitModel);
        }

因此,在这个方法中,您可以了解spring-mvc可以处理许多返回类型的处理程序方法来构建ModleAndView对象。