前言

大家好！我是sum墨，一个一线的底层码农，平时喜欢研究和思考一些技术相关的问题并整理成文，限于本人水平，如果文章和代码有表述不当之处，还请不吝赐教。

作为一名从业已达六年的老码农，我的工作主要是开发后端Java业务系统，包括各种管理后台和小程序等。在这些项目中，我设计过单/多租户体系系统，对接过许多开放平台，也搞过消息中心这类较为复杂的应用，但幸运的是，我至今还没有遇到过线上系统由于代码崩溃导致资损的情况。这其中的原因有三点：一是业务系统本身并不复杂；二是我一直遵循某大厂代码规约，在开发过程中尽可能按规约编写代码；三是经过多年的开发经验积累，我成为了一名熟练工，掌握了一些实用的技巧。

BUG对于程序员来说实在是不陌生，当代码出现BUG时，异常也会随之出现，但BUG并不等于异常，BUG只是导致异常出现的一个原因。导致异常发生的原因非常多，本篇文章我也主要只讲一下接口相关的异常怎么处理。

本文参考项目源码地址：summo-springboot-interface-demo

由于文章经常被抄袭，开源的代码甚至被当成收费项，所以源码里面不是全部代码，有需要的同学可以留个邮箱，我给你单独发！

一、接口异常的分类

在接口设计中，应该尽量避免使用异常来进行控制流程。接口应该尽可能返回明确的错误码和错误信息，而不是直接抛出异常。

1. 业务异常（Business Exception）

这是接口处理过程中可能出现的业务逻辑错误，例如参数校验失败、权限不足等。这些异常通常是预期的，并且可以提供相应的错误码和错误信息给调用方。

2. 系统异常（System Exception）

这是接口处理过程中可能出现的非预期错误，例如数据库异常、网络异常等。这些异常通常是未知的，并且可能导致接口无法正常响应。这种错误不仅需要记录异常信息通知系统管理员处理，还需要封装起来做好提示，不能直接把错误返回给用户。

3. 客户端异常（Client Exception）

这是调用方在使用接口时可能出现的错误，例如请求参数错误、请求超时等。这些异常通常是由于调用方的错误导致的，接口本身没有问题。可以根据具体情况选择是否返回错误信息给调用方。

二、接口异常的常见处理办法

1. 异常捕获和处理

在接口的实现代码中，可以使用try-catch语句捕获异常，并进行相应的处理。可以选择将异常转化为合适的错误码和错误信息，然后返回给调用方。或者根据具体情况选择是否记录异常日志，并通知系统管理员进行处理。

2. 统一异常处理器

可以使用统一的异常处理器来统一处理接口异常。在Spring Boot中，可以使用@ControllerAdvice和@ExceptionHandler注解来定义一个全局的异常处理器。这样可以将所有接口抛出的异常统一处理，例如转化为特定的错误码和错误信息，并返回给调用方。

3. 抛出自定义异常

可以根据业务需求定义一些自定义的异常类，继承RuntimeException或其他合适的异常类，并在接口中抛出这些异常。这样可以在异常发生时，直接抛出异常，由上层调用方进行捕获和处理。

4. 返回错误码和错误信息

可以在接口中定义一套错误码和错误信息的规范，当发生异常时，返回对应的错误码和错误信息给调用方。这样调用方可以根据错误码进行相应的处理，例如展示错误信息给用户或者进行相应的逻辑处理。例如这样的弹窗提示

5. 跳转到指定错误页

比如遇到401、404、500等错误时，SpringBoot框架会返回自带的错误页，在这里我们其实可以自己重写一些更美观、更友好的错误提示页，最好还能引导用户回到正确的操作上来，例如这样

而不是下面这样

三、接口异常的统一处理

通过前面两段我们可以发现，造成异常的原因很多，出现异常的地方很多，异常的处理手段也很多。基于以上三多的情况，我们需要一个地方来统一接收异常、统一处理异常，上面提到SpringBoot的@ControllerAdvice注解作为一个全局的异常处理器来统一处理异常。但@ControllerAdvice注解不是万能的，它有一个问题：

