‍作者：bug菌
✏️博客：CSDN、、infoQ、51CTO等
简介：CSDN|阿里云|华为云|51CTO等社区博客专家，历届博客之星Top30，年度人气作者Top40，51CTO年度博主Top12， | InfoQ | 51CTO等社区优质创作者，全网粉丝算计15w+ ；硬核微信大众号「猿圈美妙屋」，欢迎你的参加！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量材料。

…

✍️温馨提示：本文字数：1999字, 阅读完需：约 5 分钟

本文收录于《Spring Boot从入门到通晓》，专门攻坚指数提高。

本专栏努力打造最硬核 Spring Boot 从零根底到进阶系列学习内容，均为全网独家首发，打造精品专栏，专栏继续更新中…欢迎我们订阅继续学习。

环境阐明：Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

1. 前言

今天和我们讨论的是Spring Boot如何一致处理反常。这儿先说一下我们为什么需求大局一致处理反常？其实理由很简略，由于程序在运转的过程中，不可避免会发生各种各样的错误。比如说用户传过来的参数不正确，无法连接上数据库，或许在计算某个使命的时分超时等。所以我们一般需求合理的抛出各种反常信息。这些反常信息，一旦不处理，前端就会得到一个500的服务器内部错误，直接展现非常的不友好不优雅，所以我们需求将这些反常捕获，并奉告前端，究竟错在了哪里。另一个问题是，我们不或许直接将完好的反常信息回来，由于或许涉及到一些内部的重要信息，不能随意走漏，所以我们还需求对反常信息进行过滤和转换，值给前端回来可读的，简练的，准确的阐明信息。

这便是为什么我们需求大局反常处理。

这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！期望学习的过程中我们仔细听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！

2. 环境阐明

本地的开发环境：

开发工具：IDEA 2021.3

JDK版别： JDK 1.8

Spring Boot版别：2.3.1RELEASE

Maven版别：3.8.2

3.正文

这儿bug菌提供的一种思路是运用大局反常处理器。大局反常处理器不仅能够捕获默认的反常，还能够捕获各种自界说反常。一个简略的大局反常处理器代码如下：

3.1界说大局反常处理器

GlobalExceptionHandler.java

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
    private Map<String, Object> getResult(ErrorCodeEnum e, boolean status) {
        Map<String, Object> map = new HashMap<>();
        map.put("success", status);
        map.put("code", e.getKey());
        map.put("msg", e.getValue());
        return map;
    }
    /**
     * 参数校验不通过
     *
     * @param e       反常信息
     * @param request 恳求信息
     */
    @ExceptionHandler(value = ParamsException.class)
    @ResponseStatus(HttpStatus.OK)
    public Map<String, Object> handleObjectExistException(ParamsException e,
                                                          HttpServletRequest request) {
        return getResult(ErrorCodeEnum.PARAM_EXIST_EXCEPTION, false);
    }
    /**
     * 用户校验不通过
     *
     * @param e       反常信息
     * @param request 恳求信息
     */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(value = TokenExpireException.class)
    public Map<String, Object> handle(TokenExpireException e, HttpServletRequest request) {
        return getResult(ErrorCodeEnum.USER_NOT_LOGIN, false);
    }
    /**
     * 大局反常处理
     *
     * @param e       反常信息
     * @param request 恳求信息
     */
    @ResponseStatus()
    @ExceptionHandler(value = Throwable.class)
    public Map<String, Object> handle(Exception e, HttpServletRequest request) {
        return getResult(ErrorCodeEnum.SYSTEM_ERROR, false);
    }
}

这儿我对所有的反常信息回来成果都做了一致的处理，只回来success，code，msg三个字段。在内部封装了一个getResult私有办法，便于一致处理，然后别离运用不同的办法处理不同的反常信息，比如ParamsException，TokenExpireException，SystemRunningException等

以上的这仨皆属于自界说反常，代码如下：

3.2界说参数反常ParamsException类

这儿先界说参数反常的信息扑捉，思路也比较简略，便是除了msg之外，不需求接纳code，只便于愈加灵活的完成回来值数据。

public class ParamsException extends RuntimeException {
    private static final long serialVersionUID = 1L;
    private String message;
    public ParamsException() {
    }
    public ParamsException(String msg) {
        this.message = msg;
    }
    public ParamsException(ErrorCodeEnum e) {
        this.message = e.getValue();
    }
    @Override
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
}

3.3界说反常TokenExpireException类

这儿我们再来界说一个扑捉token用户登陆信息过期的反常类，目的是更直接用于相关token反常信息的捕捉。由于我们直接也是界说了默认的tokenError错误码枚举，顾我们也是只需求界说msg信息的接纳即可，但假如你都想自界说，那你就把对应的code、success、msg都界说赋值也行，具体代码如下：

package com.example.demo.exception;
import com.example.demo.enums.ErrorCodeEnum;
/**
 * 用户登陆信息过期反常
 */
public class TokenExpireException extends RuntimeException {
    private static final long serialVersionUID = 1L;
    private String message;
    public TokenExpireException() {
    }
    public TokenExpireException(String msg) {
        this.message = msg;
    }
    public TokenExpireException(ErrorCodeEnum e) {
        this.message = e.getValue();
    }
    @Override
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
}

3.4界说一个ExceptionController测验

这儿我们写两个接口直接模拟反常回来，查阅具体的反常信息是否被正常捕捉，然后其他的测验你们就自己玩啦，这儿给我们举个例子。

