return error怎么定义_SpringBoot 系列 web 篇之自定义返回 Http Code 的 n 种姿势

最新推荐文章于 2022-12-31 22:43:06 发布
最新推荐文章于 2022-12-31 22:43:06 发布
阅读量166 收藏 1
点赞数
文章标签： return error怎么定义 vs code 设置返回代码

a0edaa6d7fe92f6459256e9c9a13d5c3.png
200105-SpringBoot 系列 web 篇之自定义返回 Http Code 的 n 种姿势

虽然 http 的提供了一整套完整、定义明确的状态码，但实际的业务支持中，后端并不总会遵守这套规则，更多的是在返回结果中，加一个 code 字段来自定义业务状态，即便是后端 5xx 了，返回给前端的 http code 依然是 200

那么如果我想遵守 http 的规范，不同的 case 返回不同的 http code 在 Spring 中可以做呢?

本文将介绍四种设置返回的 HTTP CODE 的方式

  • @ResponseStatus 注解方式
  • HttpServletResponse#sendError
  • HttpServletResponse#setStatus
  • ResponseEntity

I. 返回 Http Code 的 n 种姿势

0. 环境

进入正文之前，先创建一个 SpringBoot 项目，本文示例所有版本为 spring-boot.2.1.2.RELEASE

(需要测试的小伙伴，本机创建一个 maven 项目，在pom.xml文件中，拷贝下面的配置即可)

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/libs-snapshot-local</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/libs-milestone-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-releases</id>
        <name>Spring Releases</name>
        <url>https://repo.spring.io/libs-release-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

下面所有的方法都放在 ErrorCodeRest 这个类中

@RestController
@RequestMapping(path = "code")
public class ErrorCodeRest {
}

1. ResponseStatus 使用姿势

通过注解@ResponseStatus，来指定返回的 http code, 一般来说，使用它有两种姿势，一个是直接加在方法上，一个是加在异常类上

a. 装饰方法

直接在方法上添加注解，并制定对应的 code

/**
 * 注解方式，只支持标准http状态码
 *
 * @return
 */
@GetMapping("ano")
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "请求参数异常!")
public String ano() {
    return "{"code": 400, "msg": "bad request!"}";
}

实测一下，返回结果如下

➜  ~ curl 'http://127.0.0.1:8080/code/ano' -i
HTTP/1.1 400
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 05 Jan 2020 01:29:04 GMT
Connection: close

{"timestamp":"2020-01-05T01:29:04.673+0000","status":400,"error":"Bad Request","message":"请求参数异常!","path":"/code/ano"}%

当我们发起请求时，返回的状态码为 400，返回的数据为 springboot 默认的错误信息格式

虽然上面这种使用姿势可以设置 http code，但是这种使用姿势有什么意义呢？

如果看过 web 系列教程中的：SpringBoot 系列教程 web 篇之全局异常处理 可能就会有一些映象，配合@ExceptionHandler来根据异常返回对应的状态码

一个推荐的使用姿势，下面表示当你的业务逻辑中出现数组越界时，返回 500 的状态码以及完整的堆栈信息

@ResponseBody
@ExceptionHandler(value = ArrayIndexOutOfBoundsException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public String handleArrayIndexOutBounds(HttpServletRequest request, HttpServletResponse response,
        ArrayIndexOutOfBoundsException e) throws IOException {
    log.info("array index out conf!");
    return "aryIndexOutOfBounds: " + getThrowableStackInfo(e);
}

b. 装饰异常类

另外一种使用姿势就是直接装饰在异常类上，然后当你的业务代码中，抛出特定的异常类，返回的 httpcode 就会设置为注解中的值

/**
 * 异常类 + 注解方式，只支持标准http状态码
 *
 * @return
 */
@GetMapping("exception/500")
public String serverException() {
    throw new ServerException("内部异常哦");
}

@GetMapping("exception/400")
public String clientException() {
    throw new ClientException("客户端异常哦");
}

@ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR, reason = "服务器失联了，请到月球上呼叫试试~~")
public static class ServerException extends RuntimeException {
    public ServerException(String message) {
        super(message);
    }
}

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "老哥，你的请求有问题~~")
public static class ClientException extends RuntimeException {
    public ClientException(String message) {
        super(message);
    }
}

