Spring Boot - 异步任务

前言

有时候，前端可能提交了一个耗时任务，如果后端接收到请求后，直接执行该耗时任务，那么前端需要等待很久一段时间才能接受到响应。如果该耗时任务是通过浏览器直接进行请求，那么浏览器页面会一直处于转圈等待状态。一个简单的例子如下所示：

@RestController
@RequestMapping("async")
public class AsyncController {

    @GetMapping("/")
    public String index() throws InterruptedException {
        // 模拟耗时操作
        Thread.sleep(TimeUnit.SECONDS.toMillis(5));
        return "consuming time behavior done!";
    }
}

当我们在浏览器请求localhost:8080/async/页面时，可以看到浏览器一直处于转圈等待状态，这样体验十分不友好。

事实上，当后端要处理一个耗时任务时，通常都会将耗时任务提交到一个异步任务中进行执行，此时前端提交耗时任务后，就可直接返回，进行其他操作。

在 Java 中，开启异步任务最常用的方式就是开辟线程执行异步任务，如下所示：

@RestController
@RequestMapping("async")
public class AsyncController {

    @GetMapping("/")
    public String index() {
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    // 模拟耗时操作
                    Thread.sleep(TimeUnit.SECONDS.toMillis(5));
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        }).start();
        return "consuming time behavior processing!";
    }
}

这时浏览器请求localhost:8080/async/，就可以很快得到响应，并且耗时任务会在后台得到执行。

一般来说，前端不会关注耗时任务结果，因此前端只需负责提交该任务给到后端即可。但是如果前端需要获取耗时任务结果，则可通过Future等方式将结果返回，详细内容请参考后文。

事实上，在 Spring Boot 中，我们不需要手动创建线程异步执行耗时任务，因为 Spring 框架已提供了相关异步任务执行解决方案，本文主要介绍下在 Spring Boot 中执行异步任务的相关内容。

执行异步任务

Spring 3.0 时提供了一个@Async注解，该注解用于标记要进行异步执行的方法，当在其他线程调用被@Async注解的方法时，就会开启一个线程执行该方法。

注：@Async注解通常用在方法上，但是也可以用作类型上，当类被@Async注解时，表示该类中所有的方法都是异步执行的。

在 Spring Boot 中，如果要执行一个异步任务，只需进行如下两步操作：

  1. 使用注解@EnableAsync开启异步任务支持，如下所示：

    @SpringBootApplication
@ComponentScan("com.yn.async")
@EnableAsync // 开启异步调用
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

    @EnableAsync注解可以让 Spring 开启异步方法执行，它会让 Spring 扫描被其注解的包及其子包下被@Async注解的类或方法，所以这里我们在根包下配置@EnableAsync。

  2. 使用@Async注解标记要进行异步执行的方法，如下所示：

    @Service // 假设当前类是一个 Service
@Slf4j
public class AsyncTaskService {

    @Async
    public void asyncTaskWithoutReturnType() throws InterruptedException {
        log.info("asyncTaskWithoutReturnType: AsyncTaskService Thread = {}",Thread.currentThread().getName());
        // 模拟耗时任务
        Thread.sleep(TimeUnit.SECONDS.toMillis(5));
    }

