web-dev-qa-db-ja.com

Spring Async Uncaught Exceptionハンドラー

@Override
@Async
public void asyncExceptionTest() {
    int i=1/0;
}

どのようにしてすべての非同期メソッドを試行錯誤せずに、Spring Asyncフレームワークを使用してこれをログに記録できますか？通常のようにDefaultUncaughtExceptionHandlerに渡されないようです。

javaspringasynchronousexception-handlinguncaughtexceptionhandler
24
DD.

_@Async_メソッドをカスタムExecutorで構成して、スローされた例外をログに記録できます。

次のコードは、このパターンを実装しています。 _@Async_でタグ付けされたメソッドは、メソッドpublic Executor getAsyncExecutor()によって返されたExecutorを使用します。これは、すべてのロギングを処理するHandlingExecutorを返します（この場合、「CAUGHT！」という単語が出力されるだけですが、ロギングに置き換えることができます。

_@Configuration
@EnableAsync
public class ExampleConfig implements AsyncConfigurer {
    @Bean
    public Runnable testExec() {
        return new TestExec();
    }

    @Override
    public Executor getAsyncExecutor() {
        final ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(7);
        executor.setMaxPoolSize(42);
        executor.setQueueCapacity(11);
        executor.setThreadNamePrefix("MyExecutor-");
        executor.initialize();
        return new HandlingExecutor(executor);
    }
}

public class HandlingExecutor implements AsyncTaskExecutor {
    private AsyncTaskExecutor executor;

    public HandlingExecutor(AsyncTaskExecutor executor) {
        this.executor = executor;
    }

    @Override
    public void execute(Runnable task) {
        executor.execute(task);
    }

    @Override
    public void execute(Runnable task, long startTimeout) {
        executor.execute(createWrappedRunnable(task), startTimeout);
    }

    @Override
    public Future<?> submit(Runnable task) {
        return executor.submit(createWrappedRunnable(task));
    }

    @Override
    public <T> Future<T> submit(final Callable<T> task) {
        return executor.submit(createCallable(task));
    }

    private <T> Callable<T> createCallable(final Callable<T> task) {
        return new Callable<T>() {
            @Override
            public T call() throws Exception {
                try {
                    return task.call();
                } catch (Exception e) {
                    handle(e);
                    throw e;
                }
            }
        };
    }

    private Runnable createWrappedRunnable(final Runnable task) {
        return new Runnable() {
            @Override
            public void run() {
                try {
                    task.run();
                } catch (Exception e) {
                    handle(e);
                }
            }
        };
    }

    private void handle(Exception e) {
        System.out.println("CAUGHT!");
    }
}
_
20
DD.

更新：Spring 4.1以降

Spring 4.1以降@Asyncvoidメソッドに AsyncUncaughtExceptionHandler を含めることが可能です。

Spring Reference Doc、 4.4.5 @Asyncによる例外管理

...ただし、戻り値の型がvoidの場合、例外は捕捉されず、送信できません。そのような場合、そのような例外を処理するためにAsyncUncaughtExceptionHandlerを提供できます。

デフォルトでは、例外は単にログに記録されます。カスタムAsyncUncaughtExceptionHandlerは、AsyncConfigurerまたはtask：annotation-driven XML要素を介して定義できます。

（この機能は、DDが改善要求を出した後に導入されました： https://jira.spring.io/browse/SPR-8995 、この回答のコメントを参照）

Spring 4.1より前

voidが返す@Asyncメソッドの例外を処理する方法が欠けている機能のようです。 （私はリファレンスまたはJava doc）にヒントを見つけることができません）

ソリューションで想像できること：AspectJを使用して、例外をログに記録するすべての@Asyncメソッドを囲む何らかのラッパーを記述してみてください。

ログの用語については、春のバグトラッカーでfreatureリクエストを作成することをお勧めします。

16
Ralph

まず、次のようなカスタム例外ハンドラクラスを作成する必要があります。

@Component
public class AsyncExceptionHandler implements AsyncUncaughtExceptionHandler {

        private final Logger logger = LoggerFactory.getLogger(AsyncExceptionHandler.class);

        @Override
        public void handleUncaughtException(Throwable ex, Method method, Object... params) {
            logger.error("Unexpected asynchronous exception at : "
                    + method.getDeclaringClass().getName() + "." + method.getName(), ex);
        }

    }

その後、次のように、カスタマイズした例外ハンドラクラスを構成に設定する必要があります。

@Configuration
@EnableAsync
public class AsyncConfig extends AsyncConfigurerSupport {

    @Autowired
    private AsyncExceptionHandler asyncExceptionHandler;

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return asyncExceptionHandler;
    }

}

注：注入可能な例外ハンドラーはオプションです。例外ごとに新しいインスタンスを作成できます。 Springのデフォルトのスコープはシングルトンなので、例外ごとに新しいインスタンスを作成する必要がないため、例外ハンドラクラスにInjectionを使用することをお勧めします。

10
Mustafa Onur AYDIN

標準のSpring AOPアプローチを使用できます

@Aspect
@Component
@Slf4j
public class AsyncHandler {

   @Around("@annotation(org.springframework.scheduling.annotation.Async)")
   private Object handle(ProceedingJoinPoint pjp) throws Throwable {
       try {
           Object retVal = pjp.proceed();
           return retVal;
       } catch (Throwable e) {
           log.error("in ASYNC, method: " + pjp.getSignature().toLongString() + ", args: " + AppStringUtils.transformToWellFormattedJsonString(pjp.getArgs()) + ", exception: "+ e, e);
           throw e;
       }
   }

}
0
panser