Spring Boot API 统一返回格式封装

ityml 2020-11-09 11:48:42
spring API boot 统一 返回


今天给大家带来的是Spring Boot API 统一返回格式封装,我们在做项目的时候API 接口返回是需要统一格式的,只有这样前端的同学才可对接口返回的数据做统一处理,也可以使前后端分离
模式的开发中,只关注于业务,而无需考虑对每一个返回结果做处理,中心思想是,所有结果封装为json,错误信息通过异常抛出,统一捕捉处理后返回前端,举例:如果插入一条用户信息,而
这个用户已经在系统中存在,则返回插入失败,我们用枚举定义一个返回信息,通过异常抛出。

**说明:本人没有公众号,只要这个博客,也会对博客进行持续更新,如果对您有帮助,希望您持续关注**

源码地址https://gitee.com/zgc005/resut

废话少说 上代码

先讲项目结构

 ├── LICENSE
├── demo.iml
├── pom.xml
├── re
└── src
├── main
│   ├── java
│   │   └── com
│   │   └── result
│   │   └── demo
│   │   ├── DemoApplication.java
│   │   ├── common
│   │   │   └── config
│   │   ├── global
│   │   │   ├── advice
│   │   │   │   ├── ExceptionResultAdvice.java ———— 异常捕捉。处理。
│   │   │   │   └── ResponseResultAdvice.java ———— 接口返回统一封装
│   │   │   ├── annotation
│   │   │   │   └── ResponseResult.java ———— 自定义标签 用来验证接口是否需要包装返回 并且验证接口是否存在
│   │   │   ├── config
│   │   │   │   └── GlobalConfig.java ———— 全局配置,读取*.yml 配置文件信息
│   │   │   ├── enums
│   │   │   │   └── ResultCode.java ———— api异常枚举
│   │   │   ├── exception
│   │   │   │   └── BizException.java
│   │   │   ├── filterLists
│   │   │   │   ├── FilterConfig.java ———— Filter 配置
│   │   │   │   └── SignAuthFilter.java ———— 接口请求验签等操作
│   │   │   ├── interceptor
│   │   │   │   ├── ResponseResultInterceptor.java 用来处理返回数据是否需要封装
│   │   │   │   └── WebConfigurer.java
│   │   │   ├── result
│   │   │   │   ├── EnumInterface.java
│   │   │   │   └── Result.java
│   │   │   └── sign
│   │   │   ├── BodyReaderHttpServletRequestWrapper.java ————对请求流处理
│   │   │   ├── HttpUtils.java
│   │   │   └── SignUtil.java
│   │   ├── modules
│   │   │   ├── goods
│   │   │   │   ├── controller
│   │   │   │   │   └── GoodsController.java
│   │   │   │   ├── dao
│   │   │   │   │   └── GoodsDao.java
│   │   │   │   ├── entity
│   │   │   │   │   ├── Goods.java
│   │   │   │   │   ├── GoodsBrandBean.java
│   │   │   │   │   ├── GoodsImage.java
│   │   │   │   │   ├── ProductEntity.java
│   │   │   │   │   └── TestName.java
│   │   │   │   └── service
│   │   │   │   ├── GoodsService.java
│   │   │   │   └── impl
│   │   │   │   └── GoodsServiceImpl.java
│   │   │   ├── order
│   │   │   │   ├── controller
│   │   │   │   ├── dao
│   │   │   │   ├── entity
│   │   │   │   └── service
│ │   │   ├── user
│   │   │   │   ├── controller
│   │   │   │   ├── dao
│   │   │   │   ├── entity
│   │   │   │   └── service
│   │   │   └── util
│   │   │   └── JsonTOpagaData.java
│   │   ├── scheduled
│   │   │   ├── ScheduledMachine.java
│   │   │   └── ScheduledProduct.java
│   │   └── test
│   │   ├── Demo.java
│   │   └── Test.java
│   └── resources
│   ├── application-dev.yml
│   ├── application-pro.yml
│   ├── application-test.yml
│   ├── application.yml
│   └── mapper
│   ├── goods
│   │   └── GoodsDao.xml
│   ├── machine
│   │   └── MachineDao.xml
│   ├── order
│   └── user
└── test
└── java
└── com
└── result
└── demo
└── DemoApplicationTests.java

以下是几个核心的类

  • ExceptionResultAdvice :所有的异常都会通个这个类进行捕捉,处理,如果有新增加的Exception 只需要新增方法即可,如新增一个XXXException的方法
@ExceptionHandler(value = XXXException.class)
public Result XXXexceptionHandler(XXXException xxxexception){
log.info("系统异常处理:{}",xxxexception);
return Result.error();
}
  • ResponseResultAdvice: 重写返回数据,这个类主要是对返回结果进行封装,而不需要在每一个Controller 里的方法进行封装,简化代码,做到只关注业务。

这里有一个坑:ResponseBodyAdvice 返回类型如果是String 的话会报错,原因大家可以自行查看,所以这个地方要对String 类型的数据进行处理

 @Override
public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
log.info("进入返回提重写格式 处理中。。。。。。");
Result result = new Result();
// 包含Result 说明是异常
if (body instanceof Result) {
return body;
}
if (body instanceof String) {
String str = JSON.toJSONString(Result.success(body));
return str;
}
return Result.success(body);
}
  • ResponseResult: 这个是自定义的标签,主要是用来判断Controller 类的返回数据是否需要封装用法如下
@Slf4j
@RestController
@RequestMapping(value = "/api")
@ResponseResult
public class Test {
}

