Java Springboot 项目设计通用返回类

约定不等于承诺〃 2022-12-01 14:19 206阅读 0赞

### 1. API接口返回数据格式 ###

日常在调用其他服务提供的API接口时，常见的返回数据格式为：

>     {"code": xx, "data": xxxx}

因此有必要照猫画虎，在自己的项目中也设计一个通用的数据格式。

### 2. 定义通用数据返回类 ###

首先需要定义一个通用数据返回类： CommonResponseData

import lombok.Data;
    
    /**
     * HTTP通用返回类，返回格式 {"code": xxx, "data": xxx }
     */
    @Data
    public class CommonResponseData {
    
        // 状态码
        private int code;
    
        // 数据内容
        private Object data;
    
        // 通用静态工厂方法
        public static CommonResponseData create(Object data){
            // 设置默认code为0，表示访问正常
            return CommonResponseData.create(data, 0);
        }
    
    
        // 静态工厂方法，重写Code和Data
        public static CommonResponseData create(Object data, int code){
            CommonResponseData returnType = new CommonResponseData();
            returnType.setCode(code);
            returnType.setData(data);
            return returnType;
        }
    }

### 3. 使用通用数据返回类 ###

我们可以在Controller中使用CommonResponseData类来封装返回数据

@RestController
    @RequestMapping(value = "/")
    public class ApiController {
    
        @GetMapping(value = "/test1")
        public CommonResponseData test1(){
            return CommonResponseData.create("ok");
        }
    
        @GetMapping(value = "/test2")
        public CommonResponseData test2(){
            return CommonResponseData.create(1001, "request error");
        }
    }

### 4. 测试效果 ###

通过Postman测试test1接口，返回预期结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvY28zODQ4_size_16_color_FFFFFF_t_70][]

通过Postman测试test2接口，返回预期结果

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvY28zODQ4_size_16_color_FFFFFF_t_70 1][]

### 5. 总结 ###

通过CommonResponseData类非常简单的就实现了API接口通用的返回数据封装，便于被前端或其他系统调用。

在CommonResponseData类中我们定义了code状态码，因此在下一篇文章中介绍[《Java Springboot设计通用错误处理》][Java Springboot]。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvY28zODQ4_size_16_color_FFFFFF_t_70]: /images/20221123/e5c722808eaa4aa99f28a050e461891f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvY28zODQ4_size_16_color_FFFFFF_t_70 1]: /images/20221123/9e97457dcf864da5969259f16d86af34.png
[Java Springboot]: https://blog.csdn.net/coco3848/article/details/108265240