SpringBoot全局异常配置、断言配置

已于 2024-01-16 11:02:21 修改
阅读量332 收藏
点赞数
分类专栏： SpringBoot相关 文章标签： spring boot spring java
于 2023-10-20 15:36:30 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_31450641/article/details/133947452
版权

1、实现方式定义一个全局异常配置类，使用@RestControllerAdvice注解

在使用方法上用
@ExceptionHandler(value = BizException.class)配合使用，使其异常提示作用

2、需要定义一个统一结果返回类，如下代码


@Data
@Slf4j
@ToString
public class CommonResult<T> {

    /**
     * 状态码
     */
    private long code;
    /**
     * 提示信息
     */
    private String message;
    /**
     * 数据封装
     */
    private T data;

    protected CommonResult() {
    }

    protected CommonResult(long code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 成功返回结果
     *
     * @param data 获取的数据
     */
    public static <T> CommonResult<T> success(T data) {
        return new CommonResult<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
    }

    /**
     * 成功返回结果
     *
     * @param data 获取的数据
     * @param  message 提示信息
     */
    public static <T> CommonResult<T> success(T data, String message) {
        return new CommonResult<T>(ResultCode.SUCCESS.getCode(), message, data);
    }

    /**
     * 失败返回结果
     * @param errorCode 错误码
     */
    public static <T> CommonResult<T> failed(IErrorCode errorCode) {
        return new CommonResult<T>(errorCode.getCode(), errorCode.getMessage(), null);
    }

    /**
     * 失败返回结果
     * @param errorCode 错误码
     * @param message 错误信息
     */
    public static <T> CommonResult<T> failed(IErrorCode errorCode,String message) {
        return new CommonResult<T>(errorCode.getCode(), message, null);
    }

    /**
     * 失败返回结果
     * @param message 提示信息
     */
    public static <T> CommonResult<T> failed(String message) {
        return new CommonResult<T>(ResultCode.FAILED.getCode(), message, null);
    }

    /**
     * 失败返回结果
     */
    public static <T> CommonResult<T> failed() {
        return failed(ResultCode.FAILED);
    }

    /**
     * 参数验证失败返回结果
     */
    public static <T> CommonResult<T> validateFailed() {
        return failed(ResultCode.VALIDATE_FAILED);
    }

    /**
     * 参数验证失败返回结果
     * @param message 提示信息
     */
    public static <T> CommonResult<T> validateFailed(String message) {
        return new CommonResult<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null);
    }

    /**
     * 未登录返回结果
     */
    public static <T> CommonResult<T> unauthorized(T data) {
        return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(), ResultCode.UNAUTHORIZED.getMessage(), data);
    }

    /**
     * 未授权返回结果
     */
    public static <T> CommonResult<T> forbidden(T data) {
        return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(), ResultCode.FORBIDDEN.getMessage(), data);
    }

3、需要定义一个统一的错误吗接口，异常枚举类来实现

/**
 * 错误码接口
 */
public interface IErrorCode {

    /**
     * 返回码
     */
    long getCode();

    /**
     * 返回信息
     */
    String getMessage();
}

/**
 * 统一返回结果枚举定义
 */
public enum ResultCode implements IErrorCode {
    SUCCESS(200, "操作成功"),
    FAILED(500, "操作失败"),
    VALIDATE_FAILED(404, "参数检验失败"),
    UNAUTHORIZED(401, "暂未登录或token已经过期"),
    FORBIDDEN(403, "没有相关权限");
    private long code;
    private String message;

    private ResultCode(long code, String message) {
        this.code = code;
        this.message = message;
    }

    @Override
    public long getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }

4、自定义业务异常，在业务异常时使用抛出，在全局异常里面处理捕获返回给前端


/**
 * 自定义业务异常
 */
public class BizException extends  RuntimeException{

    private IErrorCode errorCode;
    public BizException(Throwable cause) {
        super(cause);
    }

    public BizException(IErrorCode code) {
        super(code.getMessage());
        this.errorCode = code;
    }
    public BizException(String message) {
        super(message);
    }
    public BizException(String message, Throwable cause) {
        super(message, cause);
    }
    public IErrorCode getErrorCode() {
        return errorCode;
    }
}

5、定义全局异常处理类


