Spring HandlerMethodReturnValueHandler接口

最新推荐文章于 2025-08-25 22:21:55 发布

原创最新推荐文章于 2025-08-25 22:21:55 发布 · 960 阅读

1 ·

CC 4.0 BY-SA版权

spring 专栏收录该内容

27 篇文章

订阅专栏

本文介绍了Spring中的HandlerMethodReturnValueHandler接口，用于处理RequestMapping处理后的方法返回值。通过自定义handler和定义controller类，可以实现特定的返回值处理逻辑。

接口介绍

HandlerMethodReturnValueHandler是RequestMappingHandlerAdapter用来处理完映射控制类，对方法返回的值进一步进行处理。

接口定义

/**
 * 策略模式接口：处理 Controller 方法返回值
 */
public interface HandlerMethodReturnValueHandler {

    /**
     * 该处理程序是否支持给定的方法返回类型(只有返回true才回去调用handleReturnValue)
     */
    boolean supportsReturnType(MethodParameter returnType);

    /**
     * 处理给定的返回值
     * 通过向 ModelAndViewContainer 添加属性和设置视图或者
     * 通过调用 ModelAndViewContainer.setRequestHandled(true) 来标识响应已经被直接处理(不再调用视图解析器)
     */
    void handleReturnValue(Object returnValue, MethodParameter returnType,
            ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception;

}

例子

在定义自己的handler

public class MyHandlerMethodReturnValueHandler implements HandlerMethodReturnValueHandler {
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        return returnType.getParameterType() == Person.class;
    }

    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        Assert.isInstanceOf(Person.class, returnValue);

        //标识请求是否已经在该方法内完成处理
        mavContainer.setRequestHandled(true);

        // 获取方法上的注解
        PersonAnnotation personAnnotation = returnType.getMethodAnnotation(PersonAnnotation.class);

        HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
        response.setContentType("text/plain;charset=UTF-8");
        Person person = (Person) returnValue;
        response.getWriter().println(personAnnotation.value() + ":" + person);

    }
}

定义controller类

@Controller
public class DemoController {
    @PersonAnnotation("person")
    @RequestMapping(value = "/demo", method = RequestMethod.GET)
    public Person getPerson() {
        return new Person("xiya", 25);
    }
}