对于@ControllerAdvice注解来说，它主要用于处理Controller层的异常情况，即在控制器方法中发生的异常。因为它是基于Spring MVC的控制器层的异常处理机制。而Filter层是位于控制器之前的一层过滤器，它可以用于对请求进行预处理和后处理。当请求进入Filter时，还没有进入到Controller层，所以@ControllerAdvice注解无法直接处理Filter层中的异常。 所以对于Filter中的异常，我们需要单独处理。

1. @ControllerAdvice全局异常处理器的使用

(1)自定义业务异常

由于SpringBoot框架并没有定义业务相关的错误码，所以我们需要自定义业务错误码。该错误码可以根据业务复杂程度进行分类，每个错误码对应一个具体的异常情况。这样前后端统一处理异常时可以根据错误码进行具体的处理逻辑，提高异常处理的准确性和效率。同时，定义错误码还可以方便进行异常监控和日志记录，便于排查和修复问题。

a、定义常见的异常状态码

ResponseCodeEnum.java

1package com.summo.demo.model.response;
2
3
4public enum ResponseCodeEnum {
5    /**
6     * 请求成功
7     */
8    SUCCESS("0000", ErrorLevels.DEFAULT, ErrorTypes.SYSTEM, "请求成功"),
9    /**
10     * 登录相关异常
11     */
12    LOGIN_USER_INFO_CHECK("LOGIN-0001", ErrorLevels.INFO, ErrorTypes.BIZ, "用户信息错误"),
13    /**
14     * 权限相关异常
15     */
16    NO_PERMISSIONS("PERM-0001", ErrorLevels.INFO, ErrorTypes.BIZ, "用户无权限"),
17    /**
18     * 业务相关异常
19     */
20    BIZ_CHECK_FAIL("BIZ-0001", ErrorLevels.INFO, ErrorTypes.BIZ, "业务检查异常"),
21    BIZ_STATUS_ILLEGAL("BIZ-0002", ErrorLevels.INFO, ErrorTypes.BIZ, "业务状态非法"),
22    BIZ_QUERY_EMPTY("BIZ-0003", ErrorLevels.INFO, ErrorTypes.BIZ, "查询信息为空"),
23    /**
24     * 系统出错
25     */
26    SYSTEM_EXCEPTION("SYS-0001", ErrorLevels.ERROR, ErrorTypes.SYSTEM, "系统出错啦，请稍后重试"),
27    ;
28
29    /**
30     * 枚举编码
31     */
32    private final String code;
33
34    /**
35     * 错误级别
36     */
37    private final String errorLevel;
38
39    /**
40     * 错误类型
41     */
42    private final String errorType;
43
44    /**
45     * 描述说明
46     */
47    private final String description;
48
49    ResponseCodeEnum(String code, String errorLevel, String errorType, String description) {
50        this.code = code;
51        this.errorLevel = errorLevel;
52        this.errorType = errorType;
53        this.description = description;
54    }
55
56    public String getCode() {
57        return code;
58    }
59
60    public String getErrorLevel() {
61        return errorLevel;
62    }
63
64    public String getErrorType() {
65        return errorType;
66    }
67
68    public String getDescription() {
69        return description;
70    }
71
72
73    public static ResponseCodeEnum getByCode(Integer code) {
74        for (ResponseCodeEnum value : values()) {
75            if (value.getCode().equals(code)) {
76                return value;
77            }
78        }
79        return SYSTEM_EXCEPTION;
80    }
81
82}
83

b、自定义业务异常类

BizException.java

1package com.summo.demo.exception.biz;
2
3import com.summo.demo.model.response.ResponseCodeEnum;
4import lombok.AllArgsConstructor;
5import lombok.Data;
6import lombok.NoArgsConstructor;
7import lombok.ToString;
8
9@Data
10@AllArgsConstructor
11@NoArgsConstructor
12@ToString
13public class BizException extends RuntimeException {
14
15    /**
16     * 错误码
17     */
18    private ResponseCodeEnum errorCode;
19
20    /**
21     * 自定义错误信息
22     */
23    private String errorMsg;
24
25}
26

(2) 全局异常处理器

BizGlobalExceptionHandler

