使用ControllerAdvice注解来进行全局数据处理

最新推荐文章于 2024-05-11 11:10:27 发布

原创最新推荐文章于 2024-05-11 11:10:27 发布 · 393 阅读

0 ·

CC 4.0 BY-SA版权

SpringBoot 专栏收录该内容

5 篇文章

订阅专栏

该博客介绍了如何使用@ControllerAdvice注解来实现全局异常处理、数据绑定和数据预处理。通过定义一个全局响应类，可以拦截所有Controller的返回值，并根据需求进行定制化的包装。在beforeBodyWrite方法中，如果Controller返回的是特定类型（如Result），则不再进行额外的封装，否则会调用Result.buildSuccess()进行成功响应的构建。

@ControllerAdvice ，这是一个增强的 Controller。使用这个 Controller ，可以实现三个方面的功能：

全局异常处理
全局数据绑定
全局数据预处理

处理所有controller返回的数据

//定义一个全局的响应
//@ControllerAdvice,所有的Controller只要执行，这个地方就会得到通知
@ControllerAdvice(value = {"com.hubu.controller"})
public class GlobalResponse implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> aClass) {
        //获取当所执行的Controller对象的class类型的对象，它是整个反射的入口，通过class类型的对象我们拿到一切的对象
        Class<? extends Executable> clazz = returnType.getExecutable().getClass();
        //获取类头顶的@IgnoreWrapper这个注解，但是用户可能没有加上
        IgnoreWrapper annotation = clazz.getAnnotation(IgnoreWrapper.class);
        if (null == annotation){
            //这里其实就是拿Method类型的对象，Method继承了Executable
            Executable executable = returnType.getExecutable();
            IgnoreWrapper iw = executable.getAnnotation(IgnoreWrapper.class);
            if (null == iw){
                return true; //进入beforeBodyWrite方法
            }
            return false;
        }else {
            return false;  //返回false，不会对我们的返回值进行二次包装
        }
    }

    //我们需要关注的是该方法的返回值类型，第一个参数是controller的返回值
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        /**
         * 目的：当Controller中方法的返回值是Result，就没有必要通过Result进行封装了*
         */
        Method method = (Method) returnType.getExecutable();
        if (Result.class == method.getReturnType()){
            return body;
        }
        return Result.buildSuccess(body);
    }
}