背景

目前鉴于前后端分离开发的流行，现在需要对后端接口返回json数据格式，做统一规范处理

特性要求

要求后端接口统一返回以下格式

{"code": "SUC0000","message": "成功","timestamp": 1669374903292,"data": null
}

code	接口响应状态码
message	接口返回信息
code	接口响应状态码
timestamp	时间戳
data	数据

总体设计实现

利用spring-web带有的控制器增强，@ControllerAdvice，统一包装controller接口的返回值

针对接口成功响应: @ControllerAdvice

针对接口异常响应: @ControllerAdvice + @ExceptionHandler

具体实现样例链接：统一接口包装返回实现

@ControllerAdvice
public class ResponseControllerAdviceImpl implements ResponseBodyAdvice<Object> {private ObjectMapper objectMapper = new ObjectMapper();@Overridepublic boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {GetMapping get = methodParameter.getMethodAnnotation(GetMapping.class);PostMapping post = methodParameter.getMethodAnnotation(PostMapping.class);PutMapping put = methodParameter.getMethodAnnotation(PutMapping.class);DeleteMapping delete = methodParameter.getMethodAnnotation(DeleteMapping.class);String[] methods = new String[0];if (get != null) {methods = get.value();}if (post != null) {methods = post.value();}if (put != null) {methods = put.value();}if (delete != null) {methods = delete.value();}return ArrayUtil.isNotEmpty(methods);}@Overridepublic Object beforeBodyWrite(Object data, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {// 保证后端统一接口返回操作 不影响 swagger.jsonMethod method = methodParameter.getMethod();if (method != null && "openapiJson".equals(method.getName())) {return data;}// 避免返回String类型报错if (data instanceof String) {try {return objectMapper.writeValueAsString(new SuccessTip<>((String) data));} catch (JsonProcessingException ignore) {}}return new SuccessTip<>(data);}
}

Q&A

1. 这里涉及到的知识点

答：这里其实就是单纯的API接口（controller）的返回值包装。所以一定设计到http的知识。
需要理解：HttpMessageConverter、Spring的api处理与返回的流程。

2. 返回String类型值报错

答：这里就是HttpMessageConverter处理流程过程中出现的错误。可调整HttpMessageConverter转换器链的顺序、去除StringHttpMessageConverter、针对string类型单独包装处理（本文采取方式）

3. Springdoc使用统一包装导致swagger页面无api定义

答：这里主要是统一包装，将springdoc的swagger.json也包装了，格式变化，导致swagger无法解析json，出现页面无api定义！可参考具体实现样例中，关于springdoc的处理。修复swagger页面展示api无定义

浅谈后端接口统一及原理相关推荐

后端语言除了java_浅谈后端语言优缺点
浅谈后端语言优缺点兄弟连教育在前不久,回答了一个关于后端语言选型的问题,那么后端语言都有哪些,存在什么样的优缺点?因此兄弟连与大家分享一下心得. 语言优缺点 C/C++ C 语言虽然是非常贴近操作系 ...
【NXP DN 系列】浅谈 DPAA1 Software Architecture 工作原理
浅谈 DPAA1 Software Architecture 工作原理一.介绍 DPAA1 的主要目的是在片上系统( SOC )的 IO 部分内提供智能处理,以进行路由和管理与流量相关的处理工作, ...
php的解析别名,浅谈laravel aliases别名的原理
在laravel发现有些类可以直接use 类名,就能使用了,例如use DB;就可以使用DB类了,问题是DB这个类并不在根命名空间,这里面实际就是用到了别名. 先通过如下例子来分析基本原理建立如下文 ...
浅谈Charles抓取HTTPS原理及HTTP CONNECT
浅谈Charles抓取HTTPS原理在关于HTTPS,你需要知道的全部中,分析了HTTPS的安全通信过程,知道了HTTPS可以有效防止中间人攻击.但用过抓包工具的人都知道,比如Charles,Fid ...
sql在insert的同时把某个字段返回来_项目实践：后端接口统一规范的同时，如何优雅得扩展规范？...
推荐学习春招指南之"性能调优":MySQL+Tomcat+JVM,还怕面试官的轰炸? 这是什么神仙面试宝典?半月看完25大专题,居然斩获阿里P7offer 前言之前写过如何通过 ...
读进程和写进程同步设计_浅谈unix进程进程间通信IPC原理
什么是进程进程间通信进程间通信即为不同进程之间通信,进程同步是进程间通信的一种 unix进程间通信的分类有哪些 System V进程间通信方式包含: System V消息队列 System V信号量 ...
Smart3D系列教程1之《浅谈无人机倾斜摄影建模的原理与方法》
一.引言倾斜摄影测量技术是国际测绘遥感领域近年发展起来的一项高新技术,以大范围.高精度.高清晰的方式全面感知复杂场景,通过高效的数据采集设备及专业的数据处理流程生成的数据成果直观反映地物的外观.位置 ...
浅谈“面向接口编程” ：依赖反转 IOC 与 DI （容器控制反转与依赖注入）
IOC:Inversion of Control Containers and the Dependency Injection "Water" by Andy Huan, Mal ...
浅谈八木天线的特点、原理与制作调整
原文地址:http://blog.sina.com.cn/s/blog_54c9ca5f0100dety.html 作为电磁换能元件,天线在整个无线电通信系统中位置十分重要,质量好坏直接影响着收发信距 ...

浅谈后端接口统一及原理

背景