前言

在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式。

一般系统的大致整体架构图如下：

本篇关注点为API接口，所以架构图有所不同

接口交互

前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。

后端服务器如何实现把数据返回给前端？

返回格式

后端返回给前端我们一般用JSON体方式，定义如下：

{#成功标志success：boolean,#返回状态码code:integer,#返回信息描述message:string,#时间戳timestamp:long,#返回对象data:object
}

CODE状态码

code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。

如接口要返回用户权限异常，我们加一个状态码为101吧，下一次又要加一个数据参数异常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了

我们应该可以参考HTTP请求返回的状态码

下面是常见的HTTP状态码：
200 - 请求成功
301 - 资源（网页等）被永久转移到其它URL
404 - 请求的资源（网页等）不存在
500 - 内部服务器错误

我们可以参考这样的设计，这样的好处就把错误类型归类到某个区间内，如果区间不够，可以设计成4位数。

#1000～1999 区间表示参数错误
#2000～2999 区间表示用户错误
#3000～3999 区间表示接口异常

这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相关的信息描述，可以快速定位。

Message

这个字段相对理解比较简单，就是发生错误时，如何友好的进行提示。一般的设计是和code状态码一起设计，如：

再在枚举中定义，状态码

状态码和信息就会一一对应，比较好维护。

Data

返回数据体，JSON格式，根据不同的业务又不同的JSON体。

我们要设计一个返回体类Result

/*** @author* 前后端交互数据标准*/
@Data
public class Result<T> implements Serializable{private static final long serialVersionUID = 1L;/*** 成功标志*/private boolean success;/*** 描述*/private String message;/*** 返回代码*/private Integer code;/*** 时间戳*/private long timestamp = System.currentTimeMillis();/*** 结果对象*/private T data;
}

控制层Controller

我们会在controller层处理业务请求，并返回给前端，以order订单为例

我们看到在获得order对象之后，我们是用的Result构造方法进行包装赋值，然后进行返回。小伙伴们有没有发现，构造方法这样的包装是不是很麻烦，我们可以优化一下。

美观美化

我们可以在Result类中，加入静态方法，一看就懂

那我们来改造一下Controller

代码是不是比较简洁了，也美观了。

优雅优化

上面我们看到在Result类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：

每个方法的返回都是Result封装对象，没有业务含义

在业务代码中，成功的时候我们调用Result.success，异常错误调用Result.failure。是不是很多余

上面的代码，判断id是否为null，其实我们可以使用hibernate validate做校验，没有必要在方法体中做判断。

我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下图：

这个和我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。

实现方案

定义一个注解@ResponseResult，表示这个接口返回的值需要包装一下

拦截请求，判断此请求是否需要被@ResponseResult注解

核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。

注解类

用来标记方法的返回值，是否需要包装

拦截器

拦截请求，是否此请求返回的值需要包装，其实就是运行的时候，解析@ResponseResult注解

此代码核心思想，就是获取此请求，是否需要返回值包装，设置一个属性标记。

重写返回体

上面代码就是判断是否需要返回值包装，如果需要就直接包装。

这里我们只处理了正常成功的包装，如果方法体报异常怎么办？处理异常也比较简单，只要判断body是否为异常类。

全局的异常处理自行改造

重写Controller

在控制器类上或者方法体上加上@ResponseResult注解，这样就ok了。到此返回的设计思路完成，是不是又简洁，又优雅。

这个方案还有优化空间，如：

每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。

Java设计API 接口统一返回格式相关推荐

微服务架构之公共模块式中创建API接口统一返回结果ApiResult
微服务架构之API接口统一返回结果ApiResult 一.创建公共模块common步骤二.在api中新建一个ApiCode枚举和ApiResult 三.ApiCode与ApiResult编码如下四 ...
Spring Boot 无侵入式实现API接口统一JSON格式返回
作者 | 小魏小魏我们去那里呀来源 | blog.csdn.net/qq_34347620/article/details/102239179 无侵入式统一返回JSON格式其实本没有没打算写这篇 ...
Spring Boot 无侵入式实现 API 接口统一 JSON 格式返回
点击上方蓝色"方志朋",选择"设为星标" 回复"666"获取独家整理的学习资料! 无侵入式统一返回JSON格式其实本没有没打算写这篇博客 ...
Java 如何设计 API 接口，实现统一格式返回？
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试资料来源:老顾聊技术前言接口交互返回格式控制层Controll ...
java api接口怎么写_Java 如何设计 API 接口，实现统一格式返回？
来源:老顾聊技术前言接口交互返回格式控制层Controller 美观美化优雅优化实现方案前言在移动互联网,分布式.微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式, ...
(转) 服务接口统一返回的格式
1.14.1 统一返回的格式很明显地,默认情况下,我们选择了 JSON 作为统一的格式返回接口结果.这里简单说明一下选取JSON统一返回的原因: JSON当前很流行,且普通接口都采用此格式返回 JS ...
Restful Api 写法——统一返回值
记录Restful Api 自定义统一返回值方式! 以下为示例代码: Code码Java类 package *.*.*;import java.util.ArrayList; import java. ...
统一登录验证统一返回格式统一异常处理的实现
统一登录验证&统一返回格式&统一异常处理的实现一.用户登录权限效验 1.1 最初的用户登录验证 1.2 Spring AOP 用户统一登录验证的问题 1.3 Spring 拦截器 1 ...
如何优雅设计 API 接口，实现统一格式返回？
来源:老顾聊技术前言在移动互联网,分布式.微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式, (题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都 ...

Java设计API 接口统一返回格式

前言