>  기사  >  Java  >  Spring Boot 마이크로서비스의 고급 오류 처리

Spring Boot 마이크로서비스의 고급 오류 처리

Patricia Arquette
Patricia Arquette원래의
2024-10-28 19:02:30431검색

Advanced Error Handling in Spring Boot Microservices

복잡한 마이크로서비스에서는 고급 오류 처리가 단순한 예외 로깅 그 이상입니다. 효과적인 오류 처리는 안정성, 확장성 및 우수한 사용자 경험을 유지하는 데 중요합니다. 이 문서에서는 분산 시스템의 오류 관리, 재시도 처리, 사용자 정의 오류 응답 생성, 디버깅을 용이하게 하는 방식으로 오류 로깅을 위한 전략에 중점을 두고 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.";
    }
}

이 구성은 시도 사이에 2초의 지연을 두고 최대 3번까지 메서드를 재시도합니다. 모든 시도가 실패하면 복구 방법이 대체 방법으로 실행됩니다.

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 스택을 이용한 중앙 집중식 로깅

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.