Springboot 自定义异常处理

已于 2023-02-13 13:38:06 修改
阅读量836 收藏 1
点赞数 1
文章标签： spring boot java spring
于 2022-08-20 09:48:36 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_49238911/article/details/126436104
版权

什么是异常

什么是异常：程序执行过程中的不正常情况。
异常的作用：增强程序的 健壮性。

依赖管理：

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

        <!--lombok用来简化实体类：需要安装lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

编写异统一响应类：

import org.springframework.http.HttpStatus;

import java.util.HashMap;

/**
 * 数据结果封装体 AjaxResult
 *
 * @author 赵强
 */
public class AjaxResult extends HashMap<String, Object>
{
    private static final long serialVersionUID = 1L;

    /** 状态码 */
    public static final String CODE_TAG = "code";

    /** 返回内容 */
    public static final String MSG_TAG = "msg";

    /** 数据对象 */
    public static final String DATA_TAG = "data";

    /**
     * 初始化一个AjaxResult 对象
     */
    public AjaxResult()
    {
    }

    /**
     * 初始化一个AjaxResult 对象
     *
     * @param code 状态码
     * @param msg 返回内容
     */
    public AjaxResult(int code, String msg)
    {
        super.put(CODE_TAG, code);
        super.put(MSG_TAG, msg);
    }

    /**
     * 初始化一个AjaxResult 对象
     *
     * @param code 状态码
     * @param msg 返回内容
     * @param data 数据对象
     */
    public AjaxResult(int code, String msg, Object data)
    {
        super.put(CODE_TAG, code);
        super.put(MSG_TAG, msg);
        if (!(data == null))
        {
            super.put(DATA_TAG, data);
        }
    }

    /**
     * 返回默认成功消息
     *
     * @return 成功消息
     */
    public static AjaxResult success()
    {
        return AjaxResult.success("操作成功");
    }

    /**
     * 返回成功消息
     *
     * @param msg 返回内容
     * @return 成功消息
     */
    public static AjaxResult success(String msg)
    {
        return AjaxResult.success(msg, null);
    }

    /**
     * 返回成功数据
     * @param data 数据对象
     * @return
     */
    public static AjaxResult success(Object data)
    {
        return AjaxResult.success("操作成功", data);
    }

    /**
     * 初始化一个返回成功消息AjaxResult对象
     *
     * @param msg 返回内容
     * @param data 数据对象
     * @return 成功消息
     */
    public static AjaxResult success(String msg, Object data)
    {
        return new AjaxResult(HttpStatus.valueOf(200).value(), msg, data);
    }

    /**
     * 返回默认错误消息
     *
     * @return
     */
    public static AjaxResult error()
    {
        return AjaxResult.error("操作失败");
    }

    /**
     * 返回错误消息
     *
     * @param msg 返回内容
     * @return 警告消息
     */
    public static AjaxResult error(String msg)
    {
        return AjaxResult.error(msg, null);
    }

    /**
     * 返回错误数据
     *
     * @param code 状态码
     * @param msg 返回内容
     * @return 警告消息
     */
    public static AjaxResult error(int code, String msg)
    {
        return new AjaxResult(code, msg, null);
    }

    /**
     * 初始化一个返回错误消息AjaxResult对象
     *
     * @param msg 返回内容
     * @param data 数据对象
     * @return 警告消息
     */
    public static AjaxResult error(String msg, Object data)
    {
        return new AjaxResult(HttpStatus.valueOf(500).value(), msg, data);
    }

}

编写异常枚举类：

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;

@Getter
@AllArgsConstructor
@ToString
public enum ResponseEnum {

    SUCCESS(0, "成功"),
    ERROR(-1, "服务器内部错误"),

    //-1xx 服务器错误
    BAD_SQL_GRAMMAR_ERROR(-101, "sql语法错误"),
    SERVLET_ERROR(-102, "servlet请求异常"), //-2xx 参数校验
    UPLOAD_ERROR(-103, "文件上传错误"),
    EXPORT_DATA_ERROR(104, "数据导出失败"),


    //-2xx 参数校验
    BORROW_AMOUNT_NULL_ERROR(-201, "借款额度不能为空"),
    MOBILE_NULL_ERROR(-202, "手机号码不能为空"),
    MOBILE_ERROR(-203, "手机号码不正确"),
    PASSWORD_NULL_ERROR(204, "密码不能为空"),
    CODE_NULL_ERROR(205, "验证码不能为空"),
    CODE_ERROR(206, "验证码错误"),
    MOBILE_EXIST_ERROR(207, "手机号已被注册"),
    LOGIN_MOBILE_ERROR(208, "用户不存在"),
    LOGIN_PASSWORD_ERROR(209, "密码错误"),
    LOGIN_LOKED_ERROR(210, "用户被锁定"),
    LOGIN_AUTH_ERROR(-211, "未登录"),


