Spring Boot 微服务中的高级错误处理

在复杂的微服务中，高级错误处理不仅仅是简单的异常日志记录。有效的错误处理对于可靠性、可扩展性和保持良好的用户体验至关重要。本文将介绍 Spring Boot 微服务中错误处理的高级技术，重点介绍管理分布式系统中的错误、处理重试、创建自定义错误响应以及以方便调试的方式记录错误的策略。

1. Spring Boot 中的基本错误处理

让我们从 Spring Boot 中的基本错误处理方法开始来设置基线。

1.1 使用@ControllerAdvice和@ExceptionHandler

Spring Boot 通过 @ControllerAdvice 和 @ExceptionHandler 提供了全局异常处理程序。此设置使我们能够在一个地方处理所有控制器的异常。

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleResourceNotFound(ResourceNotFoundException ex) {
        ErrorResponse error = new ErrorResponse("NOT_FOUND", ex.getMessage());
        return new ResponseEntity<>(error, HttpStatus.NOT_FOUND);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
        ErrorResponse error = new ErrorResponse("INTERNAL_SERVER_ERROR", "An unexpected error occurred.");
        return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

这里，ErrorResponse 是一个自定义错误模型：

public class ErrorResponse {
    private String code;
    private String message;

    // Constructors, Getters, and Setters
}

1.2 返回一致的错误响应

确保所有异常返回一致的错误响应格式（例如 ErrorResponse）有助于客户端正确解释错误。

---

2.错误处理的高级技术

2.1 使用错误 ID 进行集中记录和跟踪

为每个异常分配唯一的错误 ID 有助于跨服务跟踪特定错误。此 ID 还可以与异常详细信息一起记录，以便于调试。

@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
    String errorId = UUID.randomUUID().toString();
    log.error("Error ID: {}, Message: {}", errorId, ex.getMessage(), ex);

    ErrorResponse error = new ErrorResponse("INTERNAL_SERVER_ERROR",
                                             "An unexpected error occurred. Reference ID: " + errorId);
    return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
}

客户端收到包含 errorId 的错误响应，他们可以将其报告给支持人员，并将其直接链接到详细日志。

2.2 添加瞬态错误的重试逻辑

在分布式系统中，暂时性问题（例如网络超时）可以通过重试来解决。使用Spring的@Retryable对服务方法进行重试逻辑。

设置

首先，在 pom.xml 中添加 Spring Retry 依赖项：

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

然后，使用@EnableRetry启用Spring Retry，并注释需要重试的方法。

@EnableRetry
@Service
public class ExternalService {

    @Retryable(
        value = { ResourceAccessException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 2000))
    public String callExternalService() throws ResourceAccessException {
        // Code that calls an external service
    }

    @Recover
    public String recover(ResourceAccessException e) {
        log.error("External service call failed after retries.", e);
        return "Fallback response due to error.";
    }
}

此配置最多重试该方法 3 次，每次尝试之间延迟 2 秒。如果所有尝试都失败，则恢复方法将作为后备执行。

2.3 在微服务中使用带有回退功能的 Feign 客户端

对于服务到服务调用中的错误处理，Feign 提供了一种声明式方式来设置重试和回退。

假装配置

定义一个具有后备支持的 Feign 客户端：

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ErrorResponse> handleResourceNotFound(ResourceNotFoundException ex) {
        ErrorResponse error = new ErrorResponse("NOT_FOUND", ex.getMessage());
        return new ResponseEntity<>(error, HttpStatus.NOT_FOUND);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
        ErrorResponse error = new ErrorResponse("INTERNAL_SERVER_ERROR", "An unexpected error occurred.");
        return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

此方法可确保如果库存服务不可用，InventoryServiceFallback 会启动预定义的响应。

---

3.错误记录和可观察性

3.1 使用 ELK Stack 集中日志记录

配置 ELK（Elasticsearch、Logstash、Kibana）堆栈来整合来自多个微服务的日志。借助集中式日志系统，您可以轻松跟踪服务中的问题并查看带有关联错误 ID 的日志。

例如，在application.yml中配置日志模式：

public class ErrorResponse {
    private String code;
    private String message;

    // Constructors, Getters, and Setters
}

3.2 使用 Spring Cloud Sleuth 添加跟踪 ID

在分布式系统中，跨多个服务跟踪单个事务至关重要。 Spring Cloud Sleuth 提供具有唯一跟踪和跨度 ID 的分布式跟踪。

在您的依赖项中添加 Spring Cloud Sleuth：

@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGeneralException(Exception ex) {
    String errorId = UUID.randomUUID().toString();
    log.error("Error ID: {}, Message: {}", errorId, ex.getMessage(), ex);

    ErrorResponse error = new ErrorResponse("INTERNAL_SERVER_ERROR",
                                             "An unexpected error occurred. Reference ID: " + errorId);
    return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR);
}

---

4. REST API 的自定义错误处理

4.1 创建自定义异常类

定义自定义异常以提供更具体的错误处理。

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

4.2 自定义错误响应结构

通过实现 ErrorAttributes 来定制错误响应，以获取结构化和丰富的错误消息。

@EnableRetry
@Service
public class ExternalService {

    @Retryable(
        value = { ResourceAccessException.class },
        maxAttempts = 3,
        backoff = @Backoff(delay = 2000))
    public String callExternalService() throws ResourceAccessException {
        // Code that calls an external service
    }

    @Recover
    public String recover(ResourceAccessException e) {
        log.error("External service call failed after retries.", e);
        return "Fallback response due to error.";
    }
}

在配置中注册 CustomErrorAttributes 以自动自定义所有错误响应。

4.3 API 错误响应标准化及问题详细信息 (RFC 7807)

使用问题详细信息格式来实现标准化 API 错误结构。基于 RFC 7807 定义错误响应模型：

@FeignClient(name = "inventory-service", fallback = InventoryServiceFallback.class)
public interface InventoryServiceClient {
    @GetMapping("/api/inventory/{id}")
    InventoryResponse getInventory(@PathVariable("id") Long id);
}

@Component
public class InventoryServiceFallback implements InventoryServiceClient {

    @Override
    public InventoryResponse getInventory(Long id) {
        // Fallback logic, like returning cached data or an error response
        return new InventoryResponse(id, "N/A", "Fallback inventory");
    }
}

然后，从 @ControllerAdvice 方法返回此结构化响应，以在所有 API 中保持一致的错误结构。

logging:
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"

---

5.具有弹性的断路器

集成断路器模式可以保护您的微服务免于重复调用失败的服务。

使用 Resilience4j 断路器
将 Resilience4j 添加到您的依赖项中：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>

然后，用断路器包装一个方法：

public class InvalidRequestException extends RuntimeException {
    public InvalidRequestException(String message) {
        super(message);
    }
}

如果多次失败，此设置将停止调用 getInventory，并且 inventoryFallback 返回安全响应。

---

结论

Spring Boot 微服务中的高级错误处理包括：

集中错误处理以实现一致的响应和简化的调试。
重试和断路器用于弹性服务到服务调用。
使用 ELK 和 Sleuth 等工具进行集中日志记录和可追溯性。
自定义错误格式包含问题详细信息和结构化错误响应。
这些技术有助于确保您的微服务稳健，提供一致、可追踪的错误响应，同时防止跨服务发生级联故障。

以上是Spring Boot 微服务中的高级错误处理的详细内容。更多信息请关注PHP中文网其他相关文章！