这篇文章将为大家详细讲解有关Java设计 API 接口如何实现统一格式返回，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。
创新互联建站长期为成百上千客户提供的网站建设服务，团队从业经验10年，关注不同地域、不同群体，并针对不同对象提供差异化的产品和服务；打造开放共赢平台，与合作伙伴共同营造健康的互联网生态环境。为湛江企业提供专业的网站制作、成都网站制作，湛江网站改版等技术服务。拥有10多年丰富建站经验和众多成功案例,为您定制开发。
在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，
（题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新认识一下前端，前端已经很成体系了）
一般系统的大致整体架构图如下：
需要说明的是，有些小伙伴会回复说，这个架构太简单了吧，太low了，什么网关啊，缓存啊，消息中间件啊，都没有。
因为老顾这篇主要介绍的是API接口，所以我们聚焦点，其他的模块小伙伴们自行去补充。
前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。
针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device等），老顾这里就不介绍了，小伙伴们可以自行去了解，也比较简单。
后端服务器如何实现把数据返回给前端？
后端返回给前端我们一般用JSON体方式，定义如下：
{ #返回状态码 code:integer, #返回信息描述 message:string, #返回值 data:object }
CODE状态码
code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。
如接口要返回用户权限异常，我们加一个状态码为101吧，下一次又要加一个数据参数异常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了
我们应该可以参考HTTP请求返回的状态码
：下面是常见的HTTP状态码： 200 - 请求成功 301 - 资源（网页等）被永久转移到其它URL 404 - 请求的资源（网页等）不存在 500 - 内部服务器错误
再在枚举中定义，状态码
我们会在controller层处理业务请求，并返回给前端，以order订单为例
那我们来改造一下Controller
这个和我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。
那实现方案是什么呢？
小伙伴们怎么去实现是不是有点思路，在这个过程中，我们需要做几个事情
定义一个注解@ResponseResult，表示这个接口返回的值需要包装一下
拦截请求，判断此请求是否需要被@ResponseResult注解
核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。
注解类
用来标记方法的返回值，是否需要包装
此代码核心思想，就是获取此请求，是否需要返回值包装，设置一个属性标记。
重写返回体
怎么做全局的异常处理，篇幅原因，老顾这里就不做介绍了，只要思路理清楚了，自行改造就行。
重写Controller
在控制器类上或者方法体上加上@ResponseResult注解，这样就ok了，简单吧。到此返回的设计思路完成，是不是又简洁，又优雅。
这个方案还有没有别的优化空间，当然是有的。
如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。
关于Java设计 API 接口如何实现统一格式返回就分享到这里了，希望以上内容可以对大家有一定的帮助，可以学到更多知识。如果觉得文章不错，可以把它分享出去让更多的人看到。
重庆分公司
重庆分公司