/**
 * 全局异常处理
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 业务异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = BizException.class)
    public CommonResult handle(BizException e) {
        if (e.getErrorCode() != null) {
            return CommonResult.failed(e.getErrorCode());
        }
        return CommonResult.failed(e.getMessage());
    }

    /**
     * 将请求体解析并绑定到 java bean 时，如果出错，则抛出 MethodArgumentNotValidException 异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public CommonResult handleValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        String message = null;
        if (bindingResult.hasErrors()) {
            FieldError fieldError = bindingResult.getFieldError();
            if (fieldError != null) {
                message = fieldError.getField()+fieldError.getDefaultMessage();
            }
        }
        return CommonResult.validateFailed(message);
    }


    /**
     * 表单绑定到 java bean 出错时，绑定参数校验异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = BindException.class)
    public CommonResult handleValidException(BindException e) {
        BindingResult bindingResult = e.getBindingResult();
        String message = null;
        if (bindingResult.hasErrors()) {
            FieldError fieldError = bindingResult.getFieldError();
            if (fieldError != null) {
                message = fieldError.getField()+fieldError.getDefaultMessage();
            }
        }
        return CommonResult.validateFailed(message);
    }

    @ExceptionHandler(value = SQLSyntaxErrorException.class)
    public CommonResult handleSQLSyntaxErrorException(SQLSyntaxErrorException e) {
        String message = e.getMessage();
        if (StrUtil.isNotEmpty(message) && message.contains("denied")) {
            message = "演示环境暂无修改权限，如需修改数据可本地搭建后台服务！";
        }
        return CommonResult.failed(message);
    }

    /**
     * 必填校验参数缺失错误
     * @param e
     * @return
     */
    @ExceptionHandler(value = MissingServletRequestParameterException.class)
    public CommonResult handleMissingServletException(MissingServletRequestParameterException e) {
        String message = e.getMessage();
        if (StrUtil.isNotEmpty(message)) {
            return CommonResult.validateFailed(message);
        }
        return CommonResult.validateFailed(message);
    }

}

断言设置，可以在抛出异常时使代码更简洁清晰，其中加了一些true、false的判断

作用等同于throw new BizException(“msg”);

package com.example.common.util;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.map.MapUtil;
import cn.hutool.core.util.ObjectUtil;
import cn.hutool.core.util.StrUtil;
import com.example.common.api.IErrorCode;
import com.example.common.exception.BizException;
import lombok.NoArgsConstructor;

import java.util.Collection;
import java.util.Map;
import java.util.Objects;

/**
 * 断言
 */
@NoArgsConstructor
public class BizAssert {

    public static void equals(IErrorCode errorEnum, Object obj1, Object obj2, Object... params) {
        if (!Objects.equals(obj1, obj2)) {
            failure(errorEnum, params);
        }
    }

    public static void isTrue(IErrorCode errorEnum, boolean condition, Object... params) {
        if (!condition) {
            failure(errorEnum, params);
        }
    }

    public static void isFalse(IErrorCode errorEnum, boolean condition, Object... params) {
        if (condition) {
            failure(errorEnum, params);
        }
    }

    public static void isNull(IErrorCode errorEnum, Object condition, Object... params) {
        if (ObjectUtil.isNotNull(condition)) {
            failure(errorEnum, params);
        }
    }

    public static void notNull(IErrorCode errorEnum, Object condition, Object... params) {
        if (ObjectUtil.isNull(condition)) {
            failure(errorEnum, params);
        }
    }

    public static void equals(String message, Object obj1, Object obj2, Object... params) {
        if (!Objects.equals(obj1, obj2)) {
            failure(message, params);
        }
    }

    public static void isTrue(String message, boolean condition, Object... params) {
        if (!condition) {
            failure(message, params);
        }
    }

    public static void isFalse(String message, boolean condition, Object... params) {
        if (condition) {
            failure(message, params);
        }
    }

    public static void isNull(String message, Object condition, Object... params) {
        if (ObjectUtil.isNotNull(condition)) {
            failure(message, params);
        }
    }

    public static void notNull(String message, Object condition, Object... params) {
        if (ObjectUtil.isNull(condition)) {
            failure(message, params);
        }
    }

    /**
     * <p>
     * 失败结果
     * </p>
     * @param errorCode 异常错误码
     */
    public static void failure(IErrorCode errorCode, Object... params) {
        failure(errorCode.getMessage(),params);
    }

    /**
     * 失败
     * @param message
     * @param params
     */
    public static void failure(String message, Object... params) {
        throw new BizException(StrUtil.format(message, params));
    }