    @Async
    public Future<String> asyncTaskWithReturnType() throws InterruptedException {
        log.info("asyncTaskWithReturnType: AsyncTaskService Thread = {}",Thread.currentThread().getName());
        // 模拟耗时任务
        Thread.sleep(TimeUnit.SECONDS.toMillis(5));
        return new AsyncResult<>("async tasks done!");
    }
}

    上述代码使用@Async标记了两个异步执行方法，一个没有返回值的asyncTaskWithoutReturnType，另一个拥有返回值asyncTaskWithReturnType，这里需要注意的一点时，被@Async注解的方法可以接受任意类型参数，但只能返回void或Future类型数据。所以当异步方法返回数据时，需要使用Future包装异步任务结果，上述代码使用AsyncResult包装异步任务结果，AsyncResult间接继承Future，是 Spring 提供的一个可用于追踪异步方法执行结果的包装类。其他常用的Future类型还有 Spring 4.2 提供的ListenableFuture，或者 JDK 8 提供的CompletableFuture，这些类型可提供更丰富的异步任务操作。

    如果前端需要获取耗时任务结果，则异步任务方法应当返回一个Future类型数据，此时Controller相关接口需要调用该Future的get()方法获取异步任务结果，get()方法是一个阻塞方法，因此该操作相当于将异步任务转换为同步任务，浏览器同样会面临我们前面所讲的转圈等待过程，但是异步执行还是有他的好处的，因为我们可以控制get()方法的调用时序，因此可以先执行其他一些操作后，最后再调用get()方法。

  3. 经过前面两个步骤后，其实就已经完成了异步任务配置。到此就可以调用这些异步任务方法，如下所示：

    @RestController
@RequestMapping("async")
@Slf4j
public class AsyncController {

    @Autowired // 注入异步任务类
    private AsyncTaskService asyncTaskService;

    @GetMapping("/asyncTaskWithoutReturnType")
    public void asyncTaskWithoutReturnType() throws InterruptedException {
        log.info("asyncTaskWithoutReturnType: Controller Thread = {}",Thread.currentThread().getName());
        this.asyncTaskService.asyncTaskWithoutReturnType();
    }

    @GetMapping("/asyncTaskWithReturnType")
    public String asyncTaskWithReturnType() throws Exception {
        log.info("asyncTaskWithReturnType: Controller Thread = {}",Thread.currentThread().getName());
        Future<String> future = this.asyncTaskService.asyncTaskWithReturnType();
        return future.get();
    }
}

    请求上述两个接口，如下所示：

    $ curl -X GET localhost:8080/async/asyncTaskWithoutReturnType

$ curl -X GET localhost:8080/async/asyncTaskWithReturnType
async tasks done!

    查看日志，如下图所示：


    可以看到，异步任务方法运行在于Controller不同的线程上。

异步任务相关限制

被@Async注解的异步任务方法存在相关限制：

  • 被@Async注解的方法必须是public的，这样方法才可以被代理。

  • 不能在同一个类中调用@Async方法，因为同一个类中调用会绕过方法代理，调用的是实际的方法。

  • 被@Async注解的方法不能是static。

  • @Async不能用于被@Configuration注解的类方法上。
    注：官方文档写的是不能在@Configuration类中使用，但本人实际测试发现，无论是将@Async注解到@Configuration类上，还是将@Async注解到方法上，都是可以异步执行方法的。

  • @Async注解不能与 Bean 对象的生命周期回调函数（比如@PostConstruct）一起注解到同一个方法中。解决方法可参考：Spring - The @Async annotation

  • 异步类必须注入到 Spring IOC 容器中（也即异步类必须被@Component/@Service等进行注解）。

  • 其他类中使用异步类对象必须通过@Autowired等方式进行注入，不能手动new对象。

自定义 Executor

默认情况下，Spring 会自动搜索相关线程池定义：要么是一个唯一TaskExecutor Bean 实例，要么是一个名称为taskExecutor的Executor Bean 实例。如果这两个 Bean 实例都不存在，就会使用SimpleAsyncTaskExecutor来异步执行被@Async注解的方法。

综上，可以知道，默认情况下，Spring 使用的 Executor 是SimpleAsyncTaskExecutor，SimpleAsyncTaskExecutor每次调用都会创建一个新的线程，不会重用之前的线程。很多时候，这种实现方式不符合我们的业务场景，因此通常我们都会自定义一个 Executor 来替换SimpleAsyncTaskExecutor。

对于自定义 Executor（自定义线程池），可以分为如下两个层级：

  • 方法层级：即为单独一个或多个方法指定运行线程池，其他未指定的异步方法运行在默认线程池。如下所示：

    @SpringBootApplication
