概述

简介（What）

peacetrue-result 是一个响应结果组件，用于统一处理接口返回的数据。

特性

• 优化响应结果编码体系

• 人性化响应结果描述

• 国际化响应结果描述

• 自动装配成功响应结果

• 自动装配异常响应结果

背景（Why）

服务端接口返回数据时，往往需要提供一些属性，指示服务端对此次请求的处理状态（响应状态）。 如果处理成功，客户端可以正常执行接下来的业务； 如果处理失败，则需要根据失败原因针对性处理。

假设，服务端需要返回如下格式的用户数据：

{
    "id": 1,
    "name": "张三"
}

封装响应状态之后，返回的数据如下：

响应结果

{
    "code": "success",//(1)
    "message": "操作成功",//(2)
    "data": { //(3)
      "id": 1,
      "name": "张三"
    }
}

1. 编码：指示响应状态的唯一标志

2. 描述：用于操作失败时分析具体原因

3. 数据：存放实际需要返回的数据

响应结果组件提供了标准的数据结构， 封装了成功时的数据和失败时的异常， 优化了失败时的提示信息，使调用者可以快速定位原因。

用法（How）

运行环境

• JDK 1.8 及以上

• Spring Boot 1 系列最高版本 1.5.22.RELEASE，对应组件 1 系列版本

• Spring Boot 2 系列最低版本   2.0.0.RELEASE，对应组件 2 系列版本

核心类库，提供响应结果的数据结构和常用类型。

<dependency>
  <groupId>com.github.peacetrue.result</groupId>
  <artifactId>peacetrue-result-core</artifactId>
  <version>2.1.0</version>
</dependency>

构建类库，构造响应结果描述信息，支持国际化

<dependency>
  <groupId>com.github.peacetrue.result</groupId>
  <artifactId>peacetrue-result-builder</artifactId>
  <version>2.1.0</version>
</dependency>

成功类库，封装成功时返回的数据

<dependency>
  <groupId>com.github.peacetrue.result</groupId>
  <artifactId>peacetrue-result-success</artifactId>
  <version>2.1.0</version>
</dependency>

异常类库，封装异常时返回的数据，提供抽象的异常转换体系

<dependency>
  <groupId>com.github.peacetrue.result</groupId>
  <artifactId>peacetrue-result-exception</artifactId>
  <version>2.1.0</version>
</dependency>

异常支持类库，实现具体异常的转换

<dependency>
  <groupId>com.github.peacetrue.result</groupId>
  <artifactId>peacetrue-result-exception-support</artifactId>
  <version>2.1.0</version>
</dependency>

参与者（Who）

1. peace(xiayouxue@hotmail.com)

活动（When）

初始提交于 2021-08-14，最近提交于 2022-10-30。

许可证（License）

Apache License 2.0