Springboot统一返回JSON格式响应

Web项目中定义一套通用的数据相应接口将会减少很多冗余,先提供一套通用的数据返回格式。鉴于此类文章较多,本文附上自己学习过程中感觉不错的文章供大家参考:

  1. springboot2.0-统一处理返回结果和异常情况
  2. SpringBoot返回统一的JSON标准格式
  3. spring boot 统一JSON格式的接口返回结果
  4. Spring Boot随手记-统一封装response的格式

注意点:

  1. 若是响应结果类上无其他注解(不适用lombok时),则请求响应结果就如下列所示:

成功响应时:

{
    "code": 0,
    "msg": "操作成功",
    "data": [
        {
            "empId": 1,
            "empName": "雇员1",
            "hiredate": "2021-11-21",
            "sal": 1234.12,
            "deptno": 10
        }
    ]
}

失败响应时:

{
    "code": 500,
    "msg": "系统异常,请稍后重试:/ by zero",
    "data": null
}
  1. 若是想要在请求失败时不显示data,则需要在响应结果的类上加上一个注解:
@JsonSerialize(include= JsonSerialize.Inclusion.NON_NULL)

但该注解在Springboot2.x版本中已经废弃,改变为:

@JsonInclude(JsonInclude.Include.NON_NULL)

添加该注解后请求失败时响应结果为:

{
    "code": 500,
    "msg": "系统异常,请稍后重试:/ by zero"
}

该注解将结果中为null字段拦截,不返回给调用者。

SpringBoot通过使用统一的数据返回格式可以提高开发效率和代码的可维护性。返回统一JSON数据格式可以统一前后端之间的数据交互方式,减少沟通成本,并且提高了代码的可读性和可维护性。 在SpringBoot中,可以定义一个全局异常处理器(GlobalExceptionHandler),用于捕获和处理全局的异常。在异常处理器中,可以定义一个统一的数据返回格式,包括状态码、提示信息和返回数据。当发生异常时,异常处理器会将异常信息封装成统一JSON数据格式返回给前端,以便前端进行处理。 为了实现统一的数据返回格式,可以定义一个响应对象(ResponseObject),包含对应的状态码、提示信息和返回数据。在业务逻辑处理中,统一使用ResponseObject来封装返回的数据,然后再返回给前端。 在控制器层中,可以使用ResponseEntity对象来返回统一JSON数据格式。通过使用ResponseEntity.ok()方法可以返回一个状态码为200的成功响应,然后将ResponseObject对象作为响应的数据。这样,无论是成功还是失败,都能以统一JSON数据格式返回给前端。 在返回数据时,可以添加一些通用的字段,如请求ID、访问时间等,以便用于日志记录和跟踪。 通过采用统一JSON数据返回格式,可以提高代码的可读性、可维护性和规范性,方便前后端的协作和沟通。同时,也可以方便后期的维护和扩展,减少了代码的冗余和重复编写。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值