    USER_BIND_IDCARD_EXIST_ERROR(-301, "身份证号码已绑定"),
    USER_NO_BIND_ERROR(302, "用户未绑定"),
    USER_NO_AMOUNT_ERROR(303, "用户信息未审核"),
    USER_AMOUNT_LESS_ERROR(304, "您的借款额度不足"),
    LEND_INVEST_ERROR(305, "当前状态无法投标"),
    LEND_FULL_SCALE_ERROR(306, "已满标，无法投标"),
    NOT_SUFFICIENT_FUNDS_ERROR(307, "余额不足"),

    PAY_UNIFIEDORDER_ERROR(401, "统一下单错误"),

    ALIYUN_RESPONSE_ERROR(-501, "阿里云短信服务响应失败"),
    ALIYUN_SMS_LIMIT_CONTROL_ERROR(-502, "短信发送过于频繁"),//业务限流
    ALIYUN_SMS_ERROR(-503, "短信发送失败"),//其他失败

    WEIXIN_CALLBACK_PARAM_ERROR(-601, "回调参数不正确"),
    WEIXIN_FETCH_ACCESSTOKEN_ERROR(-602, "获取access_token失败"),
    WEIXIN_FETCH_USERINFO_ERROR(-603, "获取用户信息失败"),
    ;


    //响应状态码
    private Integer code;
    //响应信息
    private String message;
}

编写统一异常处理类：

@RestControllerAdvice
@Slf4j
public class UnifiedExceptionHandler {

    /**
     * 系统异常
     */
    @ExceptionHandler(value = Exception.class)
    public AjaxResult handlerException(Exception e){
        log.error("系统异常:", e);
        return AjaxResult.error("操作异常",e.getMessage());
    }

    /**
     * 拦截未知的运行时异常
     */
    @ExceptionHandler(RuntimeException.class)
    public AjaxResult notFount(RuntimeException e)
    {
        log.error("运行时异常:", e);
        return AjaxResult.error("运行时异常:" + e.getMessage());
    }

    /**
     * 请求方式不支持
     */
    @ExceptionHandler({ HttpRequestMethodNotSupportedException.class })
    public AjaxResult handleException(HttpRequestMethodNotSupportedException e)
    {
        log.error("请求方式不支持异常:", e);
        return AjaxResult.error("不支持' " + e.getMethod() + "'请求");
    }

    /**
     * 定义的Sql语句异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = BadSqlGrammarException.class)      //当controller中抛出Exception，则捕获
    public AjaxResult HandleException(BadSqlGrammarException e) {
        log.error(e.getMessage(), e);
        return AjaxResult.error(-101,"sql语法错误");
    }

    /**
     * 自定义异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = BusinessException.class)
    public AjaxResult handlerException(BusinessException e){
        log.error("自定义验证异常", e);
        return AjaxResult.error(e.getCode(),e.getMessage());
    }



}

编写自定义异常类：

import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
public class BusinessException extends RuntimeException{

    //错误码
    private Integer code;
    //错误消息
    private String message;

    /**
     *
     * @param message 错误消息
     */
    public BusinessException(String message) {
        this.message = message;
    }

    /**
     *
     * @param message 错误消息
     * @param code 错误码
     */
    public BusinessException(String message, Integer code) {
        this.message = message;
        this.code = code;
    }

    /**
     *
     * @param message 错误消息
     * @param code 错误码
     * @param cause 原始异常对象
     */
    public BusinessException(String message, Integer code, Throwable cause) {
        super(cause);
        this.message = message;
        this.code = code;
    }


    /**
     *
     * @param resultCodeEnum 接收枚举类型
     */
    public BusinessException(ResponseEnum resultCodeEnum) {
        this.message = resultCodeEnum.getMessage();
        this.code = resultCodeEnum.getCode();
    }

    /**
     *
     * @param resultCodeEnum 接收枚举类型
     * @param cause 原始异常对象
     */
    public BusinessException(ResponseEnum resultCodeEnum, Throwable cause) {
        super(cause);
        this.message = resultCodeEnum.getMessage();
        this.code = resultCodeEnum.getCode();
    }

}

##断言工具类

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;

@Slf4j
public class AssertUtils {
    /**
     * 断言对象不能为空
     * 如果对象 obj 为空，则抛出异常
     * @param  obj 待判断对象
     * @param responseEnum
     */
    public static void notNull(Object obj, ResponseEnum responseEnum) {
        if (obj == null) {
            log.info("obj is null ======");
            throw new BusinessException(responseEnum);
        }
    }

