SpringBoot 中的异常统一处理

最新推荐文章于 2024-08-20 10:27:21 发布
最新推荐文章于 2024-08-20 10:27:21 发布
阅读量369 收藏 1
点赞数
分类专栏： 日常笔记 文章标签： java spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_37225642/article/details/106445300
版权

异常的统一处理可以显著提升用户提升体验，也可以方便开发人员发现程序问题所在。

服务器端的异常如果不能返回给客户，会让客户端的使用感觉很糟糕，比如常见的 500 错误，客户端看到的是：
常见的500页面

然后一头雾水，用户难免会想这系统这么烂？

如果我们把异常信息返回给前台，让前端进行处理，比如弹窗，用户了解到错误信息后，进而修改错误使用行为或者联系开发人员解决。

异常统一处理也不只有一种方法，本篇通过 Springboot 使用 @ControllerAdvice 和 @ExceptionHandler 两个注解来实现异常的统一处理。

1. 添加依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.auth0/java-jwt -->
        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>3.5.0</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.47</version>
        </dependency>

2. 创建异常接口和实现它的异常信息枚举类

通过接口可以很方便的获取枚举类中的信息。

BaseErrorInfoInterface 接口：

public interface BaseErrorInfoInterface {
    /**
     * 错误码
     */
    String getResultCode();

    /**
     * 错误描述
     */
    String getResultMsg();
}

异常信息枚举类 CommonEnum ：

public enum CommonEnum implements BaseErrorInfoInterface {
    // 数据操作错误定义
    SUCCESS("200", "成功!"),
    BODY_NOT_MATCH("400", "请求的数据格式不符!"),
    SIGNATURE_NOT_MATCH("401", "请求的数字签名不匹配!"),
    NOT_FOUND("404", "未找到该资源!"),
    INTERNAL_SERVER_ERROR("500", "服务器内部错误!"),
    SERVER_BUSY("503", "服务器正忙，请稍后再试!");

    /**
     * 错误码
     */
    private String resultCode;

    /**
     * 错误描述
     */
    private String resultMsg;

    CommonEnum(String resultCode, String resultMsg) {
        this.resultCode = resultCode;
        this.resultMsg = resultMsg;
    }

    @Override
    public String getResultCode() {
        return resultCode;
    }

    @Override
    public String getResultMsg() {
        return resultMsg;
    }

}

使用枚举类可以规范异常信息，防止不同的开发人员同一个异常，各有各的写法。

3. 创建返回结果统一处理包装类

无论是正常数据还是异常数据，统统用一个返回结果类包装起来，并通过 fastJSON 转为 json 对象。

创建返回结果类 BaseResult ：

@Getter
@Setter
@AllArgsConstructor
public class BaseResult implements Serializable {

    private static final long serialVersionUID = 1L;
    public static final int RESULT_FAIL = 0;
    public static final int RESULT_SUCCESS = 1;

    //返回代码
    private String code;

    //返回消息
    private String message;

    //返回对象
    private Object result;

    /**
     * 构造重载
     * @param code
     * @param message
     */
    public BaseResult(String code, String message) {
        this.code = code;
        this.message = message;
    }

    /**
     * 成功
     *
     * @return
     */
    public static BaseResult success() {
        return success(null);
    }

    /**
     * 成功
     *
     * @param data
     * @return
     */
    public static BaseResult success(Object data) {
        //枚举在这里就用上了
        BaseResult br = new BaseResult(CommonEnum.SUCCESS.getResultCode(), CommonEnum.SUCCESS.getResultMsg(), data);
        return br;
    }

    /**
     * 失败
     *
     * @param errorInfoInterface
     * @return
     */
    public static BaseResult error(BaseErrorInfoInterface errorInfoInterface) {
        BaseResult br = new BaseResult(errorInfoInterface.getResultCode(), errorInfoInterface.getResultMsg(), null);
        return br;
    }

