增加

Author: dragontree101

readme.md

@@ -27,14 +27,14 @@
  - [服务器目录如何规划？] (服务器目录如何规划.md)
  - [如何规划日志文件和格式？] (如何规划日志文件和格式.md)
  - [接口请求参数如何定义？] (接口请求参数如何定义.md)
- - 接口返回数据结构以及状态码如何定义？
- - 微服务接口如何优雅的暴露给前端进行调用？
- - 在微服务体系中，如何优雅的使用接口文档和前端进行联调？
+ - [接口返回数据结构以及状态码如何定义？] (接口返回数据结构以及状态码如何定义.md)
+ - 如何优雅的使用接口文档？
  - 如何优雅的进行服务更新发布？
  - 服务注册组件如何选择？
  - 如何优雅的使用配置中心？
  - 多个节点定时任务如何设置？
  - 网关应该承担什么功能和能力？
+ - 微服务接口如何优雅的暴露给前端进行调用？
  - 微服务体系中，后台管理平台如何规划？
 
 

接口返回数据结构以及状态码如何定义.md

@@ -0,0 +1,34 @@
+### 数据返回格式
+- 正常返回
+  - `applicaiton/json`格式进行返回数据
+  - `data`具体的业务数据
+  - `http status code`为200
+  - `traceId`为唯一的请求id
+- 业务逻辑异常，为了统一返回的数据结构，统一使用了[zalando/problem](https://github.com/zalando/problem)项目作为返回的数据结构。主要包括:
+  - 定义统一的业务异常类，然后统一捕获该异常类，然后转换数据结构。
+  - `applicaiton/json`格式进行返回数据
+  - `detail`为对应的错误信息简单描述
+  - `code`为对应的业务错误码
+  - `type`为异常请求的uri
+  - `http status code`为200
+  - `traceId`为唯一的请求id
+- 请求异常，统一识别异常类型，然后转换数据结构
+  - `applicaiton/json`格式进行返回数据
+  - `detail`为对应的错误信息简单描述
+  - `code`为对应的业务错误码
+  - `type`为异常请求的uri
+  - `http status code`为400、401、403、404、405、406、415
+  - `traceId`为唯一的请求id
+- 非业务异常类，统一处理
+  - `applicaiton/json`格式进行返回数据
+  - `detail`为对应的错误信息简单描述
+  - `code`为对应的错误码
+  - `type`为异常请求的uri
+  - `http status code`为500、501
+  - `traceId`为唯一的请求id
+
+### 统一异常捕获
+- 通过继承[zalando/problem-spring-web](https://github.com/zalando/problem-spring-web)项目的`ProblemHandling`类
+- 通过使用`@RestControllerAdvice`来统一捕获异常
+- 额外定义业务异常类的统一处理方法
+- 通过使用`ResponseBodyAdvice`接口和`@RestControllerAdvice`来统一添加traceId和请求的uri