    /**
     * 数组为空通过msg
     * @param message
     * @param array
     * @param params
     */
    public static void notEmpty(String message, Object[] array, Object... params) {
        if (ObjectUtil.isEmpty(array)) {
            failure(message, params);
        }
    }
    /**
     * 数组为空通过errorCode
     * @param errorCode
     * @param array
     * @param params
     */
    public static void notEmpty(IErrorCode errorCode, Object[] array, Object... params) {
        if (ObjectUtil.isEmpty(array)) {
            failure(errorCode, params);
        }
    }

    /**
     * 集合为空
     * @param errorEnum
     * @param collection
     * @param params
     */
    public static void notEmpty(IErrorCode errorEnum, Collection<?> collection, Object... params) {
        if (CollUtil.isEmpty(collection)) {
            failure(errorEnum, params);
        }
    }

    /**
     * map为空
     * @param errorEnum
     * @param map
     * @param params
     */
    public static void notEmpty(IErrorCode errorEnum, Map<?, ?> map, Object... params) {
        if (MapUtil.isEmpty(map)) {
            failure(errorEnum, params);
        }
    }

    /**集合不能为空
     * @param errorEnum
     * @param collection
     * @param params
     */
    public static void isEmpty(IErrorCode errorEnum, Collection<?> collection, Object... params) {
        if (CollUtil.isNotEmpty(collection)) {
            failure(errorEnum, params);
        }
    }

    /**
     * map不为空
     * @param errorEnum
     * @param map
     * @param params
     */
    public static void isEmpty(IErrorCode errorEnum, Map<?, ?> map, Object... params) {
        if (MapUtil.isNotEmpty(map)) {
            failure(errorEnum, params);
        }
    }


    public static void notEmpty(String message, Collection<?> collection, Object... params) {
        if (CollUtil.isEmpty(collection)) {
            failure(message, params);
        }
    }

    public static void notEmpty(String message, Map<?, ?> map, Object... params) {
        if (MapUtil.isEmpty(map)) {
            failure(message, params);
        }
    }

    public static void isEmpty(String message, Collection<?> collection, Object... params) {
        if (CollUtil.isNotEmpty(collection)) {
            failure(message, params);
        }
    }

    public static void isEmpty(String message, Map<?, ?> map, Object... params) {
        if (MapUtil.isNotEmpty(map)) {
            failure(message, params);
        }
    }


}

