用@ControllerAdvice和@ExceptionHandler来完成自定义异常类和自定义异常处理类的完美处理工作

最新推荐文章于 2024-08-05 21:06:44 发布

头发不会掉

最新推荐文章于 2024-08-05 21:06:44 发布

阅读量907

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/weixin_42765975/article/details/99207029

本文深入解析Spring框架中@ControllerAdvice和@ExceptionHandler注解的功能与使用，详细介绍如何通过自定义异常类和全局异常处理类实现对Controller层异常的统一管理和响应。

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

@ControllerAdice字面上的意思就是controller层的建议，我的理解就是controller层的返回值的建议，当出现不同的异常就返回不同值，这个不同值的返回就定义在被这个注解作用的类上
该注解作用对象为TYPE，包括类、接口和枚举等，在运行时有效，并且可以通过Spring扫描为bean组件。其可以包含由@ExceptionHandler、@InitBinder 和@ModelAttribute标注的方法，可以处理多个Controller类，这样所有控制器的异常可以在一个地方进行处理。
@ExceptionHandler
该注解作用对象为方法，并且在运行时有效，value()可以指定异常类。由该注解注释的方法可以具有灵活的输入参数（详细参见Spring API）：

异常参数：包括一般的异常或特定的异常（即自定义异常），如果注解没有指定异常类，会默认进行映射。
请求或响应对象 (Servlet API or Portlet API)：你可以选择不同的类型，如ServletRequest/HttpServletRequest或PortleRequest/ActionRequest/RenderRequest。
Session对象(Servlet API or Portlet API)： HttpSession或PortletSession。
WebRequest或NativeWebRequest
Locale
InputStream/Reader
OutputStream/Writer
Model
方法返回值可以为：

ModelAndView对象
Model对象
Map对象
View对象
String对象
还有@ResponseBody、HttpEntity<?>或ResponseEntity<?>，以及void

一旦controller层出现异常这个注解就会起作用
自定义异常类MyException.java

public class MyException extends RuntimeException {

    private static final long serialVersionUID = 5720848396842316463L;

    private int code;

    public MyException(int code, String message ) {
        super(message);
        this.code = code;
    }

    public MyException(ResultEnum resultEnum) {
        super(resultEnum.getMsg());
        this.code = resultEnum.getCode();
    }
    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }


}

全局异常处理类GlobalExceptionHandle.java

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Result handle(Exception e) {
        e.printStackTrace();
        if(e instanceof MyException) {
            MyException myException = (MyException)e;
            return ResultUtil.error(myException.getCode(),myException.getMessage());
        }else{
            return ResultUtil.error(ResultEnum.UNKNOWN_ERROR.getCode(), ResultEnum.UNKNOWN_ERROR.getMsg());

        }
    }

}

参考实例