SpringBoot优雅的统一restful返回结果

阳光穿透心脏的1/2处 2024-04-18 16:21 10阅读 0赞

# 1.为什么要定义通用返回对象： #

项目开发中，一般情况下都会对数据返回的格式做一个统一的要求，一般会包括状态码、信息及数据三部分。定义通用返回对象可以在原返回的数据基础上封装一层，将状态码等信息包含进来。

# 2.案例如下： #

## 1.通过枚举类自定义返回状态码： ##

/**
     * API 统一返回状态码
     */
    public enum ResultCode {
    
        /* 成功状态码 */
        SUCCESS(1, "成功"),
        /* 失败状态码 */
        FAILURE(0, "失败");
    
        private Integer code;
        private String message;
    
        ResultCode(Integer code, String message) {
            this.code = code;
            this.message = message;
        }
    
        public Integer code() {
            return this.code;
        }
    
        public String message() {
            return this.message;
        }
    
        public static String getMessage(String name) {
            for (ResultCode item : ResultCode.values()) {
                if (item.name().equals(name)) {
                    return item.message;
                }
            }
            return name;
        }
    
        public static Integer getCode(String name) {
            for (ResultCode item : ResultCode.values()) {
                if (item.name().equals(name)) {
                    return item.code;
                }
            }
            return null;
        }
    
        @Override
        public String toString() {
            return this.name();
        }
    
    }

## 2.返回的结果封装类 ##

import java.io.Serializable;
    public class Result implements Serializable {
    
        private static final long serialVersionUID = -3948389268046368059L;
    
        private Integer code;
        private String msg;
        private Object data;
    
        public Integer getCode() {
            return code;
        }
    
        public void setCode(Integer code) {
            this.code = code;
        }
    
        public String getMsg() {
            return msg;
        }
    
        public void setMsg(String msg) {
            this.msg = msg;
        }
    
        public Object getData() {
            return data;
        }
    
        public void setData(Object data) {
            this.data = data;
        }
    
        public void setResultCode(ResultCode code) {
            this.code = code.code();
            this.msg = code.message();
        }
    
        //成功 不返回数据直接返回成功信息
        public static Result success() {
            Result result = new Result();
            result.setResultCode(ResultCode.SUCCESS);
            return result;
        }
    
        //成功 并且加上返回数据
        public static Result success(Object data) {
            Result result = new Result();
            result.setResultCode(ResultCode.SUCCESS);
            result.setData(data);
            return result;
        }
    
        //成功 自定义成功返回状态 加上数据
        public static Result success(ResultCode resultCode, Object data) {
            Result result = new Result();
            result.setResultCode(resultCode);
            result.setData(data);
            return result;
        }
    
        // 单返回失败的状态码
        public static Result failure(ResultCode resultCode) {
            Result result = new Result();
            result.setResultCode(resultCode);
            return result;
        }
    
        // 返回失败的状态码及数据
        public static Result failure(ResultCode resultCode, Object data) {
            Result result = new Result();
            result.setResultCode(resultCode);
            result.setData(data);
            return result;
        }
    }

## 3.控制层写法例子： ##

@GetMapping("/person/{id}")
        public Result getPersonById(@PathVariable("id") Integer id) {
            Person person = new Person();
    
            if (id.equals(0)) {
                return Result.failure(ResultCode.FAILURE);
            } else if (id.equals(3)) {
                return Result.failure(ResultCode.FAILURE);
            } else {
                person = personService.selectPersonById(id);
                return Result.success(person);
            }
    
        }

## 4.返回结果 ##

//成功
    {
        "code": 1,
        "msg": "成功",
        "data": {
            "id": 1,
            "name": "a",
            "age": 11,
            "address": "a"
        }
    }
    //失败
    {
        "code": 0,
        "msg": "失败",
        "data": null
    }