1package com.summo.demo.exception.handler;
2
3import javax.servlet.http.HttpServletResponse;
4
5import com.summo.demo.exception.biz.BizException;
6import org.springframework.web.bind.annotation.ExceptionHandler;
7import org.springframework.web.bind.annotation.RestControllerAdvice;
8import org.springframework.web.servlet.ModelAndView;
9
10@RestControllerAdvice(basePackages = {"com.summo.demo.controller", "com.summo.demo.service"})
11public class BizGlobalExceptionHandler {
12
13    @ExceptionHandler(BizException.class)
14    public ModelAndView handler(BizException ex, HttpServletResponse response) {
15        ModelAndView modelAndView = new ModelAndView();
16        switch (ex.getErrorCode()) {
17            case LOGIN_USER_INFO_CHECK:
18                // 重定向到登录页
19                modelAndView.setViewName("redirect:/login");
20                break;
21            case NO_PERMISSIONS:
22                // 设置错误信息和错误码
23                modelAndView.addObject("errorMsg", ex.getErrorMsg());
24                modelAndView.addObject("errorCode", ex.getErrorCode().getCode());
25                modelAndView.setViewName("403");
26                break;
27            case BIZ_CHECK_FAIL:
28            case BIZ_STATUS_ILLEGAL:
29            case BIZ_QUERY_EMPTY:
30            case SYSTEM_EXCEPTION:
31            default:
32                // 设置错误信息和错误码
33                modelAndView.addObject("errorMsg", ex.getErrorMsg());
34                modelAndView.addObject("errorCode", ex.getErrorCode().getCode());
35                modelAndView.setViewName("error");
36        }
37        return modelAndView;
38    }
39}
40

(3) 测试效果

@RestControllerAdvice和@ExceptionHandler使用起来很简单，下面我们来测试一下(由于不写界面截图是在太丑，我麻烦ChatGPT帮我写了一套简单的界面)。

a、普通业务异常捕获

第一步、打开登录页

访问链接：http://localhost:8080/login 输入账号、密码，点击登录进入首页

第二步、登录进入首页

第三步、调用一个会报错的接口

再服务启动之前我写了一个根据用户名查询用户的方法，如果查询不到用户的话我会抛出一个异常，代码如下：

1public ResponseEntity<String> query(String userName) {
2  //根据名称查询用户
3  List<UserDO> list = userRepository.list(
4  new QueryWrapper<UserDO>().lambda().like(UserDO::getUserName, userName));
5  if (CollectionUtils.isEmpty(list)) {
6    throw new BizException(ResponseCodeEnum.BIZ_QUERY_EMPTY, "根据用户名称查询用户为空！");
7  }
8  //返回数据
9  return ResponseEntity.ok(JSONObject.toJSONString(list));
10}

这时，我们查询一个不存在的用户访问接口：http://localhost:8080/user/query?userName=sss 因为数据库中没有用户名为sss的这个用户，会抛出一个异常

b、403权限不足异常捕获

第一步、打开登录页

访问链接：http://localhost:8080/login 登录界面使用小B的账号登录

第二步、登录进入首页

第三步、调用删除用户的接口

调用接口：http://localhost:8080/user/delete?userId=2 由于小B的账号只有查询权限，没有删除权限，所以返回403错误页

注意👉🏻：在调试之前需要在application.yml或application.properties配置文件中增加一个配置：server.error.whitelabel.enabled=false 这个配置的意思是是否启用默认的错误页面，这里我们自己写了一套错误页，所以不需要框架自带的配置了。

2. 自定义Filter中异常的处理

由于@ControllerAdvice注解无法捕获自定义Filter中抛出的异常，这里我们就需要使用另外一种方法进行处理：ErrorController接口。

(1) 原理解释

Spring Boot的ErrorController是一个接口，用于定义处理应用程序中发生的错误的自定义逻辑。它允许开发人员以更灵活的方式处理和响应异常，而不是依赖于默认的错误处理机制。：