3.4.1测验参数反常

我们直接界说一个Get恳求，然后设置一个参数，我们在传值的过程中，我们直接传空，我们即可验证是否能捕获参数反常的大局信息回来。

@RestController
@RequestMapping("/exception")
@Api(tags = "大局反常测验模块", description = "大局反常测验模块")
public class ExceptionController {
    @Autowired
    private UserService userService;
    /**
     * 依据用户id查询用户信息
     */
    @GetMapping("/find-user-by-id")
    @ApiOperation(value = "依据用户id查询用户信息", notes = "依据用户id查询用户信息")
    public ResultResponse<UserEntity> saveUser(@RequestParam("userId") String userId) throws ParamsException {
        if (StringUtils.isBlank(userId)) {
            throw new ParamsException(PARAM_EXIST_EXCEPTION);
        }
        return new ResultResponse<>(userService.getById(userId));
    }
}

3.4.2Swagger恳求校验

重启项目，我们将userId参数传空格，我们直接恳求，能够看看接口回来体具体是啥内容？

能够看到，正是我们展现的PARAM_EXIST_EXCEPTION(101001, “参数反常”)这句，我们也能够自界说，也能够采用默认的提示，成功的并一致处理了回来成果。

3.4.3测验token反常

测验代码如下，仅供参阅：

    @GetMapping("/login")
    @ApiOperation(value = "登录", notes = "登录")
    public ResultResponse<Boolean> login(@RequestParam("token") String token) throws TokenExpireException {
        throw new TokenExpireException();
    }

3.4.4Swagger恳求校验

重启项目后恳求一遍，能够看下接口的回来值如下：

能够发现，我们成功的捕获到了默认的Exception反常和自界说的TokenExpireException

反常，并一致处理了回来成果。

两轮测验成果比较令人满意，期望能帮助到我们，剩余的测验或许自界说反常，你们能够大胆发挥，这儿我就不一一赘述啦。

3.5附上接口回来错误码枚举类

具体代码如下，仅供参阅：

/**
 * 接口回来错误码枚举
 */
public enum ErrorCodeEnum implements IEnum {
    /* 体系反常 */
    SYSTEM_RUNNING(100000, "体系运转反常"),
    SYSTEM_ERROR(101000, "体系未知反常"),
    PARAM_EXIST_EXCEPTION(101001, "参数反常"),
    /* token相关 */
    TOKEN_IS_EMPTY(102001, "该恳求没有携带token！请先获取token"),
    TOKEN_IS_INVALID(102002, "token失效，请重新登录！"),
    TOKEN_IS_ERROR(102003, "不合法token！请重新登录！"),
    USER_NOT_LOGIN(103006, "请先登录"),
    ;
    private Integer key;
    private String value;
    ErrorCodeEnum(Integer key, String value) {
        this.key = key;
        this.value = value;
    }
    @Override
    public Integer getKey() {
        return this.key;
    }
    @Override
    public String getValue() {
        return this.value;
    }
}

… …

ok，以上便是我这期的全部内容啦，假如还想学习更多，你能够看看如下的往期热文引荐哦，每天堆集一个奇淫小知识，铢积寸累下去，你一定能成为令人敬仰的大佬。

「赠人玫瑰，手留余香」，我们下期拜拜~~

4. 热文引荐

若想学习更多，能够参阅这篇专栏总结《2023最新首发，全网最全 Spring Boot 学习宝典(附思维导图)》，本专栏努力打造最硬核 Spring Boot 进阶系列学习内容，均为全网独家首发，打造精品专栏，专栏继续更新中。欢迎我们订阅继续学习。

在入门及进阶之途，我必助你一臂之力，体系性学习，从入门到通晓，带你不走弯路，直奔终点；投资自己，永远性价比最高，都这么说了，你还不赶紧来学？？

5. 文末

我是bug菌，CSDN | 阿里云 | 华为云 | 51CTO等社区博客专家，历届博客之星Top30，年度人气作者Top40，51CTO年度博主Top12， | InfoQ | 51CTO等社区优质创作者，全网粉丝算计15w+ ；硬核微信大众号「猿圈美妙屋」，欢迎你的参加！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量材料。

Spring Boot如何全局统一处理异常？这你必须得会！

1. 前言

2. 环境阐明

3.正文

3.1界说大局反常处理器

3.2界说参数反常ParamsException类

3.3界说反常TokenExpireException类

3.4界说一个ExceptionController测验

3.4.1测验参数反常

3.4.2Swagger恳求校验

3.4.3测验token反常

3.4.4Swagger恳求校验

3.5附上接口回来错误码枚举类

4. 热文引荐

5. 文末

作者信息

推广

Spring Boot如何全局统一处理异常？这你必须得会！

1. 前言

2. 环境阐明

3.正文

3.1界说大局反常处理器

3.2界说参数反常ParamsException类

3.3界说反常TokenExpireException类

3.4界说一个ExceptionController测验

3.4.1测验参数反常

3.4.2Swagger恳求校验

3.4.3测验token反常

3.4.4Swagger恳求校验

3.5附上接口回来错误码枚举类

4. 热文引荐

5. 文末

相关文章

Android 切换主题时如何恢复 Dialog？

Compose 动画边学边做 – 夏日彩虹

2023-01-23 技术周刊第 13 期

[译]破解suspend方法

作者信息

推广