统一结果封装

合集 - 学习笔记(19)

1.java基础学习笔记2024-03-262.mysql学习笔记-单表学习2024-03-263.RestFul风格的开发2024-03-27

4.统一结果封装2024-03-27

5.统一异常处理【学习aop解决异常】2024-03-276.Mybatis学习笔记2024-03-287.最简SpringBoot2024-03-298.SpringBoot+MP+ElementUI【分页】2024-04-019.SpringBoot默认内嵌数据层解决方案2024-04-0110.SpringBoot运维学习笔记2024-04-0111.【NoSQL】SpringBoot+Redis简单使用2024-04-0112.SpringBoot多环境开发2024-04-0213.SpringMVC学习笔记2024-04-0314.SpringMVC拦截器2024-04-0715.Spring整合JUnit，Mybatis2024-04-0716.SpringBoot整合说明2024-04-0717.SpringBoot——测试2024-04-0918.SpringBoot热部署2024-04-0719.Java中子类构造时可以做的事2024-11-21

收起

1、Result

一般来说，增删改返回boolean，查询返回对象或集合，还有其他类型的返回数据，前段解析数据比较麻烦，需要返回一个统一的数据结果

统一数据返回结果类：

1. data：封装数据(各种类型的，例如boolean、null、json等)
2. code：封装操作类型与是否成功，可以使用枚举类
3. msg：封装特殊信息(操作失败返回的错误信息等)

public class Result{
	private Object data;
	private Integer code;
	private String msg;
}

2、案例

public class Result {
    //描述统一格式中的数据
    private Object data;
    //描述统一格式中的编码，用于区分操作，可以简化配置0或1表示成功失败
    private Integer code;
    //描述统一格式中的消息，可选属性
    private String msg;

    public Result() {
    }
	//构造方法是方便对象的创建
    public Result(Integer code,Object data) {
        this.data = data;
        this.code = code;
    }
	//构造方法是方便对象的创建
    public Result(Integer code, Object data, String msg) {
        this.data = data;
        this.code = code;
        this.msg = msg;
    }
	//setter...getter...省略
}

定义返回码Code类：code类中的常量设计也不是固定的，可以根据需要自行增减，例如将查询再进行细分为GET_OK,GET_ALL_OK,GET_PAGE_OK等。

//状态码
public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer DELETE_OK = 20021;
    public static final Integer UPDATE_OK = 20031;
    public static final Integer GET_OK = 20041;

    public static final Integer SAVE_ERR = 20010;
    public static final Integer DELETE_ERR = 20020;
    public static final Integer UPDATE_ERR = 20030;
    public static final Integer GET_ERR = 20040;
}

前端根据返回的结果，先从中获取code,根据code判断，如果成功则取data属性的值，如果失败，则取msg中的值做提示。

@RestController
@RequestMapping("/books")
public class BookController {
    @Autowired
    private BookService bookService;

    @PostMapping
    public Result save(@RequestBody Book book) {
        boolean flag = bookService.save(book);
        return new Result(flag ? Code.SAVE_OK:Code.SAVE_ERR,flag);
    }

    @PutMapping
    public Result update(@RequestBody Book book) {
        boolean flag = bookService.update(book);
        return new Result(flag ? Code.UPDATE_OK:Code.UPDATE_ERR,flag);
    }

    @DeleteMapping("/{id}")
    public Result delete(@PathVariable Integer id) {
        boolean flag = bookService.delete(id);
        return new Result(flag ? Code.DELETE_OK:Code.DELETE_ERR,flag);
    }

    @GetMapping("/{id}")
    public Result getById(@PathVariable Integer id) {
        Book book = bookService.getById(id);
        Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
        String msg = book != null ? "" : "数据查询失败，请重试！";
        return new Result(code,book,msg);
    }

    @GetMapping
    public Result getAll() {
        List<Book> bookList = bookService.getAll();
        Integer code = bookList != null ? Code.GET_OK : Code.GET_ERR;
        String msg = bookList != null ? "" : "数据查询失败，请重试！";
        return new Result(code,bookList,msg);
    }
}