web-dev-qa-db-ja.com

Spring @Retryable-呼び出されたときにログを記録する方法は？

私が使う compile 'org.springframework.retry:spring-retry:1.2.2.RELEASE'with Spring Boot 1.5.9.RELEASE。

私の方法を再試行するように構成され、それはうまく機能します：

@Retryable(value = { IOException.class }, maxAttempts = 5, backoff = @Backoff(delay = 500))
public void someMethod(){...}

再試行が発生したときに特定のメッセージを出力するにはどうすればよいですか？

springspring-bootspring-retry
9
Justas

コードを調べてorg.springframework.retry.support.RetryTemplateは、操作を再試行するための再試行ロジックを実行します。このテンプレートは、次のような単純なもののみを記録します。

o.s.retry.support.RetryTemplate          : Retry: count=0
o.s.retry.support.RetryTemplate          : Checking for rethrow: count=1
o.s.retry.support.RetryTemplate          : Retry: count=1
o.s.retry.support.RetryTemplate          : Checking for rethrow: count=2
o.s.retry.support.RetryTemplate          : Retry: count=2
o.s.retry.support.RetryTemplate          : Checking for rethrow: count=3
o.s.retry.support.RetryTemplate          : Retry failed last attempt: count=3

特定の例外をログに記録する場合は、例外をキャッチして再スローできます。残念ながら、私が見る限り、フレームワーク内でカスタムメッセージを記録する方法はありません。

別の方法は、RetryOperationsInterceptorのようなメソッドの呼び出しを担当する実際のインターセプターをシャドウイングすることです。ただし、これはお勧めしません。

4
Konstantin

RetryListenerを登録できます：

@Bean
public List<RetryListener> retryListeners() {
    Logger log = LoggerFactory.getLogger(getClass());

    return Collections.singletonList(new RetryListener() {

        @Override
        public <T, E extends Throwable> boolean open(RetryContext context, RetryCallback<T, E> callback) {
            // The 'context.name' attribute has not been set on the context yet. So we have to use reflection.
            Field labelField = ReflectionUtils.findField(callback.getClass(), "val$label");
            ReflectionUtils.makeAccessible(labelField);
            String label = (String) ReflectionUtils.getField(labelField, callback);
            log.trace("Starting retryable method {}", label);
            return true;
        }

        @Override
        public <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {
            log.warn("Retryable method {} threw {}th exception {}",
                    context.getAttribute("context.name"), context.getRetryCount(), throwable.toString());
        }

        @Override
        public <T, E extends Throwable> void close(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {
            log.trace("Finished retryable method {}", context.getAttribute("context.name"));
        }
    });

3つのインターセプトポイントすべてからログを記録する必要がない場合は、代わりにRetryListenerSupportをオーバーライドできます。例えば：

@Bean
public List<RetryListener> retryListeners() {
    Logger log = LoggerFactory.getLogger(getClass());

    return Collections.singletonList(new RetryListenerSupport() {

        @Override
        public <T, E extends Throwable> void onError(
                RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {
            log.warn("Retryable method {} threw {}th exception {}",
                    context.getAttribute("context.name"), 
                    context.getRetryCount(), throwable.toString());
        }
    });
}
14
whistling_marmot