    /**
     * 失败
     *
     * @param code
     * @param message
     * @return
     */
    public static BaseResult error(String code, String message) {
        BaseResult br = new BaseResult(code, message, null);
        return br;
    }

    /**
     * 失败
     *
     * @param message
     * @return
     */
    public static BaseResult error(String message) {
        BaseResult br = new BaseResult("-1", message, null);
        return br;
    }

    public String toString() {
        return JSONObject.toJSONString(this);
    }
}

4. 创建自定义业务异常类，继承 RuntimeException 类

BizException 类（biz=business）：

@Getter
@Setter
public class BizException extends RuntimeException {

    private static final long serialVersionUID = 1L;

    /**
     * 错误码
     */
    protected String errorCode;
    /**
     * 错误信息
     */
    protected String errorMsg;

    /**
     * 无参构造
     */
    public BizException() {
        super();
    }

    /**
     * BaseErrorInfoInterface 参数构造
     * @param errorInfoInterface
     */
    public BizException(BaseErrorInfoInterface errorInfoInterface) {
        super(errorInfoInterface.getResultCode());
        this.errorCode = errorInfoInterface.getResultCode();
        this.errorMsg = errorInfoInterface.getResultMsg();
    }

    /**
     * BaseErrorInfoInterface，Throwable 参数构造
     * @param errorInfoInterface
     * @param cause
     */
    public BizException(BaseErrorInfoInterface errorInfoInterface, Throwable cause) {
        super(errorInfoInterface.getResultCode(), cause);
        this.errorCode = errorInfoInterface.getResultCode();
        this.errorMsg = errorInfoInterface.getResultMsg();
    }

    /**
     * 错误信息参数构造
     * @param errorMsg
     */
    public BizException(String errorMsg) {
        super(errorMsg);
        this.errorMsg = errorMsg;
    }

    /**
     * 错误信息、编码 参数构造
     * @param errorCode
     * @param errorMsg
     */
    public BizException(String errorCode, String errorMsg) {
        super(errorCode);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    /**
     * 编码、信息、异常父类 参数构造
     * @param errorCode
     * @param errorMsg
     * @param cause
     */
    public BizException(String errorCode, String errorMsg, Throwable cause) {
        super(errorCode, cause);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    @Override
    public Throwable fillInStackTrace() {
        return this;
    }

}

通过这个异常类，可以通过 throw new BizException() 来定制异常信息。

5. 创建统一异常处理器 GlobalExceptionHandler

前面四个步骤都是在为这一步做基础工作，没有前面的的步骤只有这一个类也可以完成统一异常处理，只是没那么规范。

重点是 @ControllerAdvice 注解

@ControllerAdvice //声明当前类为控制器增强类，除了统一异常处理可以用到，还可以用在全局数据绑定和数据初始化。
@ResponseBody  //表示返回的对象，Spring会自动把该对象进行json转化，最后写入到Response中。
public class GlobalExceptionHandler {
    Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 处理自定义的业务异常
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = BizException.class) // 匹配异常类，这里匹配了我们定制的异常类。
    public BaseResult bizExceptionHandler(HttpServletRequest req, BizException e) {
        logger.error("发生业务异常！原因是：{}", e.getErrorMsg());//用日志记录方便查阅
        return BaseResult.error(e.getErrorCode(), e.getErrorMsg());
    }

    /**
     * 处理空指针的异常
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = NullPointerException.class)
    public BaseResult exceptionHandler(HttpServletRequest req, NullPointerException e) {
        logger.error("发生空指针异常！原因是:", e);
        return BaseResult.error(e.getMessage());
    }
    
    /**
     * 处理其他异常
     *
     * @param req
     * @param e
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    public BaseResult exceptionHandler(HttpServletRequest req, Exception e) {
        logger.error("未知异常！原因是:", e);
        return BaseResult.error(e.getMessage());
    }

    // 不嫌麻烦的话可以定义更多处理其他类异常的方法
}

做完上面的步骤就完成了统一异常的处理，接下来写个简单的接口做测试。

6. 写点简单的业务代码做测试

实体类 Dog：

@Setter
@Getter
@AllArgsConstructor
@NoArgsConstructor
public class Dog {
    private String name;
    private int age;
    private String id;
}

service 层 DogService：

@Service
public class DogService {

    /**
     * 测试自定义异常
     */
    public void exceptionTest(){
        throw new BizException(CommonEnum.INTERNAL_SERVER_ERROR);
    }

    /**
     * 正常业务
     * @param id
     * @return
     */
    public Dog findDog(String id){
        if(id.equals("1001"))
            return new Dog("kaka",2,id);
        return null;
    }
}

controller 层 DogController:

@RestController
public class DogController {
    @Autowired
    private DogService dogService;

