Spring Boot使用@Async实现异步调用返回结果：使用Future以及定义超时

关于使用 @Async实现异步调用的内容，也得到不少童鞋的反馈，其中问题比较多的就是关于返回 Future的使用方法以及对异步执行的超时控制，所以这篇就来一起讲讲这两个问题的处理。

 

如果您对于 @Async注解的使用还不了解的话，可以看看之前的文章，具体如下：

• 使用@Async实现异步调用：自定义线程池

• 使用@Async实现异步调用：资源优雅关闭

定义异步任务

首先，我们先使用 @Async注解来定义一个异步任务，这个方法返回 Future类型，具体如下：

1. @Slf4j

2. @Component

3. public class Task {

4.  

5.    public static Random random = new Random();

6.  

7.    @Async("taskExecutor")

8.    public Future<String> run() throws Exception {

9.        long sleep = random.nextInt(10000);

10.        log.info("开始任务，需耗时：" + sleep + "毫秒");

11.        Thread.sleep(sleep);

12.        log.info("完成任务");

13.        return new AsyncResult<>("test");

14.    }

15.  

16. }

Tips：什么是 Future类型？

Future是对于具体的 Runnable或者 Callable任务的执行结果进行取消、查询是否完成、获取结果的接口。必要时可以通过get方法获取执行结果，该方法会阻塞直到任务返回结果。

它的接口定义如下：

1. public interface Future<V> {

2.    boolean cancel(boolean mayInterruptIfRunning);

3.    boolean isCancelled();

4.    boolean isDone();

5.    V get() throws InterruptedException, ExecutionException;

6.    V get(long timeout, TimeUnit unit)

7.        throws InterruptedException, ExecutionException, TimeoutException;

8. }

它声明这样的五个方法：

• cancel方法用来取消任务，如果取消任务成功则返回true，如果取消任务失败则返回false。参数mayInterruptIfRunning表示是否允许取消正在执行却没有执行完毕的任务，如果设置true，则表示可以取消正在执行过程中的任务。如果任务已经完成，则无论mayInterruptIfRunning为true还是false，此方法肯定返回false，即如果取消已经完成的任务会返回false；如果任务正在执行，若mayInterruptIfRunning设置为true，则返回true，若mayInterruptIfRunning设置为false，则返回false；如果任务还没有执行，则无论mayInterruptIfRunning为true还是false，肯定返回true。

• isCancelled方法表示任务是否被取消成功，如果在任务正常完成前被取消成功，则返回 true。

• isDone方法表示任务是否已经完成，若任务完成，则返回true；

• get()方法用来获取执行结果，这个方法会产生阻塞，会一直等到任务执行完毕才返回；

• get(long timeout, TimeUnit unit)用来获取执行结果，如果在指定时间内，还没获取到结果，就直接返回null。

也就是说Future提供了三种功能：

1. 判断任务是否完成；

2. 能够中断任务；

3. 能够获取任务执行结果。

测试执行与定义超时

在完成了返回 Future的异步任务定义之后，我们来尝试实现一个单元测试来使用这个Future完成任务的执行，比如：

1. @Slf4j

2. @RunWith(SpringJUnit4ClassRunner.class)

3. @SpringBootTest

4. public class ApplicationTests {

5.  

6.    @Autowired

7.    private Task task;

8.  

9.    @Test

10.    public void test() throws Exception {

11.        Future<String> futureResult = task.run();

12.        String result = futureResult.get(5, TimeUnit.SECONDS);

13.        log.info(result);

14.    }

15.  

16. }

上面的代码中，我们在get方法中还定义了该线程执行的超时时间，通过执行这个测试我们可以观察到执行时间超过5秒的时候，这里会抛出超时异常，该执行线程就能够因执行超时而释放回线程池，不至于一直阻塞而占用资源。

完整示例：

读者可以根据喜好选择下面的两个仓库中查看 Chapter4-1-5项目：

• Github：https://github.com/dyc87112/SpringBoot-Learning/

• Gitee：https://gitee.com/didispace/SpringBoot-Learning/

如果您对这些感兴趣，欢迎star、follow、收藏、转发给予支持！

热文推荐：

理解使用 JWT 设计的单点登录系统

全球最大同性交友网站 GitHub 10 岁了！

JDK 1.5 - 1.8 各版本的新特性总结

Spring Boot快速开发利器：Spring Boot CLI

IntelliJ IDEA 2018.1正式发布！还能这么玩？

消息中间件选型分析

 

其他推荐：

从Spring-Session源码看Session机制的实现细节

Spring Boot使用@Async实现异步调用：线程池的优雅关闭

Spring Boot使用@Async实现异步调用：自定义线程池

Spring Boot 2.0正式发布，升还是不升呢？

Spring Boot 2.0 新特性概览

Spring Boot/Cloud干货汇总