看看人家接口写得，那叫一个优雅！

点击上方 java项目开发，选择设为星标前端

优质文章，及时送达vue

来源：https://zhuanlan.zhihu.com/p/265318078
java

在移动互联网，分布式、微服务盛行的今天，如今项目绝大部分都采用的微服务框架，先后端分离方式，（题外话：先后端的工做职责愈来愈明确，如今的前端都称之为大前端，技术栈以及生态圈都已经很是成熟；之前后端人员瞧不起前端人员，那如今后端人员要从新认识一下前端，前端已经很成体系了）。

通常系统的大体总体架构图以下：

须要说明的是，有些小伙伴会回复说，这个架构太简单了吧，太low了，什么网关啊，缓存啊，消息中间件啊，都没有。由于老顾这篇主要介绍的是API接口，因此咱们聚焦点，其余的模块小伙伴们自行去补充。react

接口交互

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

针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device等），老顾这里就不介绍了，小伙伴们能够自行去了解，也比较简单。spring

着重介绍一下后端服务器如何实现把数据返回给前端？数据库

返回格式

后端返回给前端咱们通常用JSON体方式，定义以下：

  
  
   
   
            
   
   
   
   
    
    
             
    
  
  
   
   
            
   
   
{
 #返回状态码
 code:integer, 
 #返回信息描述
 message:string,
 #返回值
 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

控制层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了，简单吧。到此返回的设计思路完成，是否是又简洁，又优雅。

总结

这个方案还有没有别的优化空间，固然是有的。如：每次请求都要反射一下，获取请求的方法是否须要包装，其实能够作个缓存，不须要每次都须要解析。固然总体思路了解，小伙伴们就能够在此基础上面自行扩展。谢谢！！！

- END -

温暖提示

为了方便你们更好的学习，本公众号常常分享一些完整的单个功能案例代码给你们去练习，若是本公众号没有你要学习的功能案例，你能够联系小编（微信：xxf960513）提供你的小需求给我，我安排咱们这边的开发团队免费帮你完成你的案例。

注意：只能提单个功能的需求不能要求功能太多，好比要求用什么技术，有几个页面，页面要求怎么样？

请长按识别二维码

想学习更多的java功能案例请关注

Java项目开发

若是你以为这个案例以及咱们的分享思路不错，对你有帮助，请分享给身边更多须要学习的朋友。别忘了《留言+点在看》给做者一个鼓励哦！

本文分享自微信公众号 - web项目开发（javawebkaifa）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。