java 自定义返回状态码

原创

mob649e81697507 2023-11-27 10:27:50 ©著作权

文章标签 状态码自定义 Java 文章分类 Java 后端开发

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

Java 自定义返回状态码

在开发中，我们经常需要对请求进行处理，并返回相应的状态码给调用方。Java中，可以使用自定义返回状态码来实现这一功能。本文将介绍如何在Java中实现自定义返回状态码，并提供相应的代码示例。

什么是自定义返回状态码？

自定义返回状态码是指在处理请求后，根据具体的业务逻辑返回一个自定义的状态码给调用方。传统的HTTP状态码只包括一些常见的状态，如200表示成功，404表示资源未找到等。但是在实际开发中，我们可能需要更加细化的状态码来表示不同的处理结果。

如何自定义返回状态码？

在Java中，我们可以通过自定义一个枚举类来表示返回状态码。首先，我们需要定义一个枚举类，其中包含不同的状态码和对应的描述信息。

public enum CustomStatusCode {
    SUCCESS(0, "成功"),
    PARAM_ERROR(400, "参数错误"),
    SERVER_ERROR(500, "服务器错误");

    private int code;
    private String message;

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

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

上述代码中，我们定义了三种状态码：成功（0）、参数错误（400）和服务器错误（500）。其中，每个状态码都有一个对应的描述信息。

接下来，我们可以在接口或方法中使用自定义返回状态码。例如，下面是一个简单的示例：

public class UserController {
    public ResponseData login(String username, String password) {
        if (StringUtils.isEmpty(username) || StringUtils.isEmpty(password)) {
            return ResponseData.error(CustomStatusCode.PARAM_ERROR);
        }

        // 具体的业务逻辑处理

        return ResponseData.success();
    }
}

在上述代码中，我们定义了一个login方法用于用户登录。如果用户名或密码为空，则返回参数错误的状态码；否则，进行具体的业务逻辑处理，并返回成功的状态码。

如何使用自定义返回状态码？

为了更好地使用自定义返回状态码，我们可以封装一个统一的响应类。该类包含一个状态码和对应的数据信息。

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

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

    // 省略getter和setter方法
}

接下来，我们可以扩展该类，提供一些常用的操作方法，如成功返回、失败返回等。

public class ResponseData<T> {
    // 省略其他代码

    public static <T> ResponseData<T> success() {
        return new ResponseData<>(CustomStatusCode.SUCCESS.getCode(), CustomStatusCode.SUCCESS.getMessage(), null);
    }

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

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

上述代码中，我们通过success和error方法来创建成功和失败的响应。如果需要返回数据，可以通过重载方法传入相应的数据。