🔥 TIL - Day 83 Spring AOP를 이용한 예외발생 시 재시도 구현

Exception이 발생했을 때 자동으로 해당 메서드를 다시 호출해주는 프록시를 Spring AOP를 이용해서 구현한다.

특정 요청이 재시도에 의해 예외를 피할 수 있는 가능성이 있다면 서버 측에서 정해진 횟수로 재시도하는 것은 클라이언트 입장에서 나쁘지 않은 방식이다.

원본 코드를 건들지 않고 적용하고자 하는 메서드에 @Retry 를 붙여주는 것만으로 적용되도록 할 것이다.

원본 코드를 건들지 않고 비즈니스 로직이 아닌 재시도 로직을 추가하는 것이므로 프록시 패턴이 적당하고 프록시 패턴 을 Spring에서 보다 쉽게 사용하기 위해 Spring AOP를 사용한다.

📌 의존성 추가

[ Spring AOP ]

implementation 'org.springframework.boot:spring-boot-starter-aop'

📌 재시도 대상이 될 테스트 클래스 및 메서드 작성

repository의 save메서드는 5번째 접근마다 예외가 발생한다.

@Repository
public class ExamRepository {

    private static int sequence = 0;

    // 5번째 요청마다 예외를 발생시킨다.
    public String save(String itemId) {
        ++sequence;
        if (sequence%5 == 0) {
            throw new IllegalStateException("예외 발생");
        }
        return "ok";
    }
}

원래는 5번째 요청마다 예외가 리턴되지만 예외발생 시 재시도를 통해 예외를 회피하도록 할 것이다.

📌 JoinPoint가 될 마킹용 Annotation 작성

@Retry가 붙은 메서드에 재시도 Advice가 적용되도록 할 것이다.

성공할 때까지 무한정으로 재시도가 되지 않도록 하고, 적용될 메서드마다 최대 재시도 횟수를 달리하기 위해 속성으로 value를 포함한다.

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Retry {

    int value() default 3;
}

📌 Aspect 작성

• JoinPoint 전 후로 예외에 대한 처리 등 추가적인 작업이 필요하기 때문에 @Around를 사용한다.

• @annotation(어노테이션_이름) 어노테이션의 이름을 지정하고 해당 타입을 인자로 받으므로 PointCut을 지정하고 있다.

  만약 어노테이션을 인자로 받지 않는다면 @annotation() 에는 어노테이션의 패키지 경로와 타입이 들어가야 한다.

• Retry 어노테이션에서 최대 재시도 횟수를 가져오고 재시도 횟수만큼 JoinPoint를 호출한다. (proceed());

• 요청 중 예외가 발생한다면 바로 예외를 던지지 않고 일시적으로 저장한 다음 최대 재시도 횟수를 초과하는 경우 임시 저장한 예외를 발생시킨다.

@Aspect
@Slf4j
public class RetryAspect {

    @Around("@annotation(retry)")
    public Object doRetry(ProceedingJoinPoint joinPoint, Retry retry) throws Throwable {
        log.info("[Retry] {} retry={}", joinPoint.getSignature(), retry);

        int maxRetry = retry.value();
        Exception exceptionHolder = null;

        for (int retryCnt=1; retryCnt<=maxRetry; retryCnt++) { // 재시도
       	    if (retryCnt > 1) {
                log.info("{} 번째 재시도", retryCnt-1);
            }
            try {
                return joinPoint.proceed(); // target 호출시 예외가 없다면 그대로 반환
            } catch (Exception e) {
                exceptionHolder = e; // 예외가 발생했다면 발생한 예외를 보관
            }
        }
        throw exceptionHolder; // 최대 재시도 횟수를 넘어선 경우 예외발생
    }
}

📌 어노테이션 적용 전 테스트

재시도를 위한 어노테이션을 붙이기 전 테스트이다.

@Slf4j
@SpringBootTest
public class RetryTest {

    @Autowired
    ExamRepository examRepository;

    @Test
    void test() {
        for (int i=1;i<=5;i++) {
            String result = examRepository.save(String.valueOf(i));
            log.info("result={}, itemId={}", result, i);
        }
    }
}

1~5까지 총 5번의 요청을 하는데 4번째 요청 이후 예외가 터지는 것을 확인한다.

📌 어노테이션 적용 후 테스트

재시도 로직을 적용하고자 하는 메서드에 @Retry를 붙여주므로 AOP를 적용했다.

@Repository
public class ExamRepository {

    private static int sequence = 0;

    // 5번째 요청마다 예외를 발생시킨다.
    @Retry
    public String save(String itemId) {
        ++sequence;
        if (sequence%5 == 0) {
            throw new IllegalStateException("예외 발생");
        }
        return "ok";
    }
}

스프링 컨테이너에 재시도 Aspect를 올려줘야 하므로 @Import를 사용해서 등록한다.

@Import(RetryAspect.class)
@Slf4j
@SpringBootTest
public class RetryTest {
	...
}

이제 5번째 요청마다 재시도가 발생하고 재시도에 의해 요청이 정상적으로 응답될 것이다.

4번째 요청에서 한 번으로 재시도가 발생하고 5번째 요청이 성공한 것을 확인할 수 있다.

📌 참고

아래 강의를 100% 참고하여 정리한 내용입니다.
강의자료를 그대로 가져온 것은 아니니 보다 정확한 정보를 원한다면 강의를 들어주세요. (강추!)
인프런 - 스프링 핵심 원리 고급편 (김영한 님)