SpringBoot中@ControllerAdvice注解的使用方法

 更新时间:2024年01月15日 10:26:39   作者:@红@旗下的小兵  
这篇文章主要介绍了SpringBoot中@ControllerAdvice注解的使用方法,这是一个增强的 Controller,对controller层做异常处理、数据预处理、全局数据绑定, springboot 会自动扫描到,不需要调用,这个注解是spring MVC提供的,在springboot中也可以使用,需要的朋友可以参考下

@ControllerAdvice注解的使用

这是一个增强的 Controller,对controller层做异常处理、数据预处理、全局数据绑定, springboot 会自动扫描到,不需要调用。

这个注解是spring MVC提供的,在springboot中也可以使用

全局异常处理

使用 @ControllerAdvice 注解,相当于开启了全局异常捕获,具体实现只需两步:

第一步:定义类,添加 @ControllerAdvice 注解,开启全局异常捕获;

第二步:在方法上,使用 @ExceptionHandler,定义捕获异常的类型即可。

@ControllerAdvice
public class ControllerExceptionHandler {
    /**
     * 校验的统一异常处理
     * @param e
     * @return ComResponse
     *
     * BindException 有针对性的,是校验不通过时,报的错误异常类做处理
     * Exception 对所有的报错异常做处理
     */
    @ExceptionHandler(value = {BindException.class})
    @ResponseBody
    public ComResponse validExceptionHandler(BindException e) {
        // 获取我们定义的校验失败的异常信息
        String msg = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
        ComResponse comResponse = new ComResponse<>();
        comResponse.setMsg(msg);
        comResponse.setSuccess(false);
        return comResponse;
    }
}

在该类中,你可以定义多个方法,不同方法吹不同的异常,只需要指定:@ExceptionHandler(value = {xxxException.class}),例如专门做空指针的处理方法,专门做数组越界的处理方法。 @ExceptionHandler 注解来指明异常的处理类型,上边例子中,指定BindException类型,那么除了参数校验抛出的异常,其他异常不会进这个方法中来。

关于@ControllerAdvice和@RestControllerAdvice区别:

在具体使用上,

1)注解有@ControllerAdvice的类, 需要在具体方法上同时添加@ExceptionHandler和@ResponseBody注解;

2)注解有@RestControllerAdvice的类,只需要在具体方法上添加@ExceptionHandler注解。

全局数据绑定

全局数据绑定功能可以用来做一些初始化数据的操作,我们可以将一些公共的数据定义在添加了 @ControllerAdvice 注解的类中,这样,在每一个 Controller 的接口中,就都能够访问导致这些数据。

使用 @ModelAttribute 注解标记该方法的返回数据是一个全局数据,默认情况下,这个全局数据的 key 就是返回的变量名,value 就是方法返回值,当然开发者可以通过 @ModelAttribute 注解的 name 属性去重新指定 key。

定义完成后,在任何一个Controller 的接口中,都可以获取到这里定义的数据:

定义:

@ControllerAdvice
public class Test {
    @ModelAttribute(name = "globalData")
    public Map<String, Object> setGlobalData() {
        Map<String, Object> map = new HashMap<>(){
            {
                put("username", "吕星辰");
                put("uid", 123);
            }
        };
        return map;
    }
}

获取全局数据

@RestController
public class UserController {
    @RequestMapping(value = "/test")
    public String userTest(Model model) {
        // 获取全局数据
        Map<String, Object> map = model.asMap();
        String json = JSON.toJSONString(map, SerializerFeature.PrettyFormat);
        System.out.println(json);
        return json;
    }
}

输出:

到此这篇关于SpringBoot中@ControllerAdvice注解的使用方法的文章就介绍到这了,更多相关@ControllerAdvice注解的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java设计模式之java责任链模式详解

    Java设计模式之java责任链模式详解

    这篇文章主要介绍了JAVA 责任链模式的的相关资料,文中讲解非常细致,代码帮助大家更好的理解和学习,感兴趣的朋友可以了解下
    2021-09-09
  • MyBatis-Plus中公共字段的统一处理的实现

    MyBatis-Plus中公共字段的统一处理的实现

    在开发中经常遇到多个实体类有共同的属性字段,这些字段属于公共字段,本文主要介绍了MyBatis-Plus中公共字段的统一处理的实现,具有一定的参考价值,感兴趣的可以了解一下
    2023-08-08
  • SpringBoot 整合Mybatis-Plus并输出SQL日志示例详解

    SpringBoot 整合Mybatis-Plus并输出SQL日志示例详解

    这篇文章主要介绍了SpringBoot整合Mybatis-Plus并输出SQL日志,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-06-06
  • 关于Java反编译字节码文件

    关于Java反编译字节码文件

    将高级语言翻译成汇编语言或机器语言的过程Java语言中的编译一般指将Java文件转换成class文件顾名思义反编译就是编译的逆向过程其实我们常用的开发工具(例如:IDEA、Eclipse)都带有反编译功能,需要的朋友可以参考下
    2023-05-05
  • springboot3.X版本集成mybatis遇到的问题及解决

    springboot3.X版本集成mybatis遇到的问题及解决

    在将SpringBoot3.X版本与MyBatis集成时,直接参考基于SpringBoot2.X的配置方法会导致各种报错,尤其是无法注入mapper的bean问题,这主要是因为SpringBoot3.X版本需要搭配MyBatis3.0.3及以上版本才能正常工作,通过更新maven配置至MyBatis3.0.3版本,可以解决这一问题
    2024-09-09
  • Java ClassCastException异常解决方案

    Java ClassCastException异常解决方案

    这篇文章主要介绍了Java ClassCastException异常解决方案,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • 通过Spring AOP实现异常捕捉机制

    通过Spring AOP实现异常捕捉机制

    在开发过程中,异常处理是一个不可忽视的重要环节,合理、优雅地处理异常不仅能提高代码的鲁棒性,还能提升系统的用户体验,本文将介绍如何通过Spring AOP实现一个高效的异常捕捉机制,使得异常处理变得更加优雅和统一,需要的朋友可以参考下
    2024-08-08
  • 详解Java分布式Session共享解决方案

    详解Java分布式Session共享解决方案

    这篇文章主要介绍了详解Java分布式Session共享解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • Java中的静态内部类详解及代码示例

    Java中的静态内部类详解及代码示例

    这篇文章主要介绍了Java中的静态内部类详解及代码示例,具有一定参考价值,需要的朋友可以了解下。
    2017-10-10
  • Springboot启动报错时实现异常定位

    Springboot启动报错时实现异常定位

    这篇文章主要介绍了Springboot启动报错时实现异常定位,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06

最新评论