    /**
     * 找狗
     * @param id
     * @return
     */
    @GetMapping("/dog")
    public String findDog(@RequestParam String id){
        Dog dog = dogService.findDog(id);
        if(dog == null)
            return BaseResult.error("未找到这只狗").toString();
        return BaseResult.success(dog).toString();//对返回结果做统一处理，有些情况下我们还需要在 success 方法中传入 HttpServletRequest 来用日志记录请求中的一些信息，有需要了再在 BaseResult 中创建对应的方法就行了。
    }

    /**
     * 模拟业务类中抛出异常
     * @return
     */
    @PostMapping("/exception")
    public String exception(){
        dogService.exceptionTest();
        return BaseResult.success().toString();// 由于考虑到 BaseResult 类在别处会用到，所以没有直接把类方法的返回值定为 JSON 如果嫌弃 .toString 这种写法（toString 已被重写为返回JSON），可以写个另外的类来继承这个类并重写里面的方法。
    }
}

测试：

启动项目：

按照业务逻辑 当参数 id 不是 1001 时，controller 返回“未找到狗”的JSON 信息，否者返回正确狗的信息：

测试

正常业务

然后测试异常服务：

异常业务

此时前台就可以通过解析 json 中的数据想办法提示给客户了。

通过异常统一处理和返回数据格式化，已经可以把服务器处理请求的结果清楚的返回给客户端了。

逸之居
关注
专栏目录
springboot 多模块 集成mybatis redis 日志 异常统一处理，切面拦截器
12-20
springboot多模块项目，集成了mybatis，连接池，redis，日志，sql日志打印，异常统一处理，统一返回格式，mapper文件自动生成，generator xml ，切面日志和拦截器，sql注入过滤，解压即可部署打包启动，包含数据库结构sql文件，
SpringBoot逻辑异常统一处理方法
08-25
在本文中，我们将探讨 SpringBoot 逻辑异常统一处理方法，该方法主要介绍了如何在 SpringBoot 项目中实现逻辑异常的统一处理。通过示例代码，我们将展示如何创建一个异常处理核心子模块，并如何在 SpringBoot 项目中...
SpringBoot 统一异常处理
weixin_33835103的博客
04-09 117
SpringBoot 统一异常处理异常和响应码 因为用RESTful设计的接口, 应该用状态码反映请求的错误, 不应该统一返回200 的状态码, 然后再通过 msg 来描述错误. 所以统一异常处理比较关键. 异常一般分为 业务异常 和 非业务异常业务异常通常返回4xx的状态码非业务异常只需要返回 500 , 提示 服务器错误,请稍候重试默认异常处理SpringBoot 提供了默认的处理异常方式，当...
SpringBoot统一异常处理
dont_curry的博客
08-20 1352
使用注解的方式统一异常处理时，可以使用@配合@拦截控制器的异常。注解是Spring框架中用于定义全局异常处理类的注解，它结合了@和@的功能，用于RESTful风格的应用程序。当SpringBoot应用启动时，Spring容器会自动扫描并加载带有@RestControllerAdvice注解的类，将其实例化并加载到容器中进行管理。一旦控制层在处理请求时抛出异常，Spring MVC的异常处理机制就会被出发，并且@RestControllerAdvice中定义的异常处理方法将被调用。
SpringBoot异常的统一处理
zgx498904306的博客
10-07 5339
springboot的统一异常处理
Spring Boot：异常统一处理
记录，记录，记录
06-29 621
一：前言 这里先对需要使用到的注解或者类进行说明，顺便理清楚条理。 @ExceptionHandler：注解使用在方法上，值为指定某个异常，当该方法所在的controller出现的异常与注解的异常对应，则会触发注解的方法。 下面这个controller一旦出现异常都会将异常捕获转给该方法进行处理 @RestController @RequestMapping("user") public clas...
springboot异常统一处理
weixin_43766943的博客
11-05 77
修改springboot默认返回的异常消息结构 { "timestamp": "2021-11-05 12:36:07", "status": 404, "error": "Not Found", "path": "/xxx/ooo123" } 修改这个结构体 ①项目配置文件中增加 mvc: throw-exception-if-no-handler-found: true resources: add-mappings: false ②增加异常跳转控制器 @Control
SpringBoot 统一异常处理详解
08-26
SpringBoot 统一异常处理是指在 SpringBoot 应用程序中统一处理异常的机制，通过将所有异常统一处理，提高了应用程序的健壮性和可维护性。在本文中，我们将详细介绍 SpringBoot 统一异常处理的实现细节，并提供了...
SpringBoot 2 统一异常处理过程解析
08-25
统一异常处理是 SpringBoot 2 中的一个重要机制，它可以帮助开发者更好地处理应用程序中的异常。通过本文，我们将详细介绍 SpringBoot 2 统一异常处理过程解析，来帮助读者更好地理解和应用该机制。 统一异常处理...
springboot统一异常处理
01-24
springboot统一异常处理
Springboot全局异常处理demo.zip
03-10
将所有类型的异常处理从各处理过程解耦出来，这样既保证了相关处理过程的功能较单一，也实现了异常信息的统一处理和维护。使用统一异常处理的好处是能够将异常信息统一捕捉并组装成固定格式的数据返回。
Spring Boot异常统一处理
Kevin_zhai的博客
05-24 3021
最近在学习自己搭建一个配置中心平台，准备用spring boot来搭建后台web系统，将遇到的问题在此记录。github项目地址：https://github.com/zhaikevin/confCenter，如果觉得有用，请给个star。ps：还有很多东西没有完成，欢迎感兴趣的童鞋一起来搞。我们在用ajax向服务端请求数据时，免不了会有异常。如果不进行统一处理，直接把异常信息抛到前端，界面会很不...
springBoot异常统一处理
weixin_30949361的博客
08-15 109
springBoot异常统一处理 采用@ControllerAdvice注解和@ExceptionHandler注解，可以对异常进行统一处理。 1.结构图： 2.pom.xml文件： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0....
SpringBoot异常统一处理
芒果不是冰
09-25 459
springboot项目中，异常通常有默认提示，这里针对异常进行统一处理，如下: 项目pom.xml 启动类 测试类，DemoController,有两个方法，demo1能正常访问跳转，demo2特意写了一个空指针异常，用来演示springboot的异常统一处理 访问demo1正常跳转 访问demo2 如图： springboot项目报错时，出现" /error...
Springboot 异常统一处理
《春馨梦》的专栏
11-04 389
Springboot 统一异常处理 配置文件 spring.mvc.throw-exception-if-no-handler-found=true spring.resources.add-mappings=false 全局异常拦截 在这里插入代码片 @ControllerAdvice public class GlobalExceptionHandler{ @Exce...
springboot3异常统一处理
最新发布
09-24
Spring Boot 提供了一种方便的方式来统一处理应用程序中的异常，这主要通过全局异常处理机制实现。在 Spring Boot 3 中，你可以配置 `@ControllerAdvice` 或 `@ExceptionHandler` 注解的方法来捕获并处理各种类型的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值