spring boot 统一JSON格式的接口返回结果的实现

 更新时间:2019年10月08日 15:30:52   作者:ye17186  
这篇文章主要介绍了spring boot 统一JSON格式的接口返回结果的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

前后端分离的项目开发前,会提前规定好数据返回格式,本文以JSON为例。

第一步,定义好JavaBean。

package com.yclouds.myhelper.web.response;
 
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.yclouds.myhelper.web.error.code.BaseEnumError;
import java.io.Serializable;
import lombok.Data;
 
/**
 * 所有服务统一响应数据格式
 *
 * @author ye17186
 * @version 2019/2/15 14:40
 */
@Data
public class ApiResp<T> implements Serializable {
 
  private static final long serialVersionUID = 9211889136173018364L;
 
  /**
   * 正常响应码
   */
  private static final int SUCCESS_CODE = 0;
 
  /**
   * 正常响应消息
   */
  private static final String SUCCESS_MSG = "SUCCESS";
 
  /**
   * 错误码
   */
  private int code = SUCCESS_CODE;
 
  /**
   * 错误信息
   */
  private String msg = SUCCESS_MSG;
 
  /**
   * 响应内容,默认为null
   */
  private T data = null;
 
  /**
   * 是否的正常响应
   *
   * @return true=正常;false=异常
   */
  @JsonIgnore
  public boolean isOK() {
    return code == SUCCESS_CODE;
  }
 
  /**
   * 无data的正常返回
   */
  public static ApiResp retOK() {
    return new ApiResp();
  }
 
  /**
   * 有data的正常返回
   *
   * @param data data内容
   * @param <T> data类型
   */
  public static <T> ApiResp<T> retOK(T data) {
    ApiResp<T> response = new ApiResp<>();
    response.setData(data);
    return response;
  }
 
  /**
   * 无data的失败返回
   *
   * @param error 错误类型
   */
  public static ApiResp retFail(BaseEnumError error) {
    return retFail(error.getCode(), error.getMsg());
  }
 
  /**
   * 有data的失败返回
   *
   * @param error 错误类型
   * @param data 详细错误信息
   */
  public static <T> ApiResp<T> retFail(BaseEnumError error, T data) {
    return retFail(error.getCode(), error.getMsg(), data);
  }
 
  /**
   * 无data的失败返回
   *
   * @param code 错误码
   * @param msg 错误信息
   */
  public static <T> ApiResp<T> retFail(int code, String msg) {
    ApiResp<T> response = new ApiResp<>();
    response.setCode(code);
    response.setMsg(msg);
    return response;
  }
 
  /**
   * 有data的失败返回
   * <br>
   * 失败返回的场景不多,所以没有严格要求T泛型
   *
   * @param code 错误码
   * @param msg 错误信息
   */
  public static <T> ApiResp<T> retFail(int code, String msg, T data) {
    ApiResp<T> response = new ApiResp<>();
    response.setCode(code);
    response.setMsg(msg);
    response.setData(data);
    return response;
  }
}

第二步,在Controller中使用

  @GetMapping("/test1")
  public ApiResp test1() {
 
    return ApiResp.retOK("Hello World");
  }
 
  @GetMapping("/test2")
  public ApiResp test2() {
 
    return ApiResp.retFail(BaseEnumError.SYSTEM_NO_LOGIN);
  }

可以在Postman查看具体的响应内容如下:

当然,ApiResp中的泛型,也可以使用复杂的数据对象。实际开发中,每种错误响应都有自己的响应码code,和错误信息msg,示例中统一定义了一个BaseEnumError的枚举类,具体内容可参照我的github项目https://github.com/ye17186/myhelper-spring-boot-starter

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Java的List集合框架之ArrayList详解

    Java的List集合框架之ArrayList详解

    这篇文章主要介绍了Java的List集合框架之ArrayList详解,ArrayList默认容量为10(构造方法未指定初始容量为0),扩容是利用位运算(右移一位)和直接相加进行1.5倍扩容,需要的朋友可以参考下
    2023-11-11
  • Java调用C++程序的实现方式

    Java调用C++程序的实现方式

    这篇文章主要介绍了Java调用C++程序的实现方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Java项目如何打包成Jar的实现步骤

    Java项目如何打包成Jar的实现步骤

    一般情况下我们都是使用Java项目直接部署发布,有时需要我们将写好的项目打成jar包,方便后期调用,本文主要介绍了Java项目如何打包成Jar,感兴趣的可以了解一下
    2023-11-11
  • MyBatisPlus标准数据层CRUD的使用详解

    MyBatisPlus标准数据层CRUD的使用详解

    这篇文章主要介绍了MyBatisPlus标准数据层CRUD的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • java.lang.NumberFormatException异常解决方案详解

    java.lang.NumberFormatException异常解决方案详解

    这篇文章主要介绍了java.lang.NumberFormatException异常解决方案详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • SpringMVC如何访问WEB-INF jsp过程解析

    SpringMVC如何访问WEB-INF jsp过程解析

    这篇文章主要介绍了SpringMVC如何访问WEB-INF jsp过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-09-09
  • 详解Spring Boot中整合Sharding-JDBC读写分离示例

    详解Spring Boot中整合Sharding-JDBC读写分离示例

    这篇文章主要介绍了详解Spring Boot中整合Sharding-JDBC读写分离示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • Spring中的@Autowired注解深入解析与实战指南

    Spring中的@Autowired注解深入解析与实战指南

    本文介绍了Spring框架中的@Autowired注解,详细讲解了其基本用法、高级用法以及实际应用场景,通过@Autowired注解,Spring容器可以自动将依赖的Bean注入到目标Bean中,从而简化代码并提高可维护性,需要的朋友可以参考下
    2024-11-11
  • Java for循环几种写法整理

    Java for循环几种写法整理

    这篇文章主要介绍了Java for循环几种写法整理的相关资料,需要的朋友可以参考下
    2017-02-02
  • Java实现的打地鼠小游戏完整示例【附源码下载】

    Java实现的打地鼠小游戏完整示例【附源码下载】

    这篇文章主要介绍了Java实现的打地鼠小游戏,结合完整实例形式分析了Java多线程操作及键盘按键响应实现的打地鼠游戏功能相关操作技巧,需要的朋友可以参考下
    2018-07-07

最新评论