在ResponseResultInterceptor 类里会对这个标签进行判断处理。

public class ResponseResultInterceptor implements HandlerInterceptor {
public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";
/**
* 此代码核心思想,就是获取此请求,是否需要返回值包装,设置一个属性标记。
*
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 方法校验
if (handler instanceof HandlerMethod) {
final HandlerMethod handlerMethod = (HandlerMethod) handler;
final Class<?> clazz = handlerMethod.getBeanType();
final Method method = handlerMethod.getMethod();
if (clazz.isAnnotationPresent(ResponseResult.class)) {
request.setAttribute(RESPONSE_RESULT_ANN, clazz.getAnnotation(ResponseResult.class));
} else if (method.isAnnotationPresent(ResponseResult.class)) {
request.setAttribute(RESPONSE_RESULT_ANN, method.getAnnotation(ResponseResult.class));
}
return true;
} else {
return initResponse(response, ResultCode.API_NOT_EXIST);
}
}
private boolean initResponse(HttpServletResponse response,ResultCode resultCode) throws IOException {
response.setCharacterEncoding("utf-8");
response.setContentType("application/json; charset=utf-8");
PrintWriter writer = response.getWriter();
JSONObject jsonObject = new JSONObject();
jsonObject.put("code", resultCode.getCode());
jsonObject.put("message", resultCode.getMessage());
jsonObject.put("data", null);
writer.write(jsonObject.toString());
return false;
}

小结:对于面向对象编程的逻辑思维要始终贯穿于整个项目,对象的封装也是必然,一个类是对象,多个类组成的模块也是对象,甚至在庞大的系统中,每一个子系统都是一个对象,这也就是OOP的核心 ,一切皆对象,所以没有对象的同学要抓紧时间找个对象,只有这样你才会知道如何面向对象!!!

版权声明
本文为[ityml]所创,转载请带上原文链接,感谢
https://www.cnblogs.com/onehm/p/13947705.html

  1. 【计算机网络 12(1),尚学堂马士兵Java视频教程
  2. 【程序猿历程,史上最全的Java面试题集锦在这里
  3. 【程序猿历程(1),Javaweb视频教程百度云
  4. Notes on MySQL 45 lectures (1-7)
  5. [computer network 12 (1), Shang Xuetang Ma soldier java video tutorial
  6. The most complete collection of Java interview questions in history is here
  7. [process of program ape (1), JavaWeb video tutorial, baidu cloud
  8. Notes on MySQL 45 lectures (1-7)
  9. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  10. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  11. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  12. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  13. 【递归,Java传智播客笔记
  14. [recursion, Java intelligence podcast notes
  15. [adhere to painting for 386 days] the beginning of spring of 24 solar terms
  16. K8S系列第八篇(Service、EndPoints以及高可用kubeadm部署)
  17. K8s Series Part 8 (service, endpoints and high availability kubeadm deployment)
  18. 【重识 HTML (3),350道Java面试真题分享
  19. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  20. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  21. [re recognize HTML (3) and share 350 real Java interview questions
  22. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  23. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  24. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  25. RPC 1: how to develop RPC framework from scratch
  26. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  27. RPC 1: how to develop RPC framework from scratch
  28. 一次性捋清楚吧,对乱糟糟的,Spring事务扩展机制
  29. 一文彻底弄懂如何选择抽象类还是接口,连续四年百度Java岗必问面试题
  30. Redis常用命令
  31. 一双拖鞋引发的血案,狂神说Java系列笔记
  32. 一、mysql基础安装
  33. 一位程序员的独白:尽管我一生坎坷,Java框架面试基础
  34. Clear it all at once. For the messy, spring transaction extension mechanism
  35. A thorough understanding of how to choose abstract classes or interfaces, baidu Java post must ask interview questions for four consecutive years
  36. Redis common commands
  37. A pair of slippers triggered the murder, crazy God said java series notes
  38. 1、 MySQL basic installation
  39. Monologue of a programmer: despite my ups and downs in my life, Java framework is the foundation of interview
  40. 【大厂面试】三面三问Spring循环依赖,请一定要把这篇看完(建议收藏)
  41. 一线互联网企业中,springboot入门项目
  42. 一篇文带你入门SSM框架Spring开发,帮你快速拿Offer
  43. 【面试资料】Java全集、微服务、大数据、数据结构与算法、机器学习知识最全总结,283页pdf
  44. 【leetcode刷题】24.数组中重复的数字——Java版
  45. 【leetcode刷题】23.对称二叉树——Java版
  46. 【leetcode刷题】22.二叉树的中序遍历——Java版
  47. 【leetcode刷题】21.三数之和——Java版
  48. 【leetcode刷题】20.最长回文子串——Java版
  49. 【leetcode刷题】19.回文链表——Java版
  50. 【leetcode刷题】18.反转链表——Java版
  51. 【leetcode刷题】17.相交链表——Java&python版
  52. 【leetcode刷题】16.环形链表——Java版
  53. 【leetcode刷题】15.汉明距离——Java版
  54. 【leetcode刷题】14.找到所有数组中消失的数字——Java版
  55. 【leetcode刷题】13.比特位计数——Java版
  56. oracle控制用户权限命令
  57. 三年Java开发,继阿里,鲁班二期Java架构师
  58. Oracle必须要启动的服务
  59. 万字长文!深入剖析HashMap,Java基础笔试题大全带答案
  60. 一问Kafka就心慌?我却凭着这份,图灵学院vip课程百度云