统一的API响应结果封装类

山外归

已于 2024-07-26 00:09:15 修改

阅读量108

点赞数 1

分类专栏： SpringBoot项目文章标签： java spring boot 后端

于 2024-07-26 00:08:18 首次发布

本文链接：https://blog.csdn.net/weixin_42031627/article/details/140702623

版权

SpringBoot项目专栏收录该内容

1 篇文章 0 订阅

订阅专栏

package com.wlb.response;

import com.wlb.enums.StatusCodeResultEnum;
import lombok.Getter;
import lombok.Setter;

/**
 * API响应结果
 * <p>
 * 统一的API响应结果封装类。
 * </p>
 *
 * @author shenghua.song
 */
@Setter
@Getter
public class ApiResponse<T> {

    private int code;
    private String message;
    private T data;

    public ApiResponse() {
    }

    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

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

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

    public static <T> ApiResponse<T> error(int code, String message) {
        return new ApiResponse<>(code, message, null);
    }

    public static <T> ApiResponse<T> error(StatusCodeResultEnum statusCode) {
        return new ApiResponse<>(statusCode.getCode(), statusCode.getMessage(), null);
    }

}

package com.wlb.enums;

import lombok.Getter;

/**
 * 状态代码结果枚举
 * <p>
 * 用于定义常见的API响应状态码和描述信息。
 * </p>
 *
 * @author shenghua.song
 */
@Getter
public enum StatusCodeResultEnum {
    SUCCESS(200, "成功"),
    BAD_REQUEST(400, "错误的请求"),
    UNAUTHORIZED(401, "未授权"),
    FORBIDDEN(403, "禁止"),
    NOT_FOUND(404, "未找到"),
    INTERNAL_SERVER_ERROR(500, "服务器内部错误");

    private final int code;
    private final String message;

    StatusCodeResultEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }

}