使用Spring Boot和Lombok创建通用返回类和状态码枚举

在开发过程中，我们经常需要定义通用的返回数据格式，并且使用统一的状态码来表示请求结果。为了简化这个过程，我们可以使用Spring Boot框架和Lombok库来创建一个通用的返回类和状态码枚举。

首先，我们需要引入Lombok依赖，并在通用返回类中使用Lombok注解来简化代码。通用返回类包括了三个部分：data（数据），message（消息）和code（状态码）。下面是通用返回类的示例代码：

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result<T> {
    private int code;
    private String message;
    private T data;

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

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

在上述代码中，我们使用了@Data注解来自动生成getter、setter、toString、equals和hashCode方法。@NoArgsConstructor和@AllArgsConstructor注解分别生成一个无参的构造函数和带有所有参数的构造函数。

接下来，我们需要创建一个状态码枚举类来定义常见的状态码以及对应的消息。下面是状态码枚举类的示例代码：

public enum ResultCode {
    SUCCESS(200, "OK"),
    BAD_REQUEST(400, "Bad Request"),
    UNAUTHORIZED(401, "Unauthorized"),
    FORBIDDEN(403, "Forbidden"),
    NOT_FOUND(404, "Not Found"),
    INTERNAL_SERVER_ERROR(500, "Internal Server Error");

    private final int code;
    private final String message;

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

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

在上述枚举类中，我们定义了一些常见的HTTP状态码以及对应的消息。通过使用ResultCode.SUCCESS等静态枚举值，我们可以方便地获取到相应的状态码和消息。

使用这两个通用类，我们可以在Spring Boot项目中快速创建统一的返回格式，并且使用统一的状态码来表示请求结果。例如，在控制器方法中，我们可以这样使用通用返回类：

@RestController
public class MyController {

    @GetMapping("/data")
    public Result<String> getData() {
        // 获取数据
        String data = "Hello, World!";
        // 返回成功结果
        return Result.success(data);
    }

    @GetMapping("/error")
    public Result<?> handleError() {
        // 返回错误结果
        return Result.error(ResultCode.BAD_REQUEST);
    }
}

通过以上示例代码，我们可以看到，创建通用返回类和状态码枚举能够帮助我们简化开发过程并提高代码的可读性。这种方式可以在Spring Boot项目中方便地实现统一的返回格式和状态码，减少重复代码的编写。

总结： 本文介绍了使用Spring Boot和Lombok创建通用返回类和状态码枚举的方法。通过引入Lombok依赖并使用注解，我们能够快速生成通用返回类的代码，包括数据、消息和状态码。同时，通过定义状态码枚举类，我们能够统一管理常见的状态码和对应的消息。这种方式能够简化开发过程，并提供统一的返回格式和状态码，提高代码的可读性和可维护性。