@ComponentScan("com.yn.async")
@EnableAsync
public class Application {
    // ...
    @Bean("methodLevelExecutor1")
    public TaskExecutor getAsyncExecutor1() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 设置核心线程数
        executor.setCorePoolSize(4);
        // 设置最大线程数
        executor.setMaxPoolSize(20);
        // 等待所有任务结束后再关闭线程池
        executor.setWaitForTasksToCompleteOnShutdown(true);
        // 设置线程默认前缀名
        executor.setThreadNamePrefix("Method-Level-Async1-");
        return executor;
    }

    @Bean("methodLevelExecutor2")
    public TaskExecutor getAsyncExecutor2() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 设置核心线程数
        executor.setCorePoolSize(8);
        // 设置最大线程数
        executor.setMaxPoolSize(20);
        // 等待所有任务结束后再关闭线程池
        executor.setWaitForTasksToCompleteOnShutdown(true);
        // 设置线程默认前缀名
        executor.setThreadNamePrefix("Method-Level-Async2-");
        return executor;
    }
}

    上述特意设置了多个TaskExecutor，因为如果只设置一个TaskExecutor，那么 Spring 就会默认采用该TaskExecutor作为所有@Async的Executor，而设置了多个TaskExecutor，Spring 检测到全局存在多个Executor，就会降级使用默认的SimpleAsyncTaskExecutor，此时我们就可以为@Async方法配置执行线程池，其他未配置的@Async就会默认运行在SimpleAsyncTaskExecutor中，这就是方法层级的自定义 Executor。如下代码所示：

    @RestController
@RequestMapping("async")
@Slf4j
public class AsyncController {

    @Autowired // 注入异步任务类
    private AsyncTaskService asyncTaskService;

    @GetMapping("/asyncTaskWithoutReturnType")
    public void asyncTaskWithoutReturnType() throws InterruptedException {
        log.info("asyncTaskWithoutReturnType: Controller Thread = {}",Thread.currentThread().getName());
        this.asyncTaskService.asyncTaskWithoutReturnType();
    }

    @GetMapping("/asyncTaskWithReturnType")
    public String asyncTaskWithReturnType() throws Exception {
        log.info("asyncTaskWithReturnType: Controller Thread = {}",Thread.currentThread().getName());
        Future<String> future = this.asyncTaskService.asyncTaskWithReturnType();
        return future.get();
    }
}

    请求上述接口，如下所示：

    $ curl -X GET localhost:8080/async/asyncTaskWithoutReturnType

$ curl -X GET localhost:8080/async/asyncTaskWithReturnType
async tasks done!

    请求日志如下所示：

    2020-09-25 00:55:31,953 INFO  [http-nio-8080-exec-1] com.yn.async.AsyncController: asyncTaskWithoutReturnType: Controller Thread = http-nio-8080-exec-1
2020-09-25 00:55:31,984 INFO  [Method-Level-Async1-1] com.yn.async.AsyncTaskService: asyncTaskWithoutReturnType: AsyncTaskService Thread = Method-Level-Async1-1
2020-09-25 00:55:45,592 INFO  [http-nio-8080-exec-2] com.yn.async.AsyncController: asyncTaskWithReturnType: Controller Thread = http-nio-8080-exec-2
2020-09-25 00:55:45,594 INFO  [http-nio-8080-exec-2] org.springframework.aop.interceptor.AsyncExecutionAspectSupport: More than one TaskExecutor bean found within the context, and none is named 'taskExecutor'. Mark one of them as primary or name it 'taskExecutor' (possibly as an alias) in order to use it for async processing: [methodLevelExecutor1, methodLevelExecutor2]
2020-09-25 00:55:45,595 INFO  [SimpleAsyncTaskExecutor-1] com.yn.async.AsyncTaskService: asyncTaskWithReturnType: AsyncTaskService Thread = SimpleAsyncTaskExecutor-1

    结果跟我们上述的分析一致。

  • 应用层级：即全局生效的 Executor。依据 Spring 默认搜索机制，其实就是配置一个全局唯一的TaskExecutor实例或者一个名称为taskExecutor的Executor实例即可，如下所示：

    @SpringBootApplication
