springboot综合项目练习三定义微服务接口返回规范

接上个内容:

一. 需求说明
参与过前后端开发的后端开发人员就明白在项目接口开发中有一套规范的接口返回格式的必要性.这里我主要是结合了我之前项目和网上资源自己定义的一套接口返回规范.作为项目综合练习使用.有需要的同学可以参考下.如果有更好的实现方式欢迎留言

二. 实现方案
在common项目中定义一套统一的接口返回规范,项目的所有接口返回都需要按照这套规范开发.

1. ResulCode:返回代码的父类接口,规定了返回结果code必须要有的数据结构,所有新创建的返回code都需要实现ResulCode接口
2. CommonCode:项目公共默认返回结果枚举类,实现ResulCode,并在枚举中列举项目的公共返回code
3. Response:结果返回实体类的父接口,规定了最终返回接口的数据结构,例如flag,code,message等字段,所有接口最终返回封装bean都要实现Response
4. ResponseResult: 一般接口返回实体类,可以用来返回默认结果
5. QueryResult定义的一种查询接口查询数据的结构,例如列表查询需要有的list和total
6. QueryResponseResult: list查询接口的返回类型
7. ResultCodeConstant: 存放常量
   说明:作为顶层的接口和父类,一般来说定义好了之后就不会再变更,实现类则是根据具体的业务场景定义的,例如在CommonCode定义了公共的接口返回code,如果有新的返回结果,可以在这个类里面添加,也可以根据需要新建一个例如OrderCode去实现.还有如果有新的查询结构类型,也可以考虑新增QueryResult,QueryResponseResult

三. 代码实现

1. 打开项目,这个功能主要是作为公共模块,所以将代码写在common模块中,打开common模块,新建package和类,大概如下