2022-02-17 二.全局统一返回处理

不爱吃奶昔（zsl0）

已于 2022-06-07 22:00:25 修改

阅读量513

点赞数

CC 4.0 BY-SA版权

分类专栏： # web开发规范文章标签： java mvc spring

于 2022-02-17 11:28:08 首次发布

本文链接：https://blog.csdn.net/qq_19152901/article/details/122979498

web开发规范专栏收录该内容

9 篇文章

订阅专栏

本文介绍了如何在Spring Boot中实现全局统一返回处理，通过@RestControllerAdvice注解创建一个处理类，将响应数据统一包装，避免在每个Controller方法中手动处理。同时，定义了@NotResponseBody注解用于标记不需要统一处理的方法。这种方法提高了代码的整洁性和可维护性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

统一返回值虽然很好用，但是在每个Controller曾的方法需要手动调用ResponseResult的静态方法，还是不够优雅，可以使用全局统一处理，统一到一个地方进行返回处理。

全局统一返回处理

处理类

package com.zsl.common.advice;

import com.zsl.common.annotation.NotResponseBody;
import com.zsl.common.http.ResponseResult;
import com.zsl.util.JsonUtils;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

/**
 * 全局处理返回数据
 * @Author zsl
 * @Date 2021/12/29 14:09
 */
@RestControllerAdvice(basePackages = "com.zsl.controller")  //扫描的包
public class ResponseControllerAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        // 返回 true则执行 beforeBodyWrite方法,
        // 返回类型不是 ResponseResult，且没有 @NotResponseBody注解，会执行
        return !methodParameter.getParameterType().equals(ResponseResult.class) && !methodParameter.hasMethodAnnotation(NotResponseBody.class);
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        // 若为 String类型，则直接返回 json字符串
        if (methodParameter.getGenericParameterType().equals(String.class)) {
            return JsonUtils.obj2Str(o);
        }
        return ResponseResult.success(o);
    }
}

注解

当我们不希望被统一返回处理时，添加@NotResponseBody注解进行跳过处理。

package com.zsl.common.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Author zsl
 * @Date 2022/2/17 11:07
 * @Email 249269610@qq.com
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotResponseBody {
}

例子

原先：

@RestController
public class XxxController {

	@Autowired
	XxxService xxxService;

	@RequestMapping("xxx")
	public ResponseResult xxx() {
		return ResponseResult.success(xxxService.xxx());
	}
}

现在：

@RestController
public class XxxController {

	@Autowired
	XxxService xxxService;

	@RequestMapping("xxx")
	public Xxx xxx() {
		return xxxService.xxx();
	}
}