@ComponentScan("com.yn.async")
@EnableAsync
public class Application {
    // ...
    @Bean("taskExecutor")
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 设置核心线程数
        int cores = Runtime.getRuntime().availableProcessors();
        executor.setCorePoolSize(cores);
        // 设置最大线程数
        executor.setMaxPoolSize(20);
        // 等待所有任务结束后再关闭线程池
        executor.setWaitForTasksToCompleteOnShutdown(true);
        // 设置线程默认前缀名
        executor.setThreadNamePrefix("Application-Level-Async-");
        return executor;
    }
}

    上述代码定义了一个名称为taskExecutor的Executor，此时@Async方法默认就会运行在该Executor中。

    其实 Spring 还提供了另一个功能更加强大的接口AsyncConfigurer，该接口主要是用于自定义一个Executor配置类，提供了应用层级Executor接口，以及对于@Async方法异常捕获功能。如果 Spring 检测到该接口实例，会优先采用该接口自定义的Executor。如下所示：

    @Configuration
@EnableAsync
public class AsyncConfigure implements AsyncConfigurer {
    @Override
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 设置核心线程数
        int cores = Runtime.getRuntime().availableProcessors();
        executor.setCorePoolSize(cores);
        // 设置最大线程数
        executor.setMaxPoolSize(20);
        // 等待所有任务结束后再关闭线程池
        executor.setWaitForTasksToCompleteOnShutdown(true);
        // 设置线程默认前缀名
        executor.setThreadNamePrefix("AsyncConfigure-");
        // 注意，此时需要调用 initialize
        executor.initialize();
        return executor;
    }
}

    注：使用自定义实现AsyncConfigurer接口的配置类的另一个好处就是无论@EnableAsync的包层级多深，默认都会对整个项目扫描@Async方法，这样我们就无需将@EnableAsync注解到根包类中。

异常处理

前文介绍过，对于被@Async注解的异步方法，只能返回void或者Future类型。对于返回Future类型数据，如果异步任务方法抛出异常，则很容易进行处理，因为Future.get()会重新抛出该异常，我们只需对其进行捕获即可。但是对于返回void的异步任务方法，异常不会传播到被调用者线程，因此我们需要自定义一个额外的异步任务异常处理器，捕获异步任务方法抛出的异常。

自定义异步任务异常处理器的步骤如下所示：

  1. 首先自定义一个异常处理器类实现接口AsyncUncaughtExceptionHandler，如下所示：

    public class CustomAsyncExceptionHandler implements AsyncUncaughtExceptionHandler {
    @Override
    public void handleUncaughtException(Throwable throwable, Method method, Object... objects) {
        System.out.println("Exception message - " + throwable.getMessage());
        System.out.println("Method name - " + method.getName());
        for (Object param : objects) {
            System.out.println("Parameter value - " + param);
        }
    }
}

  2. 然后，创建一个自定义Executor异步配置类，将我们的自定义异常处理器设置到其接口上。如下所示：

    @Configuration
@EnableAsync
public class AsyncConfigure implements AsyncConfigurer {
    // ...

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return new CustomAsyncExceptionHandler();
    }
}

    此时异步方法如果抛出异常，就可以被我们的自定义异步异常处理器捕获得到。

参考

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 201,681评论 5赞 474
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 84,710评论 2赞 377
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 148,623评论 0赞 334
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,202评论 1赞 272
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,232评论 5赞 363
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,368评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,795评论 3赞 393
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,461评论 0赞 256
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,647评论 1赞 295
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2赞 317
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,226评论 3赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,785评论 3赞 303
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1赞 258
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2赞 348
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2赞 341