正文

统一异常处理@controlleradvice+@exceptionhandler全局处理controller层异常(代码片段)

alanwilliamwalker  alanwilliamwalker  2023-01-22  415

关键词：

1.利用springmvc注解对Controller层异常全局处理

对于与数据库相关的 Spring MVC 项目，我们通常会把事务配置在 Service层，当数据库操作失败时让 Service 层抛出运行时异常，Spring 事物管理器就会进行回滚。

如此一来，我们的 Controller 层就不得不进行 try-catch Service 层的异常，否则会返回一些不友好的错误信息到客户端。但是，Controller 层每个方法体都写一些模板化的 try-catch 的代码，很难看也难维护，特别是还需要对 Service 层的不同异常进行不同处理的时候。

1.1优缺点

优点：将Controller层的异常和数据校验的异常进行统一异常处理，减少模板代码，减少代码量，提升扩展性和可维护性、
缺点：只能处理Controller层未捕获（从Servcie层抛过来）的异常，对于Interceptor（拦截器）层的异常，Spring框架层的异常，就无能为力了。

1.2基本使用

1.2.1@ControllerAdvice 注解定义全局异常处理类

首先，确保此类GlobalExceptionHandler 能被扫描到并装载进Spring容器中。

@ControllerAdvice
public class GlobalExceptionHandler

[email protected] 注解声明异常处理方法

@ControllerAdvice
public class GlobalExceptionHandler 

    @ExceptionHandler(Exception.class)
    @ResponseBody
    String handleException()
        return "Exception Deal!";

方法 handleException() 就会处理所有 Controller 层抛出的 Exception 及其子类的异常，这是最基本的用法了。

被 @ExceptionHandler 注解的方法的参数列表里，还可以声明很多种类型的参数，详见文档。其原型如下：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler 

    /**
     * Exceptions handled by the annotated method. If empty, will default to any
     * exceptions listed in the method argument list.
     */
    Class<? extends Throwable>[] value() default ;

如果 @ExceptionHandler 注解中未声明要处理的异常类型，则默认为参数列表中的异常类型。所以上面的写法，还可以写成这样：

@ControllerAdvice
public class GlobalExceptionHandler 

    @ExceptionHandler()
    @ResponseBody
    String handleException(Exception e)
        return "Exception Deal! " + e.getMessage();

参数对象就是 Controller 层抛出的异常对象！

1.3处理Service层上抛的业务异常

1.3.1代码示例

@ControllerAdvice
public class GlobalExceptionHandler 

    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 处理所有不可知的异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    AppResponse handleException(Exception e)
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail("操作失败！");
        return response;
    

    /**
     * 处理所有业务异常
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    AppResponse handleBusinessException(BusinessException e)
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail(e.getMessage());
        return response;

BusinessException属于业务自定义异常类

@RestController
@RequestMapping(value = "/dogs", consumes = MediaType.APPLICATION_JSON_UTF8_VALUE)
public class DogController 

    @Autowired
    private DogService dogService;

    @PatchMapping(value = "")
    Dog update(@Validated(Update.class) @RequestBody Dog dog)
        return dogService.update(dog);

这样Controller层就不需要进行异常处理了；

有时我们会在复杂带有数据库事务的业务中，当出现不和预期的数据时，直接抛出封装后的业务级运行时异常，进行数据库事务回滚，并希望该异常信息能被返回显示给用户。

我们可以使用自定义异常类可以针对具体业务处理异常；

Logger 进行所有的异常日志记录。

@ExceptionHandler(BusinessException.class) 声明了对 BusinessException 业务异常的处理，并获取该业务异常中的错误提示，构造后返回给客户端。

@ExceptionHandler(Exception.class) 声明了对 Exception 异常的处理，起到兜底作用，不管 Controller 层执行的代码出现了什么未能考虑到的异常，都返回统一的错误提示给客户端。

备注：以上 GlobalExceptionHandler 只是返回 Json 给客户端，更大的发挥空间需要按需求情况来做。
但是实际开发中并不这么做，因为返回的Response对象可能封装不同的数据，放在同一异常处理固然是方便，但是可能不实用；

1.4处理Controller数据绑定、数据校验的异常

在Dog类中的字段上的注解数据校验规则：

@Data
public class Dog 

    @NotNull(message = "Dog.id.non", groups = Update.class)
    @Min(value = 1, message = "Dog.age.lt1", groups = Update.class)
    private Long id;

    @NotBlank(message = "Dog.name.non", groups = Add.class, Update.class)
    private String name;

    @Min(value = 1, message = "Dog.age.lt1", groups = Add.class, Update.class)
    private Integer age;

说明：

说明：@NotNull、@Min、@NotBlank 这些注解的使用方法，不在本文范围内。如果不熟悉，请查找资料学习即可。

其他说明：
@Data 注解是 **Lombok** 项目的注解，可以使我们不用再在代码里手动加 getter & setter。
在 Eclipse 和 IntelliJ IDEA 中使用时，还需要安装相关插件，这个步骤自行Google/Baidu 吧！

Lombok 使用方法见：Java奇淫巧技之Lombok

基本使用：

SpringMVC 中对于 RESTFUL 的 Json 接口来说，数据绑定和校验，是这样的：

/**
 * 使用 GlobalExceptionHandler 全局处理 Controller 层异常的示例
 * @param dog
 * @return
 */
