spring boot通用响应类的封装利用枚举类

原创

mob64ca12ef5efc 2023-11-12 04:11:03 ©著作权

文章标签 封装 java 枚举类 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12ef5efc的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用枚举类封装Spring Boot通用响应类

1. 简介

在Spring Boot开发中，我们经常需要定义一些通用的响应类来统一接口返回格式。使用枚举类可以很好地封装这些通用响应类，并提供更好的可扩展性和代码可读性。本文将介绍如何利用枚举类实现Spring Boot通用响应类的封装。

2. 枚举类的定义

首先，我们需要定义一个枚举类来表示通用的响应状态。假设我们的通用响应类包括三个字段：状态码、消息和数据。可以按照以下方式定义一个枚举类：

public enum ResponseStatus {
    SUCCESS(200, "请求成功"),
    ERROR(500, "服务器内部错误");

    private int code;
    private String message;

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

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

在上面的代码中，我们定义了两个枚举常量：SUCCESS和ERROR，分别表示请求成功和服务器内部错误。我们通过构造函数来初始化每个枚举常量的状态码和消息，并提供了相应的getCode()和getMessage()方法来获取状态码和消息。

3. 响应类的封装

接下来，我们需要定义一个通用的响应类，用于封装接口返回的数据。可以按照以下方式定义一个响应类：

public class ApiResponse<T> {
    private int code;
    private String message;
    private T data;

    public ApiResponse(ResponseStatus status, T data) {
        this.code = status.getCode();
        this.message = status.getMessage();
        this.data = data;
    }

    // 省略构造函数、getter和setter方法
}

在上面的代码中，我们定义了一个泛型类ApiResponse，用于封装接口返回的数据。该类包括三个字段：状态码、消息和数据。我们通过构造函数来初始化这些字段，并提供了相应的getter和setter方法。

4. 使用示例

现在，我们来看一个使用示例。假设我们需要开发一个用户管理的接口，返回用户的基本信息。可以按照以下步骤来实现：

步骤一：定义用户实体类

首先，我们需要定义一个用户实体类User，包括用户的ID、姓名和年龄等字段。可以按照以下方式定义一个用户实体类：

public class User {
    private Long id;
    private String name;
    private Integer age;

    // 省略构造函数、getter和setter方法
}

步骤二：实现用户管理接口

接下来，我们需要实现一个用户管理的接口，用于查询用户的基本信息。可以按照以下步骤来实现：

定义一个UserController类，并添加@RestController注解，用于标识该类是一个控制器。

@RestController
public class UserController {
    // 省略代码
}

定义一个getUser方法，用于查询用户的基本信息。该方法的返回类型为ApiResponse<User>，用于封装接口返回的数据。

@GetMapping("/users/{userId}")
public ApiResponse<User> getUser(@PathVariable Long userId) {
    // 省略代码
}

在getUser方法中，根据用户ID查询用户的基本信息，并将查询到的用户对象封装到ApiResponse中返回。

@GetMapping("/users/{userId}")
public ApiResponse<User> getUser(@PathVariable Long userId) {
    User user = userService.getUserById(userId);
    return new ApiResponse<>(ResponseStatus.SUCCESS, user);
}