36-自定义全局异常

最新推荐文章于 2024-05-04 23:56:02 发布
最新推荐文章于 2024-05-04 23:56:02 发布
阅读量276 收藏 1
点赞数
分类专栏： 笔记
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46449115/article/details/116400566
版权

Spring Boot 自定义异常

Spring Boot项目中已经有一定的异常处理了，但在开发中还不太合适，我们要对异常进行统一的处理

Spring Boot 中的@ControllerAdvice注解表示开启全局异常处理

然后在这个类中定义一个方法去捕获异常@ExceptionHandler(value = BizException.class)

value = BizException.class表示捕获这一种类型的异常

通常这样使用：

@ControllerAdvice
public class GlobalExceptionHandler {

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

    /**
     * 处理自定义的业务异常
     */
    @ExceptionHandler(value = BizException.class)
    @ResponseBody
    public ResultBody bizExceptionHandler(BizException e){
        logger.error("发生业务异常！原因是：{}",e.getMessage());
        return ResultBody.error(e.getErrorCode(), e.getMessage());
    }
}

下面开始实现自定义异常：

  • 新建Spring Boot 项目，导入依赖
<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <java.version>1.8</java.version>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
</properties>
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.5.RELEASE</version>
    <relativePath />
</parent>
<dependencies>
    <!-- Spring Boot Web 依赖 核心 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Boot Test 依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.41</version>
    </dependency>
</dependencies>

目录结构

在这里插入图片描述

  • 自定义基础接口类
public interface BaseError {

    /**
     *错误码
     */
    String getResultCode();

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

}
  • 自定义枚举类

定义一个枚举类，并实现基础接口类接口

public enum CommonEnum implements BaseError {

    //数据操作错误定义

    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;
    }
}
  • 自定义异常类

自定义一个异常类，用于处理我们发生的业务异常

public class BizException extends Exception {

    private static final long serialVersionUID = 1L;

    /**
     *错误码
     */
    protected String errorCode;

    /**
     *错误描述
     */
    protected String errorMsg;


    public BizException() {
        super();
    }

    public BizException(BaseError baseError){
        super(baseError.getResultCode());
        this.errorCode = baseError.getResultCode();
        this.errorMsg = baseError.getResultMsg();
    }

    public BizException(BaseError baseError,Throwable cause){
        super(baseError.getResultCode(),cause);
        this.errorCode = baseError.getResultCode();
        this.errorMsg = baseError.getResultMsg();
    }

    public BizException(String errorMsg){
        super(errorMsg);
        this.errorMsg = errorMsg;
    }

    public BizException(String errorCode, String errorMsg) {
        super(errorCode);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public BizException(String errorCode, String errorMsg, Throwable cause) {
        super(errorCode, cause);
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }

    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }

    public String getMessage() {
        return errorMsg;
    }

    @Override
    public synchronized Throwable fillInStackTrace() {
        return super.fillInStackTrace();
    }
}
  • 自定义数据格式
public class ResultBody {
    
     /** 200:操作成功  -1：操作失败**/
    
    /**
     * 响应代码
     */
    private String code;

    /**
     * 响应消息
     */
    private String message;

    /**
     * 响应结果
     */
    private Object result;

    public ResultBody() {
    }

    public ResultBody(BaseError errorInfo) {
        this.code = errorInfo.getResultCode();
        this.message = errorInfo.getResultMsg();
    }

    public String getCode() {
        return code;
    }

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

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Object getResult() {
        return result;
    }

    public void setResult(Object result) {
        this.result = result;
    }

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

    /**
     * 成功
     * @param data
     * @return
     */
    public static ResultBody success(Object data) {
        ResultBody rb = new ResultBody();
        rb.setCode(CommonEnum.SUCCESS.getResultCode());
        rb.setMessage(CommonEnum.SUCCESS.getResultMsg());
        rb.setResult(data);
        return rb;
    }

    /**
     * 失败
     */
    public static ResultBody error(BaseError errorInfo) {
        ResultBody rb = new ResultBody();
        rb.setCode(errorInfo.getResultCode());
        rb.setMessage(errorInfo.getResultMsg());
        rb.setResult(null);
        return rb;
    }

    /**
     * 失败
     */
    public static ResultBody error(String code, String message) {
        ResultBody rb = new ResultBody();
        rb.setCode(code);
        rb.setMessage(message);
        rb.setResult(null);
        return rb;
    }

    /**
     * 失败
     */
    public static ResultBody error( String message) {
        ResultBody rb = new ResultBody();
        rb.setCode("-1");
        rb.setMessage(message);
        rb.setResult(null);
        return rb;
    }

或者使用比较简单的返回数据格式，两种都可以

@Data
public class ResponseBean<T> {

