ToB企服应用市场:ToB评测及商务社交产业平台

标题: 看看人家那后端 API 接口写的，那叫一个优雅！ [打印本页]
作者: 杀鸡焉用牛刀    时间: 2024-8-21 15:54
标题: 看看人家那后端 API 接口写的，那叫一个优雅！
文章泉源：https://www.toutiao.com/article/6694404645827117572
在移动互联网，分布式、微服务盛行的本日，现在项目绝大部门都采用的微服务框架，前后端分离方式，（题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新熟悉一下前端，前端已经很成体系了）。
一般体系的大致整体架构图如下：

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

前端和后端进行交互，前端按照约定请求URL路径，并传入相干参数，后端服务器接收请求，进行业务处理，返回数据给前端。
针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device等），老顾这里就不介绍了，小伙伴们可以自行去了解，也比较简单。
后端服务器如何实现把数据返回给前端？
推荐一个开源免费的 Spring Boot 实战项目：
https://github.com/javastacks/spring-boot-best-practice
返回格式

后端返回给前端我们一般用JSON体方式，界说如下：
  1. {
  2.   #返回状态码
  3.   code:integer,
  4.   #返回信息描述
  5.   message:string,
  6.   #返回值
  7.   data:object
  8. }
复制代码
CODE状态码
code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。
如接口要返回用户权限非常，我们加一个状态码为101吧，下一次又要加一个数据参数非常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了
我们应该可以参考HTTP请求返回的状态码
  1. ：下面是常见的HTTP状态码：
  2. 200 - 请求成功
  3. 301 - 资源（网页等）被永久转移到其它URL
  4. 404 - 请求的资源（网页等）不存在
  5. 500 - 内部服务器错误
复制代码

我们可以参考这样的设计，这样的好处就把错误范例归类到某个区间内，如果区间不够，可以设计成4位数。
  1. #1000～1999 区间表示参数错误
  2. #2000～2999 区间表示用户错误
  3. #3000～3999 区间表示接口异常
复制代码
这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相干的信息描述，可以快速定位。
Message
这个字段相对明白比较简单，就是发生错误时，如何友爱的进行提示。一般的设计是和code状态码一起设计，如

再在枚举中界说，状态码

状态码和信息就会一一对应，比较好维护。
Data
返回数据体，JSON格式，根据不同的业务又不同的JSON体。
我们要设计一个返回体类Result

控制层Controller

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

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

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

那我们来改造一下Controller

代码是不是比较简洁了，也雅观了。
优雅优化

上面我们看到在Result类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：
1、每个方法的返回都是Result封装对象，没有业务寄义
2、在业务代码中，乐成的时候我们调用Result.success，非常错误调用Result.failure。是不是很多余
3、上面的代码，判断id是否为null，其实我们可以使用hibernate validate做校验，没有须要在方法体中做判断。
我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下图

这个和我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。那实现方案是什么呢？
实现方案

小伙伴们怎么去实现是不是有点思绪，在这个过程中，我们需要做几个事情
1、界说一个注解@ResponseResult，表示这个接口返回的值需要包装一下
2、拦截请求，判断此请求是否需要被@ResponseResult注解
3、核心步调就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。
注解类
用来标记方法的返回值，是否需要包装

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

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

上面代码就是判断是否需要返回值包装，如果需要就直接包装。这里我们只处理了正常乐成的包装，如果方法体报非常怎么办？处理非常也比较简单，只要判断body是否为非常类。

怎么做全局的非常处理，篇幅原因，老顾这里就不做介绍了，只要思绪理清楚了，自行改造就行。
重写Controller

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

这个方案另有没有别的优化空间，当然是有的。如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要剖析。当然整体思绪了解，小伙伴们就可以在此底子上面自行扩展。
更多文章推荐：
1.Spring Boot 3.x 教程，太全了！
2.2,000+ 道 Java面试题及答案整理(2024最新版)
3.免费获取 IDEA 激活码的 7 种方式（2024最新版）
觉得不错，别忘了随手点赞+转发哦！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。



欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/) Powered by Discuz! X3.4