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注解的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Mybatis分页查询主从表的实现示例

    Mybatis分页查询主从表的实现示例

    本文主要介绍了Mybatis分页查询主从表的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-09-09
  • 小米推送Java代码

    小米推送Java代码

    今天小编就为大家分享一篇关于小米推送Java代码,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • servlet过滤器(Filter)详解(九)

    servlet过滤器(Filter)详解(九)

    这篇文章主要为大家详细介绍了servlet过滤器Filter的相关资料,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • Java Netty实现心跳机制过程解析

    Java Netty实现心跳机制过程解析

    这篇文章主要介绍了Java Netty实现心跳机制过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • java中string.trim()函数的作用实例及源码

    java中string.trim()函数的作用实例及源码

    这篇文章主要介绍了java中string.trim()函数的作用实例及源码,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • java实现上传文件到服务器和客户端

    java实现上传文件到服务器和客户端

    这篇文章主要为大家详细介绍了java实现上传文件到服务器和客户端,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • Java文件操作工具类fileUtil实例【文件增删改,复制等】

    Java文件操作工具类fileUtil实例【文件增删改,复制等】

    这篇文章主要介绍了Java文件操作工具类fileUtil,结合实例形式分析了java针对文件进行读取、增加、删除、修改、复制等操作的相关实现技巧,需要的朋友可以参考下
    2017-10-10
  • Spring框架JdbcTemplate数据库事务管理完全注解方式

    Spring框架JdbcTemplate数据库事务管理完全注解方式

    这篇文章主要介绍了Spring框架JdbcTemplate数据库事务管理及完全注解方式,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-05-05
  • 浅谈Java实现面向对象编程java oop

    浅谈Java实现面向对象编程java oop

    这篇文章主要介绍了浅谈Java实现面向对象编程java oop,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • 实战分布式医疗挂号系统之整合Swagger2到通用模块

    实战分布式医疗挂号系统之整合Swagger2到通用模块

    这篇文章主要为大家介绍了实战分布式医疗挂号系统之整合Swagger2到通用模块,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-04-04

最新评论