    // http 状态码
    private boolean success;

    // 返回的数据
    private T data;

    public static <T> ResponseBean<T> success(T data) {
        ResponseBean<T> responseBean = new ResponseBean<>();
        responseBean.setSuccess(true);
        responseBean.setData(data);
        return responseBean;
    }


    public static <T> ResponseBean<T> error(T errorData) {
        ResponseBean<T> responseBean = new ResponseBean<>();
        responseBean.setSuccess(false);
        responseBean.setData(errorData);
        return responseBean;
    }

    public static <T> ResponseBean<T> success() {
        ResponseBean<T> responseBean = new ResponseBean<>();
        responseBean.setSuccess(true);
        return responseBean;
    }
}
  • 自定义全局异常处理类
@ControllerAdvice
public class GlobalExceptionHandler {

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

    /**
     * 处理自定义的业务异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = BizException.class)
    @ResponseBody
    public ResultBody bizExceptionHandler(BizException e){
        logger.error("发生业务异常！原因是：{}",e.getMessage());
        return ResultBody.error(e.getErrorCode(), e.getMessage());
    }

    /**
     * 处理空指针的异常
     * @param e
     * @return
     */
    @ExceptionHandler(value =NullPointerException.class)
    @ResponseBody
    public ResultBody exceptionHandler(NullPointerException e){
        logger.error("发生空指针异常！原因是:",e);
        return ResultBody.error(CommonEnum.BODY_NOT_MATCH);
    }

    /**
     * 处理其他异常
     * @param e
     * @return
     */
    @ExceptionHandler(value =Exception.class)
    @ResponseBody
    public ResultBody exceptionHandler( Exception e){
        logger.error("未知异常！原因是:",e);
        return ResultBody.error(CommonEnum.INTERNAL_SERVER_ERROR);
    }

    @ResponseBody
    @ExceptionHandler(UnauthorizedException.class)
    public ResultBody handleShiroException(Exception e) {
        return ResultBody.error("无权限！");
    }
    @ResponseBody
    @ExceptionHandler(AuthorizationException.class)
    public ResultBody AuthorizationException(Exception e) {
        return ResultBody.error("权限认证失败！");

    }

}

功能测试

用户表

public class User{
    
    @TableId(type = IdType.AUTO)
    private Long id;
    
    private String username;

    private String password;

    private String salt;

    private String roles;

    private String permission;
    //get、set省略
}
  • Controller 控制层

控制层这边也比较简单，使用Restful风格实现的CRUD功能，不同的是这里我故意弄出了一些异常，好让这些异常被捕获到然后处理。这些异常中，有自定义的异常抛出，也有空指针的异常抛出，当然也有不可预知的异常抛出(这里我用类型转换异常代替)，那么我们在完成代码编写之后，看看这些异常是否能够被捕获处理成功吧！

@RestController
@RequestMapping(value = "/api")
public class RestfulController {

    @PostMapping("/user")
    public boolean insert() throws BizException {
        User user = new User();
        System.out.println("开始新增...");
        //如果姓名为空就手动抛出一个自定义的异常！
        if(user.getUsername()==null){
            throw  new BizException("-1","用户姓名不能为空！");
        }
        return true;
    }

    @PutMapping("/user")
    public boolean update() {
        User user = new User();
        System.out.println("开始更新...");
        //这里故意造成一个空指针的异常，并且不进行处理
        String str=null;
        str.equals("111");
        return true;
    }

    @DeleteMapping("/user")
    public boolean delete()  {
        User user = new User();
        System.out.println("开始删除...");
        //这里故意造成一个异常，并且不进行处理
        Integer.parseInt("abc123");
        return true;
    }

    @GetMapping("/user")
    public List<User> findByUser() {
        User user = new User();
        System.out.println("开始查询...");
        List<User> userList =new ArrayList<>();
        User user2=new User();
        user2.setId(1L);
        user2.setUsername("xuwujing");
        userList.add(user2);
        return userList;
    }

}
  • 启动Spring Boot项目，使用Postman工具进行接口测试
  1. 查看程序正常运行是否ok，使用POST 方式进行请求。

http://127.0.0.1:8081/api/user

返回的参数

{"code":"-1","message":"用户姓名不能为空！","result":null}

在这里插入图片描述

  1. 使用PUT 方式进行请求。

在这里插入图片描述

  1. 使用DELETE 方式进行请求。

在这里插入图片描述

