# result-spring-boot

**Repository Path**: lin-mt/result-spring-boot

## Basic Information

- **Project Name**: result-spring-boot
- **Description**: 前后端完全分离的项目中，后端返回统一的数据格式，前端只关注数据的处理。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-01-29
- **Last Updated**: 2022-05-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Result Spring Boot

## 项目介绍

后端返回统一格式的数据、提示信息、请求结果，支持国际化。前端对返回的结果做统一处理，只需要关注返回的数据即可。code 怎么设计可以自己自定义，根据业务需求自行进行规定，可以参考阿里巴巴开发手册中第二部分异常日志中的错误码。

> 一个很懒很懒，不经常更新的公众号

<img src="./公众号.bmp" width="50%" height="50%" align="center"/>

## 使用说明

1. pom 引入相关依赖

    ```xml
    <dependency>
        <groupId>com.gitee.lin-mt</groupId>
        <artifactId>result-spring-boot-starter</artifactId>
        <version>1.2.0.RELEASE</version>
    </dependency>
    ``` 
   
2. 配置 application.yaml

    ```yaml
    application:
      result:
        # 默认 Code 与 message 的对应关系的文件
        default-file-name: message.yaml
        # message 国际化文件所在的文件夹
        folder: message
        # message 国际化，请求的国际化标识的 key 名称
        message-i18n-header-key: Accept-Language
    ```
   
   更多配置查看：`com.gitee.linmt.properties.ResultProperties`
   
3. Controller 返回的数据统一使用 `com.gitee.linmt.entity.Result`，简单的返回 CURD 执行结果可以使用 Result 中 CURD 的静态方法。CURD 执行结果返回的统一提示信息配置可以参考 [message.yaml](result-spring-boot-starter-test/src/main/resources/message.yaml)，该文件的全部可配置属性可以参考 `com.gitee.linmt.entity.ResultMessage`。

## 备注

> 国际化中 `message-i18n-header-key` 即为存储国际化的请求 header，对应 message 下的文件名称（不包含扩展名），例如：[message](result-spring-boot-starter-test/src/main/resources/message)，如果在该文件夹下没有找到该请求头的文件名称，则根据 code 在属性 `default-file-name` 配置的文件中匹配对应的 message。

前端处理拦截处理结果示例：[axios.js](axios.js)

## 使用方式及测试

使用示例：[result-spring-boot-starter-test](result-spring-boot-starter-test)

请求示例：[rest-api.http](result-spring-boot-starter-test/rest-api.http)