Spring async не работает при реализации AsyncConfigurer

EDIT: я подал отчет об ошибке (SPR-14630).

Я был на грани отправки отчета об ошибке в систему отслеживания проблем Spring, однако, когда я готовил небольшое приложение для воспроизведения ошибка, я нашел и исправил проблему.

Прежде всего, при использовании ThreadPoolTaskExecutor вы должны вызвать его метод initialize() перед возвратом:

@Override
public Executor getAsyncExecutor() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setMaxPoolSize(1);
    executor.setCorePoolSize(1);
    executor.setThreadNamePrefix("CUSTOM-");

    // Initialize the executor
    executor.initialize();

    return executor;
}

Также по какой-то причине, если я использую bean-компонент в методе @PostConstruct, определенном в том же классе конфигурации, он не будет работать асинхронно. Причина в том, что метод @PostConstruct выполняется до выполнения getAsyncExecutor() и getAsyncUncaughtExceptionHandler():

AsyncBean.java:

@Component
public class AsyncBean implements IAsyncBean {

    @Override
    @Async
    public void whoAmI() {
        final String message =
                String.format("My name is %s and I am running in %s", getClass().getSimpleName(), Thread.currentThread());

        System.out.println(message);
    }
}

AsyncDemoApp.java:

@SpringBootApplication
@EnableAsync
public class AsyncDemoApp implements AsyncConfigurer {

    @Autowired
    private IAsyncBean asyncBean;

    public static void main(String[] args) {
        SpringApplication.run(AsyncDemoApp.class, args);
    }

    @Override
    public Executor getAsyncExecutor() {
        System.out.println("AsyncDemoApp.getAsyncExecutor");

        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setThreadNamePrefix("CUSTOM-");
        executor.initialize();

        return executor;
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        System.out.println("AsyncDemoApp.getAsyncUncaughtExceptionHandler");
        return (throwable, method, objects)
                -> throwable.printStackTrace();
    }

    @PostConstruct
    public void start() {
        System.out.println("AsyncDemoApp.start");
        asyncBean.whoAmI();
    }
}

Выход:

AsyncDemoApp.start
My name is AsyncBean and I am running in Thread[main,5,main]
AsyncDemoApp.getAsyncExecutor
AsyncDemoApp.getAsyncUncaughtExceptionHandler

Однако, если вы используете свой bean-компонент после того, как контекст приложения готов к использованию, все должно работать так, как ожидалось:

@SpringBootApplication
@EnableAsync
public class AsyncDemoApp implements AsyncConfigurer {

    public static void main(String[] args) {
        final ConfigurableApplicationContext context = SpringApplication.run(AsyncDemoApp.class, args);

        final IAsyncBean asyncBean = context.getBean(IAsyncBean.class);

        asyncBean.whoAmI();
    }

    @Override
    public Executor getAsyncExecutor() {
        System.out.println("AsyncDemoApp.getAsyncExecutor");

        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setThreadNamePrefix("CUSTOM-");
        executor.initialize();

        return executor;
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        System.out.println("AsyncDemoApp.getAsyncUncaughtExceptionHandler");
        return (throwable, method, objects)
                -> throwable.printStackTrace();
    }
}

Другое странное поведение заключается в том, что если вы автоподключаете асинхронный компонент в том же классе конфигурации, автоматическое подключение происходит до того, как настроен пользовательский асинхронный исполнитель, поэтому компонент не запускается асинхронно и выполняется в основном потоке. . Это можно проверить, добавив @PostConstruct к AsyncBean и используя CommandLineRunner для запуска приложения (лично я думаю, что это ошибка. Поведение, мягко говоря, очень удивительно):

AsyncBean с @PostConstruct:

@Component
public class AsyncBean implements IAsyncBean {

    @Override
    @Async
    public void whoAmI() {
        final String message =
                String.format("My name is %s and I am running in %s", getClass().getSimpleName(), Thread.currentThread());

        System.out.println(message);
    }

    @PostConstruct
    public void postConstruct() {
        System.out.println("AsyncBean is constructed");
    }
}

AsyncDemoApp реализация CommandLineRunner:

@SpringBootApplication
@EnableAsync
public class AsyncDemoApp implements AsyncConfigurer, CommandLineRunner {

    @Autowired
    private IAsyncBean asyncBean;

    public static void main(String[] args) {
        SpringApplication.run(AsyncDemoApp.class, args);
    }

    @Override
    public Executor getAsyncExecutor() {
        System.out.println("AsyncDemoApp.getAsyncExecutor");

        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setThreadNamePrefix("CUSTOM-");
        executor.initialize();

        return executor;
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        System.out.println("AsyncDemoApp.getAsyncUncaughtExceptionHandler");
        return (throwable, method, objects)
                -> throwable.printStackTrace();
    }

    @Override
    public void run(String... args) throws Exception {
        System.out.println("AsyncDemoApp.run");
        asyncBean.whoAmI();
    }
}

Выход:

AsyncBean is constructed
AsyncDemoApp.getAsyncExecutor
AsyncDemoApp.getAsyncUncaughtExceptionHandler
AsyncDemoApp.run
My name is AsyncBean and I am running in Thread[main,5,main]

Еще кое-что! :) Если вы используете ThreadPoolTaskExecutor, в зависимости от ваших требований, вы можете установить для свойства демона значение true, иначе ваше приложение будет продолжать работать вечно (это не большая проблема для веб-приложений/рабочих приложений). Вот что говорит JavaDoc от setDaemon(boolean):

Установите, должна ли эта фабрика создавать потоки демона, просто выполняющиеся, пока работает само приложение. По умолчанию «false»: бетонные заводы обычно поддерживают явную отмену. Следовательно, если приложение закрывается, Runnables по умолчанию завершает свое выполнение. Укажите «true» для быстрого закрытия потоков, которые все еще активно выполняют Runnable в то время, когда само приложение закрывается.