https://github.com/deepexi/payload-spring-boot-starter

Unified the return value starter
https://github.com/deepexi/payload-spring-boot-starter

Last synced: 4 months ago
JSON representation

Unified the return value starter

• Host: GitHub
• URL: https://github.com/deepexi/payload-spring-boot-starter
• Owner: deepexi
• Created: 2019-10-14T10:04:08.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-26T22:25:20.000Z (about 3 years ago)
• Last Synced: 2025-10-30T00:53:56.073Z (8 months ago)
• Language: Java
• Size: 40 KB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# payload-spring-boot-starter

[![Build Status](https://travis-ci.org/deepexi/payload-spring-boot-starter.svg?branch=master)](https://travis-ci.org/deepexi/payload-spring-boot-starter) 

[![codecov](https://codecov.io/gh/deepexi/payload-spring-boot-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/deepexi/payload-spring-boot-starter)

[![Maven Central](https://img.shields.io/maven-central/v/com.github.deepexi/pojo-converter-spring-boot-starter.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.deepexi%22%20AND%20a:%22pojo-converter-spring-boot-starter%22)

将项目中统一结果返回对象的相关内容抽离出来，封装成一个独立的starter，方便在Spring Boot至使用。

## 版本信息

基于 **Spring Boot：2.1.9.RELEASE** 构建

## Getting Started

  实现自定义的Converter，然后引入starter坐标后，调用ConverterUtils的方法即可进行转化，

  具体使用参考[Test Demo](https://github.com/deepexi/payload-spring-boot-starter/tree/master/src/test/java/com/deepexi/payload)

  

  

### 引入坐标

  

```xml

    com.github.deepexi

    payload-spring-boot-starter

    1.0.0-release

```

     

#### 配置

见配置文件中 **spring.mvc.payload** 属性的自动提示

可自定义返回属性名称

```yaml

spring:

  mvc:

    payload:

      payload-map:

        code: code

        success: success

        message: message

        payload: payload

```

      

 ##### 统一结果 @Payload

  

Controller *@RestController* 类上使用 **@Payload** 注解，自动对返回的数据进行包装。

 ```java

@Payload

@RequestMapping("/users")

@RestController

public class MyController {

    @GetMapping("/{id}")

    public User get(@PathVariable Integer id) {

      return user;

    }

}

```

响应结果格式如下：

```json

{

  "code": "1",

  "payload": {

     "k1": "v1",

     "k2": "v2"

  },

  "success": true

}

```

##### 异常处理  @BizErrorResponseStatus

继承RuntimeException类，并加上 **@BizErrorResponseStatus("00000-0000-0001")** 注解，值为自定义的错误码，

异常消息参数message也会一同响应返回。

```java

@BizErrorResponseStatus("00000-0000-0001")

public class CustomerException extends RuntimeException {

   public CustomerException(String message){

        super(message);

   }

}

```

响应结果格式如下：

```json

{

    "success": false,

    "message": "message",

    "code": "00000-0000-0001"

}

```

### TODO

**扩展返回字段**