SpringBoot 设置HTTP 响应状态码 (HTTP Status Code)

约定不等于承诺〃 2022-12-24 02:52 284阅读 0赞

# SpringBoot 设置HTTP 响应状态码 (HTTP Status Code) #

HTTP请求响应的内容有很多，包括Body、Cookies、Headers和Status。  
我们最常用的是Body、其次Headers、Cookies。而HTTP Status Code关注得最少。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center]

## HTTP Status Code ##

<table> 
 <thead> 
  <tr> 
   <th>分类</th> 
   <th>分类描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1**</td> 
   <td>信息，服务器收到请求，需要请求者继续执行操作</td> 
  </tr> 
  <tr> 
   <td>2**</td> 
   <td>成功，操作被成功接收并处理</td> 
  </tr> 
  <tr> 
   <td>3**</td> 
   <td>重定向，需要进一步的操作以完成请求</td> 
  </tr> 
  <tr> 
   <td>4**</td> 
   <td>客户端错误，请求包含语法错误或无法完成请求</td> 
  </tr> 
  <tr> 
   <td>5**</td> 
   <td>服务器错误，服务器在处理请求的过程中发生了错误</td> 
  </tr> 
 </tbody> 
</table>

### 常用的几种状态码 ###

<table> 
 <thead> 
  <tr> 
   <th>状态码</th> 
   <th>英文名</th> 
   <th>中文描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>200</td> 
   <td>OK</td> 
   <td>请求成功。一般用于GET与POST请求</td> 
  </tr> 
  <tr> 
   <td>201</td> 
   <td>Created</td> 
   <td>已创建。成功请求并创建了新的资源</td> 
  </tr> 
  <tr> 
   <td>202</td> 
   <td>Accepted</td> 
   <td>已接受。已经接受请求，但未处理完成</td> 
  </tr> 
  <tr> 
   <td>400</td> 
   <td>Bad Request</td> 
   <td>客户端错误，请求包含语法错误或无法完成请求</td> 
  </tr> 
  <tr> 
   <td>401</td> 
   <td>Unauthorized</td> 
   <td>请求要求用户的身份认证</td> 
  </tr> 
  <tr> 
   <td>403</td> 
   <td>Forbidden</td> 
   <td>服务器理解请求客户端的请求，但是拒绝执行此请求</td> 
  </tr> 
  <tr> 
   <td>404</td> 
   <td>Not Found</td> 
   <td>服务器无法根据客户端的请求找到资源（网页）</td> 
  </tr> 
  <tr> 
   <td>500</td> 
   <td>Internal Server Error</td> 
   <td>服务器内部错误，无法完成请求</td> 
  </tr> 
  <tr> 
   <td>501</td> 
   <td>Not Implemented</td> 
   <td>服务器不支持请求的功能，无法完成请求</td> 
  </tr> 
  <tr> 
   <td>503</td> 
   <td>Service Unavailable</td> 
   <td>由于超载或系统维护，服务器暂时的无法处理客户端的请求</td> 
  </tr> 
 </tbody> 
</table>

## SpringBoot示例 ##

@Log(title = "HTTP Status Code 测试", businessType = BusinessType.OTHER)
        @PostMapping("/test")
        public ResponseEntity<AjaxResult> auth(@RequestParam String username, @RequestParam String password)
        { 
            switch (username){ 
                case "200":
                    return ResponseEntity.ok().body(AjaxResult.success());
                case "400":
                    return ResponseEntity.badRequest().body(AjaxResult.error(400,"Bad Request"));
                case "404":
                    return ResponseEntity.notFound().build();
                case "500":
                    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(AjaxResult.error());
                default:
                    return ResponseEntity.status(203).body(AjaxResult.success());
            }
        }

### 状态码200 ###

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

### 状态码 400 ###

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

### 状态码404 ###

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

### 状态码500 ###

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

### 状态码其他 ###

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/d865a4dca13d4a3bbb568f9cd0e5ab8f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/f9bdb50e3aa7436595da120c14fbdc40.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/20201126164017990.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201126164051795.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201126164122922.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu_size_16_color_FFFFFF_t_70_pic_center 5]: https://img-blog.csdnimg.cn/20201126164729673.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2thbmd3ZWlqaWFu,size_16,color_FFFFFF,t_70#pic_center