Spring Boot的通用返回类Result

最新推荐文章于 2025-03-14 16:32:13 发布

AGI杂货铺

最新推荐文章于 2025-03-14 16:32:13 发布

阅读量3.2w

点赞数 33

分类专栏：随笔文章标签： SpringBoot java 通用返回类 Result code、msg、data

文章均为基于日常工作整理而成，如不慎侵权，请联系我进行删除。

本文链接：https://blog.csdn.net/StillTogether/article/details/81587627

版权

随笔专栏收录该内容

14 篇文章

订阅专栏

本文介绍了一种Java项目中常见的API响应格式设计方法，包括自定义Result类、枚举类及工具类，并展示了如何在Controller中使用这些工具实现统一的数据响应。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

先构建一个格式确定下来的Result类

public class Result<T> {
    private Integer code;
    private String msg;
    private T data;

    public Result() {
        super();
    }

    public Result(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = 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 T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    @Override
    public String toString() {
        return "Result{" +
                "code=" + code +
                ", msg='" + msg + '\'' +
                ", data=" + data +
                '}';
    }
}

然后构建一个常用的枚举类，内容可以根据项目自定义

public enum ResultEnum {
    //这里是可以自己定义的，方便与前端交互即可
    UNKNOWN_ERROR(-1,"未知错误"),
    SUCCESS(10000,"成功"),
    USER_NOT_EXIST(1,"用户不存在"),
    USER_IS_EXISTS(2,"用户已存在"),
    DATA_IS_NULL(3,"数据为空"),
    ;
    private Integer code;
    private String msg;

    ResultEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

然后就是写一个返回的工具类ResultUtil

public class ResultUtil {

    /**成功且带数据**/
    public static Result success(Object object){
        Result result = new Result();
        result.setCode(ResultEnum.SUCCESS.getCode());
        result.setMsg(ResultEnum.SUCCESS.getMsg());
        result.setData(object);
        return result;
    }
    /**成功但不带数据**/
    public static Result success(){

        return success(null);
    }
    /**失败**/
    public static Result error(Integer code,String msg){
        Result result = new Result();
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }
}

最后就是应用了，在Controller里边调用ResultUtil就可以了

@GetMapping("/test")
    @ResponseBody
    public Result test() throws Exception{
        String str = "程序猿最帅";
        return ResultUtil.success(str);
    }

然后利用Postman测试我们的返回结果