封装 Java 通用返回类_java 数据返回通用类-优快云博客

本文链接：https://blog.youkuaiyun.com/new_baibai/article/details/130526072

文章介绍了在大型项目中，为了统一Controller的返回格式，如何创建并使用通用返回类（BaseResponse）。此类封装了返回码、数据和消息，简化了服务端与前端的交互。通过示例展示了使用通用返回类前后的代码对比，以及如何利用ResultUtils工具类方便地构建返回对象。

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

写在前面

通用返回类的意义：

在大型的项目需要编写很多Controller,其中的方法有很多，几乎都是响应客户端发送来的请求，Controller处理完会返回给页面一个结果，所以就把这个结果统一的封装成一个类R，此类是一个通用结果类，服务端响应的所有结果最终都会包装成此种类型返回给前端页面.

一般封装了通用返回类之后的返回值：

code：返回码

data：将要返回的信息

message：返回状态

未使用通用返回类：

使用通用返回类：

通用返回类的编写：

/**
 * 返回工具类
 */
public class ResultUtils {

    /**
     * 成功
     *
     * @param data
     * @param <T>
     * @return
     */
    public static <T> BaseResponse<T> success(T data) {
        return new BaseResponse<>(0, data, "ok");
    }

    /**
     * 失败
     *
     * @param errorCode
     * @return
     */
    public static BaseResponse error(ErrorCode errorCode) {
        return new BaseResponse<>(errorCode);
    }

    /**
     * 失败
     *
     * @param code
     * @param message
     * @return
     */
    public static BaseResponse error(int code, String message) {
        return new BaseResponse(code, null, message);
    }

    /**
     * 失败
     *
     * @param errorCode
     * @return
     */
    public static BaseResponse error(ErrorCode errorCode, String message) {
        return new BaseResponse(errorCode.getCode(), null, message);
    }
}

/**
 * 通用返回类
 *
 */
@Data
public class BaseResponse<T> implements Serializable {

    private int code;

    private T data;

    private String message;

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

    public BaseResponse(int code, T data) {
        this(code, data, "");
    }

    public BaseResponse(ErrorCode errorCode) {
        this(errorCode.getCode(), null, errorCode.getMessage());
    }
}

使用方法：

使用了通用返回类：

public BaseResponse<Page<User>> listUserByPage(@RequestBody UserQueryRequest userQueryRequest,
            HttpServletRequest request) {
        long current = userQueryRequest.getCurrent();
        long size = userQueryRequest.getPageSize();
        Page<User> userPage = userService.page(new Page<>(current, size),
                userService.getQueryWrapper(userQueryRequest));
        return ResultUtils.success(userPage);
    }

未使用通用返回类：

    public Page<User> listUserByPageTest(@RequestBody UserQueryRequest userQueryRequest,
                                                   HttpServletRequest request) {
        long current = userQueryRequest.getCurrent();
        long size = userQueryRequest.getPageSize();
        return userService.page(new Page<>(current, size),
               userService.getQueryWrapper(userQueryRequest));
    }