Restful Api 错误处理

Bertha 。 2022-03-20 05:50 269阅读 0赞

### 目录描述 ###

*  spring boot 中 默认的错误处理机制
 *   *  404
     *   *  浏览器访问
         *  非浏览器访问
         *  总结
         *  原理
     *  400
     *  方法内部错误
 *  自定义浏览器错误
 *   *  400
     *  500
 *  自定义非浏览器异常
 *   *  自定义异常的默认处理
     *  自定义异常的自定义处理

# spring boot 中 默认的错误处理机制 #

在现在的前后端分离的项目中，我们的rest api 不仅会被浏览器访问，也会被非浏览器访问

## 404 ##

对于一个错误的访问地址 [http://127.0.0.1:8080/xxx][http_127.0.0.1_8080_xxx]

### 浏览器访问 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70]

### 非浏览器访问 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 1]

### 总结 ###

spring boot 错误处理 会对浏览器发出的请求返回html 页面  
对 非浏览器发出的错误请求返回 json数据

404的message都为空

### 原理 ###

核心类

org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController;

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 2]  
此类中只在类上面定义了一个映射路径，而在方法上没有定义具体的路径，所以这两个方法会处理同一个url，  
不同之处是看请求头的accept 中是否带有 text/html ，如果带了就返回一个html页面，如果没有就返回json，  
(同一个url不同情况做不同处理)

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 3]

## 400 ##

我们知道404 就是路径不存在 ，但有些情况下一个状态码不足以说明问题，如400

--------------------

![在这里插入图片描述][20190211111425119.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 4]  
当有BindingResult errors 参数，验证不同过时则返回200

--------------------

对于上面这个方法 如果没有 BindingResult errors 参数，当验证不同过时会直接被spring boot 档回去，返回400错误  
![在这里插入图片描述][20190211111542959.png]  
用postman 请求这个方法http://127.0.0.1:8080/user  
返回json数据

{
      "timestamp": "2019-02-11T03:18:30.367+0000",
      "status": 400,
      "error": "Bad Request",
      "errors": [
        {
          "codes": [
            "MyConstraint.user.username",
            "MyConstraint.username",
            "MyConstraint.java.lang.String",
            "MyConstraint"
          ],
          "arguments": [
            {
              "codes": [
                "user.username",
                "username"
              ],
              "arguments": null,
              "defaultMessage": "username",
              "code": "username"
            }
          ],
          "defaultMessage": "这是一个validate测试",
          "objectName": "user",
          "field": "username",
          "rejectedValue": null,
          "bindingFailure": false,
          "code": "MyConstraint"
        },
        {
          "codes": [
            "NotBlank.user.password",
            "NotBlank.password",
            "NotBlank.java.lang.String",
            "NotBlank"
          ],
          "arguments": [
            {
              "codes": [
                "user.password",
                "password"
              ],
              "arguments": null,
              "defaultMessage": "password",
              "code": "password"
            }
          ],
          "defaultMessage": "密码不能为空",
          "objectName": "user",
          "field": "password",
          "rejectedValue": null,
          "bindingFailure": false,
          "code": "NotBlank"
        }
      ],
      "message": "Validation failed for object='user'. Error count: 2",
      "path": "/user"
    }

这下message也有值了

可见spring boot 对400的状态码会将错误信息收集到errors里面返回给用户

## 方法内部错误 ##

对于400 404 我们的请求都没有进入方法里面就被spring boot 挡回去了

而更多的是方法内部错误的处理  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 5]  
对于这个方法

*  浏览器请求  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 6]  
    这下返回500 服务内部错误，错误消息就是我自己写的那个
 *  非浏览器访问  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 7]

# 自定义浏览器错误 #

## 400 ##

在resources下建立resources文件夹，再创建error文件夹，最后创建404 html错误页面  
![在这里插入图片描述][20190211114408357.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 8]  
运行 测试如下  
![在这里插入图片描述][2019021111434713.png]

这个只对浏览器有作用，非浏览器请求返回错误信息不会变

## 500 ##

和404同理  
![在这里插入图片描述][20190211114943208.png]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 9]  
![在这里插入图片描述][20190211115020600.png]

# 自定义非浏览器异常 #

## 自定义异常的默认处理 ##

*  创建异常类  
    ![在这里插入图片描述][20190211120219900.png]

public class UserNotExistException extends RuntimeException{
    
        private static final long serialVersionUID = -3807424756736653437L;
    
        private String id;// 存放用户不存在的id
    
        public UserNotExistException(String id){
            super("user not exists ! ");
            this.id = id;
        }
    
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    }

*  使用

/**
         * @param idxx
         * @return
         */
        @GetMapping("{id:\\d++}")
        @JsonView(User.UserSimpleView.class)
        public User getInfo4( @PathVariable(name = "id") String idxx){
            System.out.println("=================");
            throw new UserNotExistException(idxx);
        }

*  测试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 10]

## 自定义异常的自定义处理 ##

spring boot 默认情况下不会读错误消息以外的信息

那我们如何拿到异常中的id呢

*  创建ControllerExceptionHandle

/**
     * @version V1.0
     * @Package com.whale.web
     * @Description: 这个类只会处理其他controller抛出来的异常，不会处理请求
     * @date 2019/2/11 12:12
     */
    
    @ControllerAdvice
    public class ControllerExceptionHandle{
    
        @ExceptionHandler(UserNotExistException.class)
        @ResponseBody
        @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
        public Map<String,Object> handleUserNotExeistException(UserNotExistException ex){
            Map<String,Object> result = new HashMap<>();
            result.put("id",ex.getId());
            result.put("messsage",ex.getMessage());
            return result;
        }
    
    }

*  测试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 11]

[http_127.0.0.1_8080_xxx]: http://127.0.0.1:8080/xxx
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70]: /images/20220320/d79bfa25e86c410e9b49c9de4683d610.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 1]: /images/20220320/fc3d3f167ede4f5880139dca4f66b4e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 2]: /images/20220320/d5551fa33d304d0da4938a7fdabbdd3d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 3]: /images/20220320/0adfe8aedf2e40f3a8261dae0e667c71.png
[20190211111425119.png]: /images/20220320/6edf577fcec9498b804cf3d9d39bd08d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 4]: /images/20220320/1048877e3c284516b5a18bebea3976ee.png
[20190211111542959.png]: /images/20220320/7166b7ea4ea047178045df85bc718807.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 5]: /images/20220320/097e354c56ee4752a1bb23aa69c4482c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 6]: /images/20220320/7624084c6a2e40f4bd7208da41e21e6e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 7]: /images/20220320/3c49c6683279411bbc5a369f33c7fd3a.png
[20190211114408357.png]: /images/20220320/4e71adf4bb4b4f71989c250b2853a9ac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 8]: /images/20220320/02940ed00064431d8e716b9c12a8e5a2.png
[2019021111434713.png]: /images/20220320/d0a43ab7b054419eb814755f5e6fd8ec.png
[20190211114943208.png]: /images/20220320/2c7fcecc3a5b4197a50cfef6e1d5b911.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 9]: /images/20220320/c7e6a4ad5aea4612900bb9152be061d6.png
[20190211115020600.png]: /images/20220320/4eef2953e52b40b1afcfa05ebc7eabe7.png
[20190211120219900.png]: /images/20220320/fc08ee41c7fa475ebb66a081f17a3cde.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 10]: /images/20220320/7190420752724ec694b3c26b81be6287.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3VvdGFpbA_size_16_color_FFFFFF_t_70 11]: /images/20220320/369c4f943e6d4f8fa0f875f65e818132.png