java 自定义响应码

原创

mob649e81637cea 2024-09-13 04:49:16 ©著作权

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

Java自定义响应码的实现指南

在开发Java应用时，可能会遇到需要自定义响应码的情况。自定义响应码可以帮助你清晰地传达错误信息或状态，提升用户体验。接下来，我将通过一个详细的流程教你如何实现Java自定义响应码。

流程概述

首先，下面是整个实现过程的步骤，包括所需的核心功能：

步骤	说明
1	创建自定义响应码的枚举类
2	定义自定义异常类
3	创建全局异常处理器
4	在控制器中使用自定义响应码
5	测试自定义响应码

flowchart TD
    A[创建自定义响应码的枚举类] --> B[定义自定义异常类]
    B --> C[创建全局异常处理器]
    C --> D[在控制器中使用自定义响应码]
    D --> E[测试自定义响应码]

具体步骤详解

1. 创建自定义响应码的枚举类

首先，我们需要创建一个枚举类用来定义我们的自定义响应码。枚举类可以确保每个响应码都是唯一的，方便管理。

// ResponseCode.java
public enum ResponseCode {
    SUCCESS(200, "成功"),
    INVALID_REQUEST(400, "请求无效"),
    UNAUTHORIZED(401, "未授权"),
    NOT_FOUND(404, "未找到"),
    INTERNAL_SERVER_ERROR(500, "内部服务器错误");

    private int code;
    private String message;

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

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

代码注释：

enum ResponseCode：定义一个枚举类ResponseCode，包含各个自定义响应码。
SUCCESS(200, "成功")：枚举常量，每个常量有一个代码和对应的信息。
getCode() 和 getMessage()：获取响应码及其信息的方法。

2. 定义自定义异常类

我们可以定义一个自定义异常类，以便在处理业务逻辑中抛出特定的异常。

// CustomException.java
public class CustomException extends RuntimeException {
    private ResponseCode responseCode;

    public CustomException(ResponseCode responseCode) {
        super(responseCode.getMessage());
        this.responseCode = responseCode;
    }

    public ResponseCode getResponseCode() {
        return responseCode;
    }
}

代码注释：

CustomException：自定义异常类，继承自RuntimeException。
responseCode：定义响应码属性，用于存储错误类型。
CustomException(ResponseCode responseCode)：构造函数传入响应码，并调用父类构造函数。

3. 创建全局异常处理器

要集中处理所有异常，我们需要设置一个全局异常处理器，使用@ControllerAdvice注解。

// GlobalExceptionHandler.java
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<Object> handleCustomException(CustomException e) {
        ResponseCode responseCode = e.getResponseCode();
        return new ResponseEntity<>(responseCode.getMessage(), HttpStatus.valueOf(responseCode.getCode()));
    }
}

代码注释：

@ControllerAdvice：标注为全局异常处理器。
handleCustomException(CustomException e)：处理自定义异常的方法。
ResponseEntity<Object>：构造响应实体，包含状态码和信息。

4. 在控制器中使用自定义响应码

当业务逻辑遇到错误时，可以抛出自定义异常，通知全局异常处理器进行处理。

// ExampleController.java
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ExampleController {

    @GetMapping("/demo")
    public String demo() {
        // 假设某种条件导致请求无效
        if (true) { // 替换为实际的逻辑条件
            throw new CustomException(ResponseCode.INVALID_REQUEST);
        }
        return "成功";
    }
}

代码注释：