统一接口返回类的封装Result，超简单易懂适合新手

最新推荐文章于 2024-08-13 01:47:36 发布

psvm_code

最新推荐文章于 2024-08-13 01:47:36 发布

阅读量3.2k

点赞数 5

分类专栏： springboot 文章标签： java

本文链接：https://blog.csdn.net/weixin_43442127/article/details/120119632

版权

springboot 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

本文介绍了在Java基于前后端分离的项目中，如何通过自定义Result工具类来统一处理后端Controller接口返回的JSON数据。通过示例展示了在查找所有用户接口中的应用，返回结果包括状态码、信息和数据字段，使得接口返回格式标准化，提高了代码质量。

摘要由CSDN通过智能技术生成

统一接口返回类的意义：

基于java的前后端分离项目中，前端获取后端controller层接口返回的JSON格式的数据，并展示出来。通常为了提高代码质量，会将后端返回的数据进行统一的格式处理。

自定义工具类取名为Result

import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data  //getter和setter函数
@AllArgsConstructor //全参构造
@NoArgsConstructor   //无参构造
@Accessors(chain = true)//可以链式操作，默认是false
public class Result<T>{
    private int code; //状态码

    private String message;  //信息

    private T data;  //数据
}

在controller中接口返回类型定义为Result，添加一个测试接口，查找所有用户。

    //查找所有用户
    @GetMapping("find")
    public Result find(){
        //userService.findAll() 为查找所有用户所得的结果
        return new Result().setCode(200).setData(userService.findAll()).setMessage("查找成功");
    }

接着在postman中输入

http://localhost:8080/find

得到返回结果如图：