测试结果如下，在异常类上添加注解的方式，优点在于不需要配合@ExceptionHandler写额外的逻辑了；缺点则在于需要定义很多的自定义异常类型

➜  ~ curl 'http://127.0.0.1:8080/code/exception/400' -i
HTTP/1.1 400
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 05 Jan 2020 01:37:07 GMT
Connection: close

{"timestamp":"2020-01-05T01:37:07.662+0000","status":400,"error":"Bad Request","message":"老哥，你的请求有问题~~","path":"/code/exception/400"}%

➜  ~ curl 'http://127.0.0.1:8080/code/exception/500' -i
HTTP/1.1 500
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 05 Jan 2020 01:37:09 GMT
Connection: close

{"timestamp":"2020-01-05T01:37:09.389+0000","status":500,"error":"Internal Server Error","message":"服务器失联了，请到月球上呼叫试试~~","path":"/code/exception/500"}%

注意

  • ResponseStatus 注解的使用姿势，只支持标准的 Http Code（必须是枚举类org.springframework.http.HttpStatus）

2. ResponseEntity

这种使用姿势就比较简单了，方法的返回结果必须是ResponseEntity，下面给出两个实际的 case

@GetMapping("401")
public ResponseEntity<String> _401() {
    return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body("{"code": 401, "msg": "未授权!"}");
}

@GetMapping("451")
public ResponseEntity<String> _451() {
    return ResponseEntity.status(451).body("{"code": 451, "msg": "自定义异常!"}");
}

实测结果

➜  ~ curl 'http://127.0.0.1:8080/code/401' -i
HTTP/1.1 401
Content-Type: text/plain;charset=UTF-8
Content-Length: 34
Date: Sun, 05 Jan 2020 01:40:10 GMT

{"code": 401, "msg": "未授权!"}

➜  ~ curl 'http://127.0.0.1:8080/code/451' -i
HTTP/1.1 451
Content-Type: text/plain;charset=UTF-8
Content-Length: 40
Date: Sun, 05 Jan 2020 01:40:19 GMT

{"code": 451, "msg": "自定义异常!"}

从上面的使用实例上看，可以知道这种使用方式，不仅仅支持标准的 http code，也支持自定义的 code（如返回 code 451)

3. HttpServletResponse

这种使用姿势则是直接操作HttpServletResponse对象，手动录入返回的结果

a. setStatus

/**
 * response.setStatus 支持自定义http code，并可以返回结果
 *
 * @param response
 * @return
 */
@GetMapping("525")
public String _525(HttpServletResponse response) {
    response.setStatus(525);
    return "{"code": 525, "msg": "自定义错误码 525!"}";
}

输出结果

➜  ~ curl 'http://127.0.0.1:8080/code/525' -i
HTTP/1.1 525
Content-Type: text/plain;charset=UTF-8
Content-Length: 47
Date: Sun, 05 Jan 2020 01:45:38 GMT

{"code": 525, "msg": "自定义错误码 525!"}%

使用方式比较简单，直接设置 status 即可，支持自定义的 Http Code 返回

b. sendError

使用这种姿势的时候需要注意一下，只支持标准的 http code，而且 response body 中不会有你的业务返回数据，如

/**
 * send error 方式，只支持标准http状态码; 且不会带上返回的结果
 *
 * @param response
 * @return
 * @throws IOException
 */
@GetMapping("410")
public String _410(HttpServletResponse response) throws IOException {
    response.sendError(410, "send 410");
    return "{"code": 410, "msg": "Gone 410!"}";
}

@GetMapping("460")
public String _460(HttpServletResponse response) throws IOException {
    response.sendError(460, "send 460");
    return "{"code": 460, "msg": "Gone 460!"}";
}

输出结果

➜  ~ curl 'http://127.0.0.1:8080/code/410' -i
HTTP/1.1 410
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 05 Jan 2020 01:47:52 GMT

