Unified return format encapsulation of spring boot API

ityml 2020-11-09 11:48:42
unified return format encapsulation spring


What I bring to you today is Spring Boot API Unified return format encapsulation , When we were working on the project API Interface returns need to be in a unified format , Only in this way can the front-end students handle the data returned by the interface in a unified way , It can also separate the front and rear ends
Pattern development , Just focus on the business , You don't have to deal with every returned result , The central idea is , All results are packaged as json, An error message is thrown through an exception , Return to the front end after unified capture processing , give an example : If you insert a user message , and
This user already exists in the system , Insert failure is returned , We use enumeration to define a return message , Throw by exception .

** explain : I have no official account , As long as this blog , It will also keep the blog updated , If it helps you , I hope you will keep your attention on **

Source code address https://gitee.com/zgc005/resut

Don't talk nonsense Code up

Let's start with the project structure

 ├── LICENSE
├── demo.iml
├── pom.xml
├── re
└── src
├── main
│   ├── java
│   │   └── com
│   │   └── result
│   │   └── demo
│   │   ├── DemoApplication.java
│   │   ├── common
│   │   │   └── config
│   │   ├── global
│   │   │   ├── advice
│   │   │   │   ├── ExceptionResultAdvice.java ———— Exception capture . Handle .
│   │   │   │   └── ResponseResultAdvice.java ———— Interface returns unified encapsulation
│   │   │   ├── annotation
│   │   │   │   └── ResponseResult.java ———— Custom tag It is used to verify whether the interface needs to wrap return And verify that the interface exists
│   │   │   ├── config
│   │   │   │   └── GlobalConfig.java ———— Global configuration , Read *.yml Profile information
│   │   │   ├── enums
│   │   │   │   └── ResultCode.java ———— api Exception enumeration
│   │   │   ├── exception
│   │   │   │   └── BizException.java
│   │   │   ├── filterLists
│   │   │   │   ├── FilterConfig.java ———— Filter To configure
│   │   │   │   └── SignAuthFilter.java ———— Interface request signature verification and other operations
│   │   │   ├── interceptor
│   │   │   │   ├── ResponseResultInterceptor.java It is used to process whether the returned data needs encapsulation
│   │   │   │   └── WebConfigurer.java
│   │   │   ├── result
│   │   │   │   ├── EnumInterface.java
│   │   │   │   └── Result.java
│   │   │   └── sign
│   │   │   ├── BodyReaderHttpServletRequestWrapper.java ———— Processing of request flow
│   │   │   ├── 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

Here are a few core classes

  • ExceptionResultAdvice : All exceptions will be caught by this class , Handle , If there's something new Exception Just add a new method , If a new one is added XXXException Methods
@ExceptionHandler(value = XXXException.class)
public Result XXXexceptionHandler(XXXException xxxexception){
log.info(" System exception handling :{}",xxxexception);
return Result.error();
}
  • ResponseResultAdvice: Rewrite the returned data , This class is mainly used to encapsulate the returned results , And it doesn't have to be in every Controller The method in the , Simplify the code , Focus only on the business .

There's a pit here :ResponseBodyAdvice If the return type is String I'll make a mistake , You can check the reason by yourself , So this place has to be about String Type of data

 @Override
public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
log.info(" Enter return to propose rewriting format In processing ......");
Result result = new Result();
// contain Result The explanation is abnormal
if (body instanceof Result) {
return body;
}
if (body instanceof String) {
String str = JSON.toJSONString(Result.success(body));
return str;
}
return Result.success(body);
}
  • ResponseResult: This is a custom tag , It's mainly used to judge Controller Whether the returned data of the class needs to be encapsulated. The usage is as follows
@Slf4j
@RestController
@RequestMapping(value = "/api")
@ResponseResult
public class Test {
}

stay ResponseResultInterceptor Class will judge and process this tag .

public class ResponseResultInterceptor implements HandlerInterceptor {
public static final String RESPONSE_RESULT_ANN = "RESPONSE-RESULT-ANN";
/**
* The core idea of this code , To get this request , Whether return value packing is needed , Set a property tag .
*
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// Method validation
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;
}

Summary : The logical thinking of object-oriented programming should always run through the whole project , Object encapsulation is also inevitable , A class is an object , A module of multiple classes is also an object , Even in large systems , Every subsystem is an object , This is the same. OOP At the heart of , Everything is the object , So the students who have no object should seize the time to find an object , Only in this way will you know how to be object-oriented !!!

版权声明
本文为[ityml]所创,转载请带上原文链接,感谢

  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课程百度云