    /**
     * 断言对象为空
     * 如果对象obj不为空，则抛出异常
     * @param object
     * @param responseEnum
     */
    public static void isNull(Object object, ResponseEnum responseEnum) {
        if (object != null) {
            log.info("obj is not null......");
            throw new BusinessException(responseEnum);
        }
    }

    /**
     * 断言表达式为真
     * 如果不为真，则抛出异常
     *
     * @param expression 是否成功
     */
    public static void isTrue(boolean expression, ResponseEnum responseEnum) {
        if (!expression) {
            log.info("fail...............");
            throw new BusinessException(responseEnum);
        }
    }

    /**
     * 断言两个对象不相等
     * 如果相等，则抛出异常
     * @param m1
     * @param m2
     * @param responseEnum
     */
    public static void notEquals(Object m1, Object m2,  ResponseEnum responseEnum) {
        if (m1.equals(m2)) {
            log.info("equals...............");
            throw new BusinessException(responseEnum);
        }
    }

    /**
     * 断言两个对象相等
     * 如果不相等，则抛出异常
     * @param m1
     * @param m2
     * @param responseEnum
     */
    public static void equals(Object m1, Object m2,  ResponseEnum responseEnum) {

        if (!m1.equals(m2)) {
            log.info("not equals...............");
            throw new BusinessException(responseEnum);
        }
    }