{"timestamp":"2020-01-05T01:47:52.300+0000","status":410,"error":"Gone","message":"send 410","path":"/code/410"}%

➜  ~ curl 'http://127.0.0.1:8080/code/460' -i
HTTP/1.1 500
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Sun, 05 Jan 2020 01:47:54 GMT
Connection: close

{"timestamp":"2020-01-05T01:47:54.719+0000","status":460,"error":"Http Status 460","message":"send 460","path":"/code/460"}%

从上面的 case 也可以看出，当我们使用 send error 时，如果是标准的 http code，会设置对响应头；如果是自定义的不被识别的 code，那么返回的 http code 是 500

4, 小结

上面介绍了几种常见的设置响应 http code 的姿势，下面小结一下使用时的注意事项

ResponseStatus

  • 只支持标准的 http code
  • 装饰自定义异常类，使用时抛出对应的异常类，从而达到设置响应 code 的效果
    • 缺点对非可控的异常类不可用
  • 结合@ExceptionHandler，用来装饰方法

ResponseEntity

形如：

return ResponseEntity.status(451).body("{"code": 451, "msg": "自定义异常!"}");
  • 我个人感觉是最强大的使用姿势，就是写起来没有那么简洁
  • 支持自定义 code，支持设置 response body

HttpServletResponse

  • setStatus: 设置响应 code，支持自定义 code，支持返回 response body
  • sendError: 只支持标准的 http code，如果传入自定义的 code，返回的 http code 会是 500

II. 其他

web 系列博文

  • 191222-SpringBoot 系列教程 web 篇之自定义请求匹配条件 RequestCondition
  • 191206-SpringBoot 系列教程 web 篇 Listener 四种注册姿势
  • 191122-SpringBoot 系列教程 web 篇 Servlet 注册的四种姿势
  • 191120-SpringBoot 系列教程 Web 篇之开启 GZIP 数据压缩
  • 191018-SpringBoot 系列教程 web 篇之过滤器 Filter 使用指南扩展篇
  • 191016-SpringBoot 系列教程 web 篇之过滤器 Filter 使用指南
  • 191012-SpringBoot 系列教程 web 篇之自定义异常处理 HandlerExceptionResolver
  • 191010-SpringBoot 系列教程 web 篇之全局异常处理
  • 190930-SpringBoot 系列教程 web 篇之 404、500 异常页面配置
  • 190929-SpringBoot 系列教程 web 篇之重定向
  • 190913-SpringBoot 系列教程 web 篇之返回文本、网页、图片的操作姿势
  • 190905-SpringBoot 系列教程 web 篇之中文乱码问题解决
  • 190831-SpringBoot 系列教程 web 篇之如何自定义参数解析器
  • 190828-SpringBoot 系列教程 web 篇之 Post 请求参数解析姿势汇总
  • 190824-SpringBoot 系列教程 web 篇之 Get 请求参数解析姿势汇总
  • 190822-SpringBoot 系列教程 web 篇之 Beetl 环境搭建
  • 190820-SpringBoot 系列教程 web 篇之 Thymeleaf 环境搭建
  • 190816-SpringBoot 系列教程 web 篇之 Freemaker 环境搭建
  • 190421-SpringBoot 高级篇 WEB 之 websocket 的使用说明
  • 190327-Spring-RestTemplate 之 urlencode 参数解析异常全程分析
  • 190317-Spring MVC 之基于 java config 无 xml 配置的 web 应用构建
  • 190316-Spring MVC 之基于 xml 配置的 web 应用构建
  • 190213-SpringBoot 文件上传异常之提示 The temporary upload location xxx is not valid

项目源码

  • 工程：https://github.com/liuyueyi/spring-boot-demo[1]
  • 项目：https://github.com/liuyueyi/spring-boot-demo/blob/master/spring-boot/207-web-response[2]

1. 一灰灰 Blog

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现 bug 或者有更好的建议，欢迎批评指正，不吝感激

下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

  • 一灰灰 Blog 个人博客 https://blog.hhui.top[3]
  • 一灰灰 Blog-Spring 专题博客 http://spring.hhui.top[4]

