springboot学习系列前后端分离项目对数据接口返回结果封装_java 前后端分离后台一个接口返回不同结构类型的数据如何封装-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_45848992/article/details/120013060

该博客介绍了如何定义一个枚举类`ResponseCode`来表示接口的各种状态码，如请求成功、失败、参数检验失败等，并创建了一个通用响应类`CommonResponse`用于封装接口返回的结果，包括数据、状态码和错误信息。通过提供静态工厂方法，简化了创建不同类型的响应对象的过程。在实际应用中，`UserController`的示例展示了如何使用这些响应对象返回用户列表。

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

定义接口状态码枚举类

public enum ResponseCode {
    SUCCESS(200, "请求成功"),
    FAILED(500, "请求失败"),
    VALIDATE_FAILED(404, "参数检验失败"),
    UNAUTHORIZED(401, "暂未登录或token已经过期"),
    FORBIDDEN(403, "没有相关权限");
    private long code;
    private String message;

    ResponseCode(long code, String message) {
        this.code = code;
        this.message = message;
    }

    public long getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

对接口返回结果进行封装

public class CommonResponse<T> {
    private long code;
    private String message;
    private T data;

    protected CommonResponse() {
    }

    protected CommonResponse(long code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 成功返回结果
     *
     * @param data 获取的数据
     */
    public static <T> CommonResponse<T> success(T data) {
        return new CommonResponse<T>(ResponseCode.SUCCESS.getCode(), ResponseCode.SUCCESS.getMessage(), data);
    }

    /**
     * 成功返回结果
     *
     * @param data 获取的数据
     * @param  message 提示信息
     */
    public static <T> CommonResponse<T> success(T data, String message) {
        return new CommonResponse<T>(ResponseCode.SUCCESS.getCode(), message, data);
    }

    /**
     * 失败返回结果
     * @param errorCode 错误码
     */
    public static <T> CommonResponse<T> failed(ResponseCode errorCode) {
        return new CommonResponse<T>(errorCode.getCode(), errorCode.getMessage(), null);
    }

    /**
     * 失败返回结果
     * @param message 提示信息
     */
    public static <T> CommonResponse<T> failed(String message) {
        return new CommonResponse<T>(ResponseCode.FAILED.getCode(), message, null);
    }

    /**
     * 失败返回结果
     */
    public static <T> CommonResponse<T> failed() {
        return failed(ResponseCode.FAILED);
    }

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

    /**
     * 参数验证失败返回结果
     * @param message 提示信息
     */
    public static <T> CommonResponse<T> validateFailed(String message) {
        return new CommonResponse<T>(ResponseCode.VALIDATE_FAILED.getCode(), message, null);
    }

    /**
     * 未登录返回结果
     */
    public static <T> CommonResponse<T> unauthorized(T data) {
        return new CommonResponse<T>(ResponseCode.UNAUTHORIZED.getCode(), ResponseCode.UNAUTHORIZED.getMessage(), data);
    }

    /**
     * 未授权返回结果
     */
    public static <T> CommonResponse<T> forbidden(T data) {
        return new CommonResponse<T>(ResponseCode.FORBIDDEN.getCode(), ResponseCode.FORBIDDEN.getMessage(), data);
    }

    public long getCode() {
        return code;
    }

    public void setCode(long 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;
    }
}

使用的Demo

@Controller
@Api(tags = "用户管理")
@RequestMapping(value = "/user")
public class UserController {
    @Autowired
    UserService userService;

    @ApiOperation("获取用户列表")
    @ResponseBody
    @GetMapping(value = "/getUserList")
    public CommonResponse getUserList(){
        return CommonResponse.success(userService.getUserList());
    }
}