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

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

(0)

相关推荐

  • SpringBoot返回json和xml的示例代码

    有些情况接口需要返回的是xml数据,在springboot中并不需要每次都转换一下数据格式,只需做一些微调整即可. 新建一个springboot项目,加入依赖jackson-dataformat-xml,pom文件代码如下: <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi=&qu

  • SpringBoot之返回json数据的实现方法

    一.创建一个springBoot个项目 操作详情参考:1.SpringBoo之Helloword 快速搭建一个web项目 二.编写实体类 /** * Created by CR7 on 2017-8-18 返回Json数据实体类 */ public class User { private int id; private String username; private String password; public String getPassword() { return password;

  • SpringBoot学习之全局异常处理设置(返回JSON)

    SpringBoot学习--全局异常处理设置(返回JSON) 需求 现在习惯使用ajax的方式发起请求,所以经常需要服务端返回一个json或者字符串. 控制全局的异常处理. 如果在单个方法中使用try,catch把方法包裹起来,工作量大,而且会异常的抛出而导致@Transactional注解的方法事务不会回滚. 说明 使用@ControllerAdvice注解 使用@ExceptionHandler注解 @ControllerAdvice 该注解是spring2.3以后新增的一个注解,主要是用来

  • 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.D

  • Spring Boot统一接口返回及全局异常处理

    目录 1.解决方案 2.具体实现 2.1 定义状态码统一接口 2.2 公共模块状态码枚举类 2.3 定义全局自定义异常 2.4 定义统一接口格式输出类 2.5 定义统一接口格式输出类 2.6 接口统一输出优化 2.7 子系统如何实现 3.子系统定义状态码,实现BaseResultCode接口 前言: 前段时间接手了一个老项目,现在需要在此项目中添加一些新的需求,同事在开发过程中遇到了一些问题? 1.成功的状态到底是200还是0啊,订单系统200代表成功,而会员系统却是0代表成功. 2.接口返回的

  • Spring Boot统一返回体的踩坑记录

    前言 在Spring Boot项目中我们可以通过RestControllerAdvice配合实现ResponseBodyAdvice<T>接口来保证Spring MVC接口具有统一的返回格式,以保证前端同学能够封装统一的数据接收工具.但是很多网上的文章并没有对实际开发中的细节作出更多的讲解.今天胖哥就来分享一下我的采坑经历,也算作一个总结. 控制作用范围 我记得在前面关于Swagger3的文章中提过,如果我们不指定范围将导致Swagger无法识别接口的元信息.因此如果你使用了Swagger必须

  • Spring Boot统一处理全局异常的实战教程

    目录 注解的介绍 @ControllerAdvice @ExceptionHandler拦截异常并统一处理 代码实现 自定义异常 统一异常处理 前端返回值类 测试用例 附:Spring Boot默认的异常处理机制 总结 注解的介绍 @ControllerAdvice @ControllerAdvice注解是Spring3.2中新增的注解,学名是Controller增强器,作用是给Controller控制器添加统一的操作或处理. 这里ControllerAdvice也可以这么理解,其抽象级别应该是

  • spring boot集成smart-doc自动生成接口文档详解

    目录 前言 功能特性 1 项目中创建 /src/main/resources/smart-doc.json配置文件 2 配置内容如下(指定文档的输出路径) 3 pom.xml下添加配置 4 运行插件 5 找到存放路径浏览器打开 6 测试结果 前言 smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法. smart-doc 完全基于

  • Spring Boot 实例代码之通过接口安全退出

    1.在pom.xml中引入actuator, security依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot&l

  • PHP封装XML和JSON格式数据接口操作示例

    本文实例讲述了PHP封装XML和JSON格式数据接口操作.分享给大家供大家参考,具体如下: 使用PHP开发app后端的接口时,我们需要返回数据,最常用的就是XML和JSON格式的数据,那么样返回呢? 1.JSON json数据是最容制造的,只要使用php自带的json_encode()函数就可以简单的制作出json数据了 2.XML xml数据就要复杂一点了,让我们看一下xml数据的格式 那么怎样构造呢? 3.制作生产接口数据的类 <?php //定义生成接口数据类 class Api { /*

  • Spring Boot使用yml格式进行配置的方法

    1.yml 格式 现在大家发现,在springboot里还是要用到配置文件的. 除了使用.properties外,springboot还支持 yml格式. 个人觉得yml格式的可读性和..properties比起来差不多,有时候还没有不如properties 看起来那么规整. 但是考虑到很多springboot项目会使用yml格式,还是简单讲讲,主要目的还是为了读懂其他人的项目. 2.同样内容,不同写法 如图所示,左边是application.properties的写法,右边是applicati

  • Java 实现Redis存储复杂json格式数据并返回给前端

    问题背景 在Java Web项目中,经常需要前端请求数据,后台从数据库中查询并计算最后返回json格式数据给前端. 而每次请求都需要计算一次可能比较浪费时间,这时我们可以将计算好的结果保存在redis中,下次请求时先判断redis中是否已经存在,如果是则直接从redis里取出返回,因为是在内存中,所以比较快. 而自己在项目中遇到的json格式数据比较复杂,下面记录一下redis存储对象和json格式数据的几种方式以及遇到的问题. 存储方式 1. 直接使用String存储 String类型是Red

  • Spring Boot 将yyyy-MM-dd格式的文本字符串直接转换为LocalDateTime出现的问题

    Spring Boot 将yyyy-MM-dd格式的文本字符串直接转换为LocalDateTime出现的问题 问题复现 Exception in thread "main" java.time.format.DateTimeParseException: Text '2020-03-12' could not be parsed: Unable to obtain LocalDateTime from TemporalAccessor: {},ISO resolved to 2020-

随机推荐