http://weixin.qq.com/r/FS9waAPEg178rUcL93oH (二维码自动识别)

参考资料

[1]

https://github.com/liuyueyi/spring-boot-demo: https://github.com/liuyueyi/spring-boot-demo

[2]

https://github.com/liuyueyi/spring-boot-demo/blob/master/spring-boot/207-web-response: https://github.com/liuyueyi/spring-boot-demo/blob/master/spring-boot/207-web-response

[3]

https://blog.hhui.top: https://blog.hhui.top

[4]

http://spring.hhui.top: http://spring.hhui.top

weixin_39979167
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Springboot2.0处理自定义异常并返回json
10-15
在Spring Boot 2.0中，处理自定义异常并返回JSON格式的响应是常见的需求，尤其是在构建RESTful API时。本篇文章将详细讲解如何在Spring Boot应用中实现这一功能。 首先，我们需要创建一个自定义异常类。这个类通常...
学习日记--SpringBoot篇--return页面
尘渭
07-12 3977
为什么：使用SpringBoot集成thymeleaf不能返回页面，只能返回zifuch字符串。原因：请检查你是不是在controller使用了@RestController注解。解决方法：1.修改注解为@Controller   2.在方法体中使用ModelAndView。分析：RestController = Controller + Response ，所以返回的内容为字符串。...
JavaScript 异常类型汇总
qq_36291960的博客
10-13 3052
1.Error Error 是最基本的错误类型，其他的错误类型都继承自该类型。Error 对象主要有两个重要属性 message 和 name 分别表示错误信息和错误名称。 程序运行过程中抛出的异常一般都有具体的类型，Error 类型一般都是开发人员自己抛出的异常。 2.SyntaxError - 语法错误 语法错误也称为解析错误。语法错误在任何编程语言中都是最常见的错误类型，表示不符合编程语言的语法规范。 JavaScript 是一门解释性语言，执行一段代码时需要经历 词法分析 -> 语法分析 -&
Http Error-Code List
小黑的技术笔记
01-07 1681
本文是转载，原文地址是：http://blog.csdn.net/sunshinestation/article/details/1869075 400 Invalid syntax. 语法问题 401 Access denied. 访问拒绝 402 Payment required. 必须完整 403 Request forbidden. 请求被禁止 404 O
解决maven发布jar到nexus Return code is: 400错误
热门推荐
Mars
07-16 1万+
一 、错误信息[INFO] --- maven-deploy-plugin:2.8.2:deploy (default-deploy) @ springboot-webservice-plugin --- Downloading from ropeok-snapshots: http://localhost:8081/repository/ropeok-snapshots/com/zyj/spri...
return error怎么定义_自定义一个注解校验接口参数
weixin_39662142的博客
12-03 288
这段时间封装了很多的sdk，有一些sdk要求请求参数做验证，由于封装sdk肯定是用到第三方的依赖越少越好，所以自己不才写了一个注解的校验，本版本校验没有给出自定一点message，如果要可以自己加上，修改一下即可。下面就说一下这个怎么实现的吧：一：注解类：注解类代码如下：package com.blog.annotation.one;import java.lang.annotation...
Netty学习笔记_Springboot实现自定义协议.docx
12-27
Netty学习笔记_Springboot实现自定义协议 本文主要介绍了使用Netty框架在Springboot项目中实现自定义协议的方法。自定义协议是指在网络通信中，使用特定的数据格式来传输数据，以满足特定的业务需求。在本文中，...
springboot_jpa.zip_SpringBoot JPA_jpa_slightokb_springboot
09-21
SpringBoot与JPA的整合是现代Java开发中的常见实践，特别是在构建微服务或者轻量级应用时。SpringBoot以其简洁的配置和强大的依赖管理而受到欢迎，而JPA（Java Persistence API）作为Java官方推荐的ORM（Object-...
java SpringBoot自定义注解,及自定义解析器实现对象自动注入操作
08-24
Java SpringBoot 自定义注解及自定义解析器实现对象自动注入操作 在 Java SpringBoot 框架中，自定义注解和自定义解析器是非常重要的概念，它们可以帮助开发者轻松地实现对象自动注入操作。下面，我们将详细介绍 ...
SpringBoot-Mybatis_springbootmybatis_springboot_java_
09-30
在IT行业中，Spring Boot和MyBatis是两个非常流行的开源框架，它们分别简化了Java Web应用的开发和数据库操作。Spring Boot提供了快速构建独立、生产级应用的方式，而MyBatis则是一个轻量级的持久层框架，允许开发者...
6.3 返回类型和return语句
Micoreal的博客
12-31 1036
无
httpcode返回码和含义
enthan809882的博客
11-15 1767
http状态返回代码 1xx（临时响应） 表示临时响应并需要请求者继续执行操作的状态代码。 http状态返回代码 代码 说明 100 （继续） 请求者应当继续提出请求。 服务器返回此代码表示已收到请求的第一部分，正在等待其余部分。 101 （切换协议） 请求者已要求服务器切换协议，服务器已确认并准备切换。 http状态返回代码 2xx （成功） 表示成功处理了请求的状态代码。 ...
go post 参数_Go 语言 Web 框架 Echo 系列：定制篇4—自定义 Renderer，增强或替换模板引擎...
weixin_39563823的博客
11-22 163
Render，顾名思义，要进行页面渲染。Go 语言不但自带有强大的 http 库，还自带了 HTML 模板引擎。Echo 框架对模板引擎进行了一些额外处理，并提供了给用户自定义页面渲染的接口。本文就相关问题进行探讨。模板渲染Echo 框架的 Context 接口提供了下面的方法进行页面渲染：//echo包中Context接口的方法其中，code 是 HTTP Status，nam...
SqlSugar 使用 表自增 情况下使用ExecuteReturnEntity 需要注意
陈熙之的博客
01-27 2599
正常来说，使用ExecuteReturnEntity，是在事务中，添加之后返回实体，主要是ID。。。再利用ID去赋值到其他表信息。。。 需要注意的是： 1.执行ExecuteReturnEntity方法，主键会使用一次自增，无论是否回滚 2.主键上必须设置IsIdentity = true，否则主键返回0 /// <summary> /// 主键 /// </summary> [SugarColumn(IsPrimaryKey = true, IsIdentity = tr
Spring Boot 中关于自定义异常处理的套路！
aaa31203的博客
05-30 169
在SpringBoot项目中，异常统一处理，可以使用Spring中@ControllerAdvice来统一处理，也可以自己来定义异常处理方案。Spring...
SpringCloud Feign Get请求传对象参数
m0_67391377的博客
03-29 2194
前置说明，有A、B两个服务，A服务调用B服务，B服务接口是Get类型，接受参数对象 feign get请求传对象参数分两种情况 1.版本在2.1之前，如我springboot是2.0.6.RELEASE，springcloud是Finchley.SR2版本，则A服务使用Map map替代对象传给B服务 //A-service @ApiOperation(value = “查询xx”, httpMethod = “GET”) @GetMapping("/maps") public ReturnEntity
return error怎么定义_这一次搞懂Spring自定义标签以及注解解析原理
weixin_39805387的博客
11-25 198
自定义标签解析原理在上一篇分析默认标签解析时看到过这个类DefaultBeanDefinitionDocumentReader的方法parseBeanDefinitions：拉勾IT课小编为大家分解 protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { if (dele...
SpringBoot自定义返回code值
乐昊的博客
12-07 3475
关于HttpStatus 在SpringBoot中关于状态码有一个枚举类型，如下。 public enum HttpStatus { CONTINUE(100, "Continue"), SWITCHING_PROTOCOLS(101, "Switching Protocols"), PROCESSING(102, "Processing"), CHECKPOINT(103, "Checkpoint"), OK(200, "OK"), ... } 通
springboot指定属性返回_SpringBoot入门篇--对于JSON数据的返回以及处理二
最新发布
06-03
很高兴为您解答问题！ 在Spring Boot中，我们可以使用@ConfigurationProperties注解来...这样，当我们访问/app接口时，就会返回一个JSON格式的数据，包含我们在application.properties中定义的属性。 希望能够帮到您！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值