    /**
     * 断言参数不为空
     * 如果为空，则抛出异常
     * @param s
     * @param responseEnum
     */
    public static void notEmpty(String s, ResponseEnum responseEnum) {
        if (StringUtils.isEmpty(s)) {
            log.info("is empty...............");
            throw new BusinessException(responseEnum);
        }
    }
}
weixin_49238911
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
业务异常提示处理 springboot+Assert(自定义断言)
05-07
使用springboot框架快速搭建，封装自定义断言做业务校验，公共异常处理打印日志， 更简单的业务判断处理
Springboot自定义全局异常处理器-封装接口异常的响应体，防止异常时暴露程序包名类名路径信息（附swagger文档的使用教程与资源拦截问题）
weixin_42585386的博客
05-23 1386
aaa问题现象： 今天在项目中，遇到了一个需求： 如何解决接口调用报错时，暴露了接口涉及的包名、类名等敏感信息的问题？ 问题分析： 其实在很多正常的小项目，对这种情况是不做处理的，因为即使暴露了 起因是因为甲方在使用安全测试工具检测接口的时候，发现接口返回的报文中存在敏感信息，会暴露接口逻辑中用到的包名、类名，举个例子如： 如上图，接口：/pms-amap-sgcc-serv...
异常统一处理：BusinessException（自定义业务异常）
最新发布
宋冠巡的博客
02-22 2212
本篇内容是“**异常统一处理**”系列文章的重要组成部分，主要聚焦于对 `BusinessException` 的原理解析与异常处理机制，并给出测试案例。
Springboot如何实现自定义异常数据
09-07
主要介绍了Springboot如何实现自定义异常数据,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
详解Springboot自定义异常处理
08-30
本篇文章主要介绍了详解Springboot自定义异常处理，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringBoot优雅的自定义异常处理
等风来的博客
09-22 252
一、引入pom <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId>
SpringBoot实现自定义异常类。
weixin_60414376的博客
02-06 7565
SpringBoot异常类创建与简化返回给前端的异常消息
Spring Boot （二十一）——自定义异常处理
云中、漫步的博客
01-10 330
在 Spring Boot 项目中 ，异常统一处理，可以使用 Spring 中 @ControllerAdvice 来统一处理，也可以自己来定义异常处理方案。Spring Boot 中，对异常的处理有一些默认的策略，我们分别来看。 默认情况下，Spring Boot 中的异常页面 是这样的： 我们从这个异常提示中，也能看出来，之所以用户看到这个页面，是因为开发者没有明确提供一个 /error 路...
Spring Boot 自定义异常内容
扛麻袋的少年的博客
04-01 4550
Spring Boot学习笔记(二十一)：在上篇文章：Spring Boot 错误处理机制源码分析，我们已经对 Spring Boot 错误处理机制的源码部分内容进行了详细的讲解，接下来我们来介绍如何自定义我们自己的异常内容提示。 自定义异常，分两种情况来介绍： 1.使用模板引擎：       &...
Spring Boot 如何自定义异常处理器
it_xushixiong的博客
05-30 1570
要实现自定义异常处理器，您需要执行以下步骤：1.创建一个自定义异常类，例如。} }在上面的代码中，我们创建了一个自定义异常类，继承自类。2.创建一个自定义异常处理器，例如。} }在上面的代码中，我们创建了一个自定义异常处理器，使用注解标记。这个注解表示这个类将用于全局异常处理。我们使用注解来标记处理异常的方法。在这个方法中，我们将错误信息、时间戳和请求描述封装成对象，并将其作为响应返回给客户端。3.在控制器方法中抛出自定义异常。} }在上面的代码中，我们在/test。
Spring boot自定义异常处理（全局异常处理）
weixin_68481727的博客
09-28 1458
Spring boot自定义异常处理（全局异常处理）
Springboot2.0处理自定义异常并返回json
10-15
主要介绍了Springboot2.0处理自定义异常并返回json,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
Springboot之自定义全局异常处理的实现
08-25
主要介绍了Springboot之自定义全局异常处理的实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
源码剖析Springboot自定义异常.docx
06-28
博主看到新服务是封装的自定义异常，准备入手剖析一下，...第一步：肯定是在Springboot启动的过程中进行的异常处理初始化，于是就找到了handlerExceptionResolver类，在创建该类的时候，会进行添加我们自定义异常。
浅谈SpringBoot 中关于自定义异常处理的套路
08-26
主要介绍了浅谈SpringBoot 中关于自定义异常处理的套路，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot写出优雅的后端接口
小薛博客助力人人成为架构师
04-09 4474
SpringBoot写出优雅的后端接口pom.xml业务层校验Validator + BindResult进行校验Validator + 自动抛出异常全局异常处理自定义异常数据统一响应-自定义统一响应体响应码枚举全局处理响应数据 pom.xml <parent> <groupId>org.springframework.boot</groupI...
SpringBoot如何处理自定义异常(都是套路！！！)
Mango的博客
02-23 7103
文章目录一、前言二、静态异常页面三、动态异常页面四、源码解读五、自定义异常数据六、自定义异常视图七、总结 一、前言 在 SpringBoot 项目中，对于异常的统一处理，可以采用 Spring 中@ControllerAdvice注解标注的类来统一进行处理，也可以自定义异常处理的解决方案。在 SpringBoot 中，对异常的处理存在一些默认的策略，下面我们就分别来看一下。 默认情况下，Sprin...
SpringBoot自定义异常，优雅解决业务逻辑中的错误
浪人与酒
06-24 2062
文章目录前言设计1. 自定义枚举类2. 自定义异常3. 异常全局处理4. 使用 前言 在我们开发中，总会碰到一些异常 ---------- 运行时异常(不受检异常)：RuntimeException类极其子类表示JVM在运行期间可能出现的错误。编译器不会检查此类异常，并且不要求处理异常，比如用空值对象的引用（NullPointerException）、数组下标越界（ArrayIndexOutBoundException）。此类异常属于不可查异常，一般是由程序逻辑错误引起的，在程序中可以选择捕获处理，也可
《springboot实战》第六章 实现自定义全局异常处理
Java 技术专栏，从入门到精通，熟悉企业级开发
04-19 883
*** Http状态信息接口后续方便管理所有错误枚举的错误信息以及code码，通过构造方法传入code值和message或者直接传入一个枚举值都行/*** Http状态码//定义状态枚举值 SUCCESS(200 , "成功!") , BODY_NOT_MATCH(400 , "数据格式不匹配!") , NOT_FOUND(404 , "访问资源不存在!") , INTERNAM_SERVER_ERROR(500 , "服务器内部错误!
springboot自定义异常
03-25
在SpringBoot中，我们可以通过自定义异常来处理业务逻辑中出现的异常情况。以下是实现步骤： 1. 自定义异常类 在项目包中创建一个自定义的异常类，需要继承Exception或RuntimeException。 ``` public class CustomException extends RuntimeException { private int code; private String message; public CustomException(int code, String message) { this.code = code; this.message = message; } public int getCode() { return code; } public String getMessage() { return message; } } ``` 2. 异常处理类 在项目包中创建一个异常处理类，需要使用@ControllerAdvice和@ExceptionHandler注解，通过指定异常类来捕获异常并处理。 ``` @ControllerAdvice public class CustomExceptionHandler { @ExceptionHandler(CustomException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) @ResponseBody public Result handleCustomException(CustomException e) { return new Result(e.getCode(), e.getMessage(), null); } } ``` 3. 统一响应对象 在项目包中创建一个统一响应对象类，用于统一封装响应信息。 ``` public class Result<T> { private int code; private String message; private T data; public Result(int code, String message, T data) { this.code = code; this.message = message; this.data = data; } public int getCode() { return code; } public String getMessage() { return message; } public T getData() { return data; } } ``` 以上就是springboot自定义异常的实现步骤。在业务逻辑中抛出自定义异常即可触发异常处理类中的处理方法，并返回统一响应对象。这样可以统一处理异常并返回规范化的响应信息，方便前端或其他系统的处理。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值