定制错误页面：通过实现ErrorController接口，可以自定义应用程序的错误页面，以提供更好的用户体验。可以根据不同的异常类型和HTTP状态码提供不同的错误页面或错误信息。
记录错误日志：ErrorController可以用于捕获和记录应用程序中的异常，并将其记录到日志中。这对于问题追踪和排查非常有帮助，可以了解应用程序中发生的错误和异常的详细信息。
重定向或转发请求：通过ErrorController，可以根据错误的类型或其他条件，将请求重定向到不同的URL或转发到其他控制器方法。这对于根据错误情况做出不同的处理非常有用，例如重定向到自定义的错误页面或执行特定的错误处理逻辑。

(2) 使用方法

使用方法直接看看我的代码就知道了。 CustomErrorController.java

1package com.summo.demo.controller;
2
3import javax.servlet.http.HttpServletRequest;
4import javax.servlet.http.HttpServletResponse;
5
6import org.apache.commons.lang3.StringUtils;
7import org.springframework.boot.web.servlet.error.ErrorController;
8import org.springframework.stereotype.Controller;
9import org.springframework.web.bind.annotation.RequestMapping;
10import org.springframework.web.servlet.ModelAndView;
11
12@Controller
13public class CustomErrorController implements ErrorController {
14
15    @RequestMapping("/error")
16    public ModelAndView handleError(HttpServletRequest request, HttpServletResponse response) {
17        //获取当前响应返回的状态码
18        int statusCode = response.getStatus();
19        //如果响应头中存在statusCode，则默认使用这个statusCode
20        if (StringUtils.isNotBlank(response.getHeader("statusCode"))) {
21            statusCode = Integer.valueOf(response.getHeader("statusCode"));
22        }
23        if (statusCode == HttpServletResponse.SC_FOUND) {
24            // 获取Location响应头的值，进行重定向
25            String redirectLocation = response.getHeader("Location");
26            return new ModelAndView("redirect:" + redirectLocation);
27        } else if (statusCode == HttpServletResponse.SC_UNAUTHORIZED) {
28            // 重定向到登录页
29            return new ModelAndView("redirect:/login");
30        } else if (statusCode == HttpServletResponse.SC_FORBIDDEN) {
31            // 返回403页面
32            return new ModelAndView("403");
33        } else if (statusCode == HttpServletResponse.SC_NOT_FOUND) {
34            // 返回404页面
35            return new ModelAndView("404");
36        } else if (statusCode == HttpServletResponse.SC_INTERNAL_SERVER_ERROR) {
37            // 返回500页面，并传递errorMsg和errorCode到模板
38            ModelAndView modelAndView = new ModelAndView("500");
39            modelAndView.addObject("errorMsg", response.getHeader("errorMsg"));
40            modelAndView.addObject("errorCode", response.getHeader("errorCode"));
41            return modelAndView;
42        } else {
43            // 返回其他错误页面
44            return new ModelAndView("error");
45        }
46    }
47
48}

细心的读者可能会看到，statusCode来自于两个地方，第一个是response.getStatus()；第二个是response.getHeader("statusCode")。这两者的区别是第一个是框架自动设置的，第二个则是我根据业务逻辑设置的。原因是在WebFilter中一旦抛出了异常，response.getStatus()一定会是500，即使这个异常是因为用户身份失效导致的。但异常又不得不抛出，所以我通过自定义response的header的方式设置了错误码，传递到/error接口。

(3) 测试效果

a、404错误页，接口找不到

第一步、打开登录页

访问链接：http://localhost:8080/login 输入账号、密码，点击登录进入首页

第二步、登录进入首页

第三步、访问一个不存在的页面

访问链接：http://localhost:8080/xxxx 由于xxxx接口没有被定义过，界面会返回404

b、401错误，用户身份标识为空或无效

这里我做的处理是，如果用户身份标识为空或无效那么我会默认跳转到登录页。测试方法是打开一个无痕界面，随便输入一个链接：http://localhost:8080/user/query 由于Cookie中token不存在，所以我不管访问的是哪个链接，直接将状态码改为401，而CustomErrorController遇到401的错误，会默认重定向到登录页。

四、优化无痕窗口下的重新登录体验

