Spring MVC 自定义返回值处理器

前言

在 Spring MVC 中，返回值处理器 (HandlerMethodReturnValueHandler) 用于处理控制器方法的返回值，并将结果写入到 HTTP 响应中。通过自定义返回值处理器，我们可以定制返回数据的处理逻辑。

1. 自定义返回值处理器配置

首先，通过 addReturnValueHandlers 方法将自定义的返回值处理器添加到 Spring MVC 中：

@Override
public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> handlers) {
    // 注册自定义的返回值处理器
    handlers.add(myReturnValueHandler());
}

@Bean
public MyReturnValueHandler myReturnValueHandler() {
    // 创建自定义的返回值处理器实例
    return new MyReturnValueHandler();
}

• addReturnValueHandlers 方法：用于将自定义的返回值处理器添加到 Spring MVC 的处理器列表中。
• MyReturnValueHandler：这是自定义的返回值处理器，用于处理特定注解标记的方法返回值。

2. 实现自定义返回值处理器

实现 HandlerMethodReturnValueHandler 接口，并重写其两个核心方法：

public class MyReturnValueHandler implements HandlerMethodReturnValueHandler {

    @Override
    public boolean supportsReturnType(MethodParameter methodParameter) {
        // 判断当前方法是否带有自定义的 @ResponseData 注解
        return methodParameter.hasMethodAnnotation(ResponseData.class);
    }

    @Override
    public void handleReturnValue(Object returnValue, 
                                  MethodParameter methodParameter, 
                                  ModelAndViewContainer mavContainer, 
                                  NativeWebRequest webRequest) throws Exception {
        // 设置请求已处理，避免继续处理
        mavContainer.setRequestHandled(true);
        
        // 处理返回值，并将结果写入 HTTP 响应
        webRequest.getNativeResponse(HttpServletResponse.class)
                  .getWriter()
                  .write("自定义返回内容：" + returnValue.toString());
    }
}

• supportsReturnType 方法：判断当前方法是否适用于自定义处理器。这里通过判断方法上是否有自定义的 @ResponseData 注解来决定是否使用此处理器。
• handleReturnValue 方法：实现自定义的返回值处理逻辑。设置请求为已处理，并将自定义内容写入响应中。

3. 自定义注解 @ResponseData

为了让处理器识别特定方法，可以创建一个自定义注解：

@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ResponseData {
    // 自定义注解，用于标记需要通过自定义返回值处理器处理的方法
}

4. 测试控制器

创建一个简单的控制器方法并使用 @ResponseData 注解标记：

@RestController
public class TestController {

    @GetMapping("/test6")
    @ResponseData
    public String test6() {
        return "test6";
    }
}

• 访问地址：http://localhost:8080/test6
• 返回结果：自定义返回内容：test6

5. 返回值处理器未生效问题及解决方法

如果自定义的返回值处理器未生效，可能是由于默认的返回值处理器（如 RequestResponseBodyMethodProcessor）优先处理了返回值。通常这是因为 @RestController 或 @ResponseBody 注解已经占用了处理顺序。

原因分析

在 Spring MVC 的返回值处理流程中，返回值处理器按照注册顺序执行，默认处理器如 RequestResponseBodyMethodProcessor 通常会优先执行。如果自定义处理器排在它之后，则不会生效。

解决方案：调整处理器顺序

为了解决这个问题，可以将自定义的返回值处理器放在默认处理器之前。以下是两种实现方式：

方式1：实现 ApplicationContextAware 接口

@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
    RequestMappingHandlerAdapter adapter = applicationContext.getBean(RequestMappingHandlerAdapter.class);
    List<HandlerMethodReturnValueHandler> handlers = new ArrayList<>();
    handlers.add(myReturnValueHandler()); // 优先添加自定义的处理器
    handlers.addAll(adapter.getReturnValueHandlers()); // 添加其他默认处理器
    adapter.setReturnValueHandlers(handlers);
}

方式2：通过 @PostConstruct 注解进行初始化

@Autowired
private RequestMappingHandlerAdapter adapter;

@PostConstruct
public void initReturnValueHandlers() {
    List<HandlerMethodReturnValueHandler> handlers = new ArrayList<>();
    handlers.add(myReturnValueHandler()); // 优先添加自定义的处理器
    handlers.addAll(adapter.getReturnValueHandlers()); // 添加其他默认处理器
    adapter.setReturnValueHandlers(handlers);
}

6. 注意事项

• 调整返回值处理器顺序可能会影响 Spring MVC 的默认行为，需谨慎操作。
• 确保自定义处理器不会与已有的处理器冲突，尤其是在处理复杂的返回值类型时。

通过这种配置方式，Spring MVC 可以灵活地支持自定义的返回值处理逻辑，满足复杂的业务需求，同时保持代码的简洁性与可维护性。