springboot 封装的比较好的 统一的返回类型 工具类

相关内容来自腾讯元宝, 作者也属于入门,仅做参考

用的时候要注意包的地址

枚举类 ResultCode

定义各种返回类型, 返回的错误信息我们用枚举定义一些常用的

package com.example.demo.aenum;

public enum ResultCode {
    SUCCESS(200, "操作成功"),
    FAILED(500, "操作失败"),
    VALIDATE_FAILED(400, "参数检验失败"),
    UNAUTHORIZED(401, "暂未登录或token已经过期"),
    FORBIDDEN(403, "没有相关权限"),
    NOT_FOUND(404, "资源不存在");

    private Integer code;
    private String message;

    ResultCode(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer getCode() { return code; }
    public String getMessage() { return message; }
}

Result

返回的类, 利用泛型接受各种类型的返回数据,

最后返回前端的格式统一为

{
    "code": 500,
    "message": "系统内部错误",
    "data": null,
    "timestamp": "2025-12-13 12:33:18",
    "currentDateTime": "2025-12-13 12:33:18"
}

package com.example.demo.autil;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

public class Result<T> {
    private Integer code;    // 状态码
    private String message; // 消息
    private T data;        // 数据
    private String timestamp; // 时间戳

    // 构造方法
    public Result() {
        this.timestamp = this.getCurrentDateTime();
    }

    public Result(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
        this.timestamp = this.getCurrentDateTime();//System.currentTimeMillis();
    }

    public String getCurrentDateTime() {
        return LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
    }

    // getter/setter
    public Integer getCode() { return code; }
    public void setCode(Integer code) { this.code = code; }

    public String getMessage() { return message; }
    public void setMessage(String message) { this.message = message; }

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

    public String getTimestamp() { return timestamp; }
    public void setTimestamp(String timestamp) { this.timestamp = timestamp; }
}

工具类 ResultUtil

package com.example.demo.autil;

import com.example.demo.aenum.ResultCode;

public class ResultUtil {

    /**
     * 成功返回结果
     */
    public static <T> Result<T> success() {
        return new Result<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), null);
    }

    public static <T> Result<T> success(T data) {
        return new Result<T>(ResultCode.SUCCESS.getCode(), ResultCode.SUCCESS.getMessage(), data);
    }

    public static <T> Result<T> success(String message) {
        return new Result<T>(ResultCode.SUCCESS.getCode(), message, null);
    }

    public static <T> Result<T> success(String message, T data) {
        return new Result<T>(ResultCode.SUCCESS.getCode(), message, data);
    }

    /**
     * 失败返回结果
     */
    public static <T> Result<T> failed() {
        return new Result<T>(ResultCode.FAILED.getCode(), ResultCode.FAILED.getMessage(), null);
    }

    public static <T> Result<T> failed(String message) {
        return new Result<T>(ResultCode.FAILED.getCode(), message, null);
    }

    public static <T> Result<T> failed(Integer code, String message) {
        return new Result<T>(code, message, null);
    }

    public static <T> Result<T> failed(ResultCode resultCode) {
        return new Result<T>(resultCode.getCode(), resultCode.getMessage(), null);
    }

    /**
     * 参数验证失败返回结果
     */
    public static <T> Result<T> validateFailed() {
        return failed(ResultCode.VALIDATE_FAILED);
    }

    public static <T> Result<T> validateFailed(String message) {
        return new Result<T>(ResultCode.VALIDATE_FAILED.getCode(), message, null);
    }

    /**
     * 未登录返回结果
     */
    public static <T> Result<T> unauthorized() {
        return failed(ResultCode.UNAUTHORIZED);
    }

    public static <T> Result<T> unauthorized(String message) {
        return new Result<T>(ResultCode.UNAUTHORIZED.getCode(), message, null);
    }

    /**
     * 未授权返回结果
     */
    public static <T> Result<T> forbidden() {
        return failed(ResultCode.FORBIDDEN);
    }

    public static <T> Result<T> forbidden(String message) {
        return new Result<T>(ResultCode.FORBIDDEN.getCode(), message, null);
    }
}

总体封装一下

调用的时候,例如下面

  public Result<?> updateStu(@RequestBody Student student){
        studentService.updateStu(student);
        return ResultUtil.success();
    }

利用多态可以传递多种格式

return ResultUtil.success(student);
return ResultUtil.success("保存成功");
return ResultUtil.success("保存成功", student);