谷粒 | 02 统一返回格式

统一返回格式

1、在公共模块中创建一个子模块common_utils，提取统一返回格式功能

​ 相关依赖在父模块common已经引入，不需要再添加

2、创建一个接口（或枚举类）定义数据返回状态码

包结构也要统一

3、创建统一返回结果的实体类

结构比较固定

@Data //lombok注解，自动生成get和set方法
public class Result {
    @ApiModelProperty(value = "是否成功")
    private Boolean success;

    @ApiModelProperty(value = "状态码")
    private Integer code;

    @ApiModelProperty(value = "提示消息")
    private String message;

    @ApiModelProperty(value = "数据")
    private Map<String, Object> data = new HashMap<String, Object>();

    /*
    构造方法私有，对外只暴露指定的方法，目的是使外界无法自定义，只能统一使用规定好的格式
    */
    private Result() {}

    //对外暴露返回成功静态方法
    public static Result ok() {
        Result r = new Result();
        r.setSuccess(true);
        r.setCode(ResultCode.SUCCESS);
        r.setMessage("成功");
        return r;
    }

    //失败静态方法
    public static Result error() {
        Result r = new Result();
        r.setSuccess(false);
        r.setCode(ResultCode.ERROR);
        r.setMessage("失败");
        return r;
    }

    /*
    return this 目的是实现链式调用
    Result.ok().sucess().message() 或
    Result.error().sucess().message()
    */
    public Result success(Boolean success){
        this.setSuccess(success);
        return this;
    }

    public Result message(String message){
        this.setMessage(message);
        return this;
    }

    public Result code(Integer code){
        this.setCode(code);
        return this;
    }

    public Result data(String key, Object value){
        this.data.put(key, value);
        return this;
    }

    public Result data(Map<String, Object> map){
        this.setData(map);
        return this;
    }
}

四、使用

1、在业务service模块引入common_utils依赖

 <dependency>
            <groupId>com.birdy</groupId>
            <artifactId>common_utils</artifactId>
            <version>0.0.1-SNAPSHOT</version>
 </dependency>

2、controller控制层设置统一返回类型

@ApiOperation(value = "所有讲师列表")
    @GetMapping("findAll")
    public Result findAllTeacher(){
        List<EduTeacher> list = teacherService.list(null);
        return Result.ok().data("list",list);
    }

    @ApiOperation(value = "根据id逻辑删除讲师")
    @DeleteMapping("delete/{id}")
    public Result deleteTeacher(@PathVariable("id") String id){
        boolean flag = teacherService.removeById(id);
        if (flag) {
           return Result.ok(); //删除没有数据，只显示成功或失败
        }else {
           return Result.error();
        }

    }