二小姐诶
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot处理全局异常详解（全面详细+Gitee源码）
黄团团的个人博客
07-04 2067
我们对常见的七种异常情况统一进行处理，这次的主角就是@RestControllerAdvice这个注解，这个一个组合注解由@ControllerAdvice和@ResponseBody组成，@RestControllerAdvice会帮助我们把信息转成json格式返回。在全局异常处理类只需要在类上标注@RestControllerAdvice，并在处理相应异常的方法上使用@ExceptionHandler注解，写明处理哪个异常即可。注：异常的拦截有顺序，子类异常会优先匹配子类异常处理器。
springboot全局异常处理代码实例
08-25
在创建了公共结果类后，需要在 Spring Boot 项目中配置全局异常处理机制。在 `application.properties` 文件中添加以下配置： ```properties spring.mvc.throw-exception-if-no-handler-found=true ``` 然后，在 `...
SpringBoot配置全局异常处理
小小渔夫
11-03 1112
SpringBoot配置全局异常处理
SpringBoot 实现全局异常处理
最新发布
超超IT的博客
06-20 1013
验证 BusinessServiceException 异常也很简单，我们将上面 UserEntity 的参数补全，但是代码中为空会抛错的那个两个参数我们不传，看下会有什么结果。请求结果：这里同样是我们自定义的返回对象，并不是SpringBoot默认的500页面，所以验证成功。
SpringBoot之Assert(断言)
weixin_42445418的博客
11-17 1675
浅谈SpringBoot中的Assert（断言）
SpringBoot全局异常处理方案一览
天行健，君子以自强不息；地势坤，君子以厚德载物。
11-02 969
来源：https://blog.csdn.net/JokerLJG/article/details/123297513目录异常处理方案分类基于请求转发基于异常处理器基于过滤器常见异常处理实现方案BasicExceptionController@ExceptionHandler@ControllerAdvice+@ExceptionHandlerSimpleMappingExceptionReso...
springboot的异常处理-设置全局异常处理
健康平安的活着的专栏
03-26 1883
一.说明 1.1 全局异常设置 通过注解@ControllerAdvice 定义一个处理全局 异常的类，在需要捕捉异常的方法上加上@ExceptionHandler(value=Exception.class)这个注解。 @ControllerAdvice 如果是返回json数据 则用 RestControllerAdvice,就可以不加 @ResponseBody 如下图 二 案例操作 2.1 执行逻辑 配置一个检测异常的全局类，发生异常时，根据配置的code，msg，url等信息，以j
代码优雅之道——断言 + Springboot统一异常处理
菜鸟逆袭之路
08-29 798
代码优雅之道 第二集
Springboot全局异常处理demo.zip
03-10
Springboot全局异常处理demo 项目的开发中，不管是对底层的数据库操作过程，还是业务层的处理过程，还是控制层的处理过程，都不可避免会遇到各种可预知的、不可预知的异常需要处理。每个过程都单独处理异常，系统的...
Springboot全局异常捕获及try catch区别解析
08-19
Springboot全局异常捕获及try catch区别解析 Springboot全局异常捕获是一种机制，用于捕获并处理应用程序中的异常情况，以便提供友好的用户体验和错误处理。try catch语句是Java语言中的一种异常处理机制，用于捕获...
SpringBoot如何读取配置文件参数并全局使用
08-25
SpringBoot如何读取配置文件参数并全局使用 SpringBoot 框架中读取配置文件参数并全局使用是非常重要的，特别是在实际开发中，我们经常需要读取配置文件中的参数来实现灵活的配置管理。本文将主要介绍如何在 ...
SpringBoot学习之全局异常处理设置（返回JSON）
10-18
本篇文章主要介绍了SpringBoot学习之全局异常处理设置（返回JSON），小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
springBoot全局配置文件.txt
06-12
最全的springboot配置文件，基本上springboot中所需要的配置都可以找到。总共有一千多行，懂技术的人下载直接搜索自己需要的即可。
SpringBoot 全局异常处理
Java后端技术栈
06-29 3601
异常处理主要分为三类：基于请求转发的异常处理方式是真正的全局异常处理。实现方式有：基于异常处理器的异常处理方式其实并不是真正的全局异常处理，因为它处理不了过滤器等抛出的异常。实现方式有：基于过滤器的异常处理方式近似与全局异常处理。它能处理过滤器及之后的环节抛出的异常。实现方式有：这是SpringBoot默认处理异常方式：一旦程序中出现了异常SpringBoot就会请求/error的url，在SpringBoot中提供了一个叫BasicExceptionController的类来处理/error请求，然后跳转
SpringBoot 自带工具类~断言
小强快跑~~
02-15 2115
SpringBoot 中提供了 Assert 断言工具类，通常用于数据合法性检查 // 要求参数 object 必须为非空（Not Null），否则抛出异常，不予放行 // 参数 message 参数用于定制异常信息。 void notNull(Object object, String message) // 要求参数必须空（Null），否则抛出异常，不予『放行』。 // 和 notNull() 方法断言规则相反 void isNull(Object object, String
SpringBoot全局异常处理+Slf4j日志文件配置
2301_76348171的博客
04-03 269
切莫死记硬背，小心面试官直接让你出门右拐1000道互联网Java面试题：
SpringBoot单元测试断言 assertions
qq_16570607的博客
04-18 1638
断言（assertions）是测试方法中的核心部分，用来对测试需要满足的条件进行验证。这些断言方法都是 org.junit.jupiter.api.Assertions 的静态方法。加断言可以避免对数据库的误操作，以及缩短测试流程（断言失败就不再执行之后的代码了）上面一个是我测试建的，如果要新建应该选第二个：Create New Test…待测试的Service方法就不贴了，根据自己的实际情况写逻辑就行；也可以设置异常报文，第一个参数是期望值，第二个参数是实际值。会弹出新建测试类的框。
SpringBoot统一异常处理
空夜's Blog
12-05 1116
示例代码在https://github.com/laolunsi/spring-boot-examples 一、全局统一异常处理配置 先来看这样一个接口： @RestController @RequestMapping(value = "") public class IndexAction { @GetMapping(value = "add") public Intege...
SpringBoot-异常处理
爱笑的boy的博客
08-13 1056
SpringBoot-异常处理
springboot全局异常处理配置
07-14
在Spring Boot中，可以通过配置全局异常处理器来捕获和处理应用程序中的异常。以下是配置全局异常处理的步骤： 1. 创建一个全局异常处理器类，例如 `GlobalExceptionHandler`。 ```java @ControllerAdvice public ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值