《在 Spring Boot 项目中优雅地自定义异常》

在开发 Spring Boot 应用程序时，处理异常情况是一个重要的环节。为了提高代码的可读性、可维护性和可扩展性，优雅地自定义异常是一种良好的实践。

一、为什么要自定义异常

Spring Boot 框架本身提供了一些常见的异常类型，但在实际项目中，往往需要根据业务需求创建特定的异常来更准确地传达错误信息。自定义异常能够使错误处理更具针对性，让开发者和用户更清晰地理解问题所在。

二、自定义异常类的设计

首先，创建一个继承自 RuntimeException 的自定义异常类。例如：

public class CustomBusinessException extends RuntimeException {

    private int errorCode;

    private String errorMessage;

    public CustomBusinessException(int errorCode, String errorMessage) {
        this.errorCode = errorCode;
        this.errorMessage = errorMessage;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public String getErrorMessage() {
        return errorMessage;
    }
}

在这个自定义异常类中，我们可以定义错误码和错误消息等属性，以便更详细地描述异常情况。

三、异常处理机制

在 Spring Boot 中，可以使用 @ControllerAdvice 注解来统一处理异常。创建一个异常处理类：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomBusinessException.class)
    @ResponseBody
    public ResponseEntity<ErrorResponse> handleCustomBusinessException(CustomBusinessException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getErrorCode(), ex.getErrorMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }
}

上述代码中，@ExceptionHandler 注解用于指定处理的异常类型，HttpStatus.BAD_REQUEST 表示返回的 HTTP 状态码。

四、在业务逻辑中抛出异常

在业务方法中，根据具体的业务规则抛出自定义异常：
 

if (someConditionFails) {
    throw new CustomBusinessException(400, "Some specific business error occurred");
}

例如，实现用户登录功能时，你可能需要处理诸如用户名或密码错误、用户未激活、用户已被禁用等异常情况。下面是如何自定义一个异常类以及如何在用户登录功能中使用它的示例。

自定义异常类
首先，我们创建一个自定义异常类，命名为UserLoginException。这个异常类将继承自RuntimeException，并携带一个错误消息，以便在抛出异常时提供更多的信息。

package com.example.demo.exception;

public class UserLoginException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    public UserLoginException(String message) {
        super(message);
    }

    public UserLoginException(String message, Throwable cause) {
        super(message, cause);
    }
}

定义错误码和错误消息
在实际应用中，我们通常还会定义一套错误码和对应的错误消息，以便于前端或日志记录。这可以通过枚举类实现：

package com.example.demo.error;

public enum ErrorCode {
    USER_NOT_FOUND("USER_001", "用户未找到"),
    INVALID_CREDENTIALS("USER_002", "无效的用户名或密码"),
    USER_DISABLED("USER_003", "用户已被禁用"),
    USER_NOT_ACTIVE("USER_004", "用户未激活");

    private String code;
    private String message;

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

    public String getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

全局异常处理器
接下来，我们需要创建一个全局异常处理器，用于捕获并处理UserLoginException。这可以通过实现ControllerAdvice注解的类来完成。

package com.example.demo.exception;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(UserLoginException.class)
    public ResponseEntity<Object> handleUserLoginException(UserLoginException ex) {
        // 返回一个自定义的错误响应，可以包括错误码和错误消息
        return ResponseEntity.status(HttpStatus.UNAUTHORIZED)
                .body(new ErrorResponseBody(ex.getMessage()));
    }

    // 可以添加更多异常处理器，处理其他类型的异常
}

用户登录功能中的异常抛出
最后，在用户登录的控制器或服务层中，我们可以根据不同的错误情况抛出UserLoginException。

package com.example.demo.controller;

import com.example.demo.exception.UserLoginException;
import com.example.demo.error.ErrorCode;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @PostMapping("/login")
    public ResponseEntity<?> login(@RequestBody LoginRequest request) {
        // 模拟登录验证过程
        if (!"admin".equals(request.getUsername()) || !"password".equals(request.getPassword())) {
            throw new UserLoginException(ErrorCode.INVALID_CREDENTIALS.getMessage());
        }
        
        // 登录成功，返回相应的响应
        return ResponseEntity.ok().build();
    }
}

在这个例子中，如果用户名或密码不匹配，将抛出UserLoginException，并附带INVALID_CREDENTIALS的错误消息。全局异常处理器将捕获这个异常，并返回一个HTTP 401 Unauthorized状态码，以及错误的详细信息。
通过这种方式，你可以灵活地处理各种登录相关的异常情况，同时保持代码的清晰和可维护性。

五、优点和注意事项

通过优雅地自定义异常，能够使代码结构更加清晰，错误处理更加集中和可控。同时，需要注意异常的分类和粒度，避免过度创建异常类导致代码复杂度过高。

总之，在 Spring Boot 项目中，合理地自定义异常能够提升项目的质量和开发效率，为后续的维护和扩展打下坚实的基础。