Filter异常的全局处理除了ErrorController之外，还可以通过自定义拦截器的方式实现，这两个东西会一个就行了。这里我再说一个高级一点的东西，举个例子：我在一个无痕窗口调用接口：http://localhost:8080/user/query?userName=小B 因为当前窗口的Cookie中是没有token的，按照401错误的处理方式，我会重定向到登录页去。但这个有一个问题：重新登录之后，进入的是首页，不是调用user/query接口，我还得重新去找这个接口，重新输入参数。而且这要是一个分享页那就尴尬了，登陆完不知道对方分享了啥，用户体验会很差，那么有办法优化这个问题吗？答案是有，如何做，继续看。

1. 在WebFilter中获取当前请求的全路径

所谓全路径就是“http://localhost:8080/user/query?userName=小B” ，如何获取，可以用我这个方法

1/**
2   * 获取完整的路径URL，包括参数
3   *
4   * @param httpServletRequest
5   * @return 路径URL
6*/
7private String getRequestURL(HttpServletRequest httpServletRequest) {
8  String url = httpServletRequest.getRequestURL().toString();
9  String query = httpServletRequest.getQueryString();
10  if (query != null) {
11    url += "?" + query;
12  }
13  return url;
14}

2. 在WebFilter抛出401错误的地方设置httpServletResponse的header

如下

1httpServletResponse.setHeader("redirectURL",URLEncoder.encode(getRequestURL(httpServletRequest), "utf-8"));

因为参数有可能是中文，这里需要用URLEncoder转下义。

3. 在CustomErrorController中获取到这个跳转链接

1// 重定向到登录页或指定页面
2 if (StringUtils.isNotBlank(response.getHeader("redirectURL"))) {
3  return new ModelAndView("redirect:/login?redirectURL=" + response.getHeader("redirectURL"));
4 }

效果如下

可以看到我们在login后面携带了一个redirectURL参数

4. 登录提交时将redirectURL参数一并提交

1 @PostMapping("/login")
2public void userLogin(@RequestParam(required = true) String userName,
3        @RequestParam(required = true) String password,
4        @RequestParam(required = false) String redirectURL,
5        HttpServletRequest httpServletRequest,
6        HttpServletResponse httpServletResponse) {
7  userService.login(userName, password, redirectURL, httpServletRequest, httpServletResponse);
8}

5. 验证通过后重定向到redirectURL

1 try {
2  //如果跳转路径不为空，则直接重定向到跳转路径
3  if (StringUtils.isNotBlank(redirectURL)) {
4    httpServletResponse.sendRedirect(redirectURL);
5    return;
6  }
7 //跳转到登录页
8  httpServletResponse.sendRedirect("/index");
9  } catch (IOException e) {
10  log.error("重定向发生异常", e);
11}

以上就是这个问题的解决方案了，具体代码大家可以看我的demo：summo-springboot-interface-demo

《优化接口设计的思路》系列：第五篇—接口发生异常如何统一处理

前言

一、接口异常的分类

1. 业务异常（Business Exception）

2. 系统异常（System Exception）

3. 客户端异常（Client Exception）

二、接口异常的常见处理办法

1. 异常捕获和处理

2. 统一异常处理器

3. 抛出自定义异常

4. 返回错误码和错误信息

5. 跳转到指定错误页

三、接口异常的统一处理

1. @ControllerAdvice全局异常处理器的使用

(1)自定义业务异常

a、定义常见的异常状态码

b、自定义业务异常类

(2) 全局异常处理器

(3) 测试效果

a、普通业务异常捕获

第一步、打开登录页

第二步、登录进入首页

第三步、调用一个会报错的接口

b、403权限不足异常捕获

第一步、打开登录页

第二步、登录进入首页

第三步、调用删除用户的接口

2. 自定义Filter中异常的处理

(1) 原理解释

(2) 使用方法

(3) 测试效果

a、404错误页，接口找不到

第一步、打开登录页

第二步、登录进入首页

第三步、访问一个不存在的页面

b、401错误，用户身份标识为空或无效

四、优化无痕窗口下的重新登录体验

1. 在WebFilter中获取当前请求的全路径

2. 在WebFilter抛出401错误的地方设置httpServletResponse的header

3. 在CustomErrorController中获取到这个跳转链接

4. 登录提交时将redirectURL参数一并提交

5. 验证通过后重定向到redirectURL

评论区

相关推荐