@PatchMapping(value = "")
AppResponse update(@Validated(Update.class) @RequestBody Dog dog)
    AppResponse resp = new AppResponse();

    // 执行业务
    Dog newDog = dogService.update(dog);

    // 返回数据
    resp.setData(newDog);

    return resp;

使用 @Validated + @RequestBody 注解实现。

当使用了 @Validated + @RequestBody 注解但是没有在绑定的数据对象后面跟上 Errors 类型的参数声明的话，Spring MVC 框架会抛出 MethodArgumentNotValidException 异常。

所以，在 GlobalExceptionHandler 中加上对 MethodArgumentNotValidException 异常的声明和处理，就可以全局处理数据校验的异常了！加完后的代码如下：

/**
 * Created by kinginblue on 2017/4/10.
 * @ControllerAdvice + @ExceptionHandler 实现全局的 Controller 层的异常处理
 */
@ControllerAdvice
public class GlobalExceptionHandler 

    private static final Logger LOGGER = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 处理所有不可知的异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    AppResponse handleException(Exception e)
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail("操作失败！");
        return response;
    

    /**
     * 处理所有业务异常
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    AppResponse handleBusinessException(BusinessException e)
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail(e.getMessage());
        return response;
    

    /**
     * 处理所有接口数据验证异常
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    AppResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
        LOGGER.error(e.getMessage(), e);

        AppResponse response = new AppResponse();
        response.setFail(e.getBindingResult().getAllErrors().get(0).getDefaultMessage());
        return response;

注意到了吗，所有的 Controller 层的异常的日志记录，都是在这个 GlobalExceptionHandler 中进行记录。也就是说，Controller 层也不需要在手动记录错误日志了。

其实，可以利用springaop进行拦截，然后记录日志，详情请看springaop【统一日志处理】相关文章。

1.5总结

其实，被 @ExceptionHandler 注解的方法还可以声明很多参数，详见文档。

@ControllerAdvice 也还可以结合 @InitBinder、@ModelAttribute 等注解一起使用，应用在所有被 @RequestMapping 注解的方法上，详见搜索引擎。

参考文章链接：

https://blog.csdn.net/kinginblue/article/details/70186586

@controlleradvice拦截异常并统一处理(代码片段)

在spring3.2中，新增了@ControllerAdvice注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。参考：@ControllerAdvice文档一、介绍创建MyControllerAdvice，并添加@ControllerAdvice注解。packagecom.sam 查看详情

@controlleradvice自定义异常统一处理(代码片段)

...户的某些操作不被允许，需要给用户提示。Spring提供了@ControllerAdvice这个注解，这个注解可以实现全局异常处理，全局数据绑定，全局数据预处理，这里主要说下使用这个注解实现全局异常处理。1.定义我们自己的业务异常ErrorCod... 查看详情

统一异常处理@controlleradvice+@exceptionhandler全局处理controller层异常(代码片段)

1.利用springmvc注解对Controller层异常全局处理对于与数据库相关的SpringMVC项目，我们通常会把事务配置在Service层，当数据库操作失败时让Service层抛出运行时异常，Spring事物管理器就会进行回滚。如此一来，我们的Controller层就不得... 查看详情

spring的@exceptionhandler和@controlleradvice统一处理异常

之前敲代码的时候,避免不了各种try..catch,如果业务复杂一点,就会发现全都是try…catchtry..........catch(Exception1e)..........catch(Exception2e)...........catch(Exception3e)...........这样其实代码既不简洁好看,我们敲着也烦,一般我们可能想到用... 查看详情

springboot-@controlleradvice拦截异常并统一处理

SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个WEB工程 ... 查看详情

谷粒商城-品牌管理-统一异常处理(代码片段)

...异常处理类对于项目中出现的异常，我们通常采用ControllerAdvice的方式进行统一处理，简化代码。1）、编写异常处理类，使用@ControllerAdvice。2）、使用@ExceptionHandler标注方法可以处理的异常。packagecom.xxh.... 查看详情

springboot2系列教程(十四)|统一异常处理

...的。SpringBoot中的全局异常处理主要起作用的两个注解是@ControllerAdvice和@ExceptionHandler，其中@ControllerAdvice是组件注解，添加了这个注解的类能够拦截Controller的请求，而ExceptionHandler注解可以设置全局处理控制里的异常类型来拦截要... 查看详情

restful接口调用统一异常处理(代码片段)

...,可对controller中被@RequestMapping注解的方法加一些逻辑处理@ControllerAdvice//异常定义@ExceptionHandler//返回格式为json,可以使用@RestControllerAdvice代替@ControllerAdvice,这样在方法上就可以不需要添加@ResponseBody@Respons 查看详情

java项目构建基础之统一异常

统一异常处理@ControllerAdvice该注解为统一异常处理的核心是一种作用于控制层的切面通知（Advice），该注解能够将通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一个类型，并应用到所有控制器上该类中的设计思路：使... 查看详情

springboot(十九)@controlleradvice+@exceptionhandler全局捕获controller异常

在spring3.2中，新增了@ControllerAdvice注解，可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。@ControllerAdvice官方文档。创建全局异常处理类：通过使用@ControllerAdvice定义统一的异常处理类，而不是在... 查看详情

springboot中@controlleradvice注解(代码片段)

SpringBoot中@ControllerAdvice@ControllerAdvice是Spring3.2提供的新注解，应用在处理全局异常、全局数据绑定、全局数据预处理等方面。我在一个SpringBoot项目中，处理全局异常，Controller类中的异常统一由ControllerExceptionHandl... 查看详情

springboot中的统一异常处理

请查看@ControllerAdvice、@ExceptionHandler和@RestControllerAdvice的注释 https://www.cnblogs.com/goloving/p/9142222.htmlhttps://yq.aliyun.com/articles/647428 查看详情

springboot全局异常统一处理(代码片段)

统一处理机制spring系统异常：@ControllerAdvice&@ExceptionHandlerhttp异常ErrorControllerServlet异常Filter1.SpringBoot默认错误统一处理机制在基于SpringBoot的Web应用中，对于Http请求处理过程中发生的各种错误，如常见的400、404... 查看详情

springboot中controller的统一异常处理

...eb应用例子为基础，进行统一异常处理的改造。通过使用@ControllerAdvice定义统一的异常处理类，而不是在每个Controller中逐个定义。@ExceptionHandler用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到error.html中。在templat... 查看详情

异常统一封装处理(代码片段)

（一）异常封装处理类用到的注解　　　　1）@ControllerAdvice　　　　2)　@ExceptionHandler （二）异常封装处理类用到的注解　　　　1异常枚举类　packagecom.atguigu.common.exception;/***10：通用*001：参数格式校验**11:商品*12：订单*13:购... 查看详情

spring的@controlleradvice注解(代码片段)

@ControllerAdvice注解是Spring3.2中新增的注解，学名是Controller增强器，作用是给Controller控制器添加统一的操作或处理。对于@ControllerAdvice，我们比较熟知的用法是结合@ExceptionHandler用于全局异常的处理，但其作用不止于此。ControllerAdv... 查看详情

@controlleradvice+@exceptionhandler全局处理controller层异常

@ControllerAdvice和@ExceptionHandler的区别ExceptionHandler,方法注解,作用于Controller级别.ExceptionHandler注解为一个Controler定义一个异常处理器.ControllerAdvice,类注解,作用于整个Spring工程.ControllerAdvice注解定义了一个全局的异常处理器.需要注意... 查看详情

springboot统一功能处理（用户登录权限效验-拦截器异常处理数据格式返回）(代码片段)

...理3.统一数据格式返回3.1统一数据格式返回的实现3.2@ControllerAdvice源码分析本篇将要学习SpringBoot统一功能处理模块，这也是AOP的实战环节统一用户登录权限的效验实现接口HandlerInterceptor+WebMvcConfigurer统一异常处理使用注... 查看详情