  1. 使用GET方式进行请求。

在这里插入图片描述

小pan天天向上
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
自定义全局异常处理，打造更好的用户体验！
奇妙的Bug之旅
01-07 374
MyBatis-Plus 是一个优秀的持久层框架，提供了很多便捷的功能，可以极大地简化开发人员的工作。然而，在实际的开发过程中，我们可能会遇到一些异常情况，如数据库连接失败、SQL语句执行出错等等。为了更好地处理这些异常情况，我们可以自定义全局异常处理器，提供更加友好和详细的错误信息给客户端。在GlobalExceptionHandler的resolveException方法中，可以根据具体的异常情况，编写自定义的异常处理逻辑。@Override。
Springboot之自定义全局异常处理的实现
08-25
Springboot之自定义全局异常处理的实现 Springboot之自定义全局异常处理的实现是指在Springboot框架中，通过自定义异常处理器来捕获和处理全局异常的方法。这种方法可以帮助开发者更好地处理程序中的异常，提高...
Spring boot 自定义全局异常处理
m0_47743175的博客
11-23 973
Spring boot 自定义全局异常处理
全局异常的定义和使用
最新发布
m0_61495361的博客
05-04 199
全局异常的定义和使用
全局统一返回结果包装信息
SuperstarSteven的博客
03-24 480
1.全局统一处理结果类 package com.atguigu.yygh.common.result; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** * 全局统一返回结果类 */ @Data @ApiModel(value = "全局统一返回结果") public class Result<T> { @
Java自定义全局异常类及原理
无
04-28 1924
Java异常类 1.自定义异常 public class BusinessException extends RuntimeException { private int code; private String message; public BusinessException(int code) { super(); this.code = code; } public BusinessException(int code,
自定义全局异常处理
xiaoshitou_2015的博客
04-24 83
中，前端请求的时候服务器发生错误，服务器会返回一堆错误信息，不规范也不好处理。再比如非前后端分离项目是，系统发生错误，也会直接返回一大堆错误信息给用户，导致页面非常的混乱不美观，我们也不需要用户知道发生了什么错误。只返回服务器错误即可。
JAVA 自定义异常 全局捕获
12-04
自己编写异常类型 ，自定义错误异常进行全局捕捉。实现项目全局的拦截定义输出。。。
laravel框架 api自定义全局异常处理方法
10-16
今天小编就为大家分享一篇laravel框架 api自定义全局异常处理方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
springboot搭建以及自定义全局异常
01-12
搭建springboot，运行项目，简单的springboot，利用包装器实现全局的错误异常吗和错误错误信息的自定义
Springboot定义全局异常类详解
qq_40853919的博客
09-06 1687
springboot 全局异常类
@ExceptionHandler 异常拦截器
阿涩的博客
05-13 4655
用法： 1，基本使用方法 Spring的@ExceptionHandler可以用来统一处理方法抛出的异常，比如这样： @ExceptionHandler() public String handleExeption2(Exception ex) { System.out.println("抛异常了:" + ex); ex.printStackTrace(); String resultStr = "异常：默认"; return resultStr; } 当我们使用这
Spring Boot定义全局异常
weixin_43981968的博客
11-14 317
Spring Boot定义全局异常
统一异常处理@ExceptionHandler
热门推荐
hzz_321的博客
07-30 1万+
在开发过程中，我们会遇到很多的异常，比方说：500，如果直接返回给用户，则显得很low，此时我们就需要捕获异常 先举个下例子： 1）简单异常的捕获 public class ErrorController { //一般情况下初学者都会用try-catch来进行简单的异常捕获，如下所示 // 1)一般情况下 public String testError(int a) { i...
自定义全局异常
weixin_34085658的博客
02-27 129
2019独角兽企业重金招聘Python工程师标准>>> ...
gateway统一异常处理返回JSON数据
qq_25453181的博客
06-27 2068
自定义异常处理逻辑 package com.will.gateway.exception; import org.springframework.boot.autoconfigure.web.ErrorProperties; import org.springframework.boot.autoconfigure.web.ResourceProperties; import org.springframework.boot.autoconfigure.web.reactive.error.Defa
自定义异常处理
weixin_42065915的博客
09-06 119
自定义异常 package com.yulang.web.exception; import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotatio
Spring Boot学习笔记-错误处理及自定义
weixin_34355881的博客
12-31 273
2019独角兽企业重金招聘Python工程师标准>>> ...
自定义全局异常 事务
06-07
好的，您想请我讲解关于自定义全局异常和事务的内容，是吗？那我来简单介绍一下。 自定义全局异常是指在程序运行过程中，当出现异常情况时，我们可以自定义处理这些异常，而不是直接抛出系统默认的异常信息。通过...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值