Spring Boot 中的 @Async 注解是什么，如何使用

Spring Boot 中的 @Async 注解是什么，如何使用

引言

在开发 Web 应用程序时，经常需要执行一些耗时的操作，比如发送邮件、生成报表、调用第三方接口等等。这些操作如果在主线程中执行，会导致请求响应时间过长，影响用户体验。为了避免这种情况，我们可以使用异步执行的方式来执行这些操作。Spring Boot 中提供了 @Async 注解，可以方便地实现异步执行。本文将介绍 @Async 注解的基本用法，并附上代码示例，帮助读者更好地理解和使用该注解。

@Async 注解是什么？

@Async 注解是 Spring Boot 中的一个异步执行注解，可以用来标记一个方法是异步执行的。被 @Async 注解修饰的方法会在一个新的线程中执行，不会阻塞当前线程。当方法执行完毕后，会将执行结果返回给调用方。

如何使用 @Async 注解？

在使用 @Async 注解之前，需要先进行一些配置。首先，需要在启动类中加上 @EnableAsync 注解，开启异步执行功能。其次，还需要配置一个任务执行器，可以使用 Spring 提供的默认任务执行器，也可以自定义一个任务执行器。下面是一个简单的示例：

@SpringBootApplication
@EnableAsync
public class Application {

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

    @Bean
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(20);
        executor.setQueueCapacity(30);
        executor.initialize();
        return executor;
    }

}

上述示例中，我们在启动类上加上了 @EnableAsync 注解，开启异步执行功能。然后，我们定义了一个名为 taskExecutor 的 Bean，用来配置任务执行器。在该任务执行器中，我们设置了核心线程数、最大线程数和队列容量等参数。

接下来，我们就可以在需要异步执行的方法上添加 @Async 注解了。下面是一个示例：

@Service
public class MyService {

    private static final Logger LOGGER = LoggerFactory.getLogger(MyService.class);

    @Async
    public CompletableFuture<String> doSomething() {
        LOGGER.info("执行异步任务");
        // 模拟耗时操作
        try {
            Thread.sleep(5000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return CompletableFuture.completedFuture("异步执行完成");
    }

}

上述示例中，我们定义了一个名为 MyService 的服务，其中的 doSomething 方法被 @Async 注解修饰，表示该方法是异步执行的。在该方法中，我们使用了 SLF4J 的日志功能，输出一条日志，然后模拟了一个耗时操作，睡眠 5 秒钟，最后返回一个 CompletableFuture 对象，表示异步执行完成。需要注意的是，被 @Async 注解修饰的方法必须返回一个 CompletableFuture 对象。

最后，我们还需要在调用方的方法中使用 CompletableFuture 来获取异步执行的结果。下面是一个示例：

@RestController
public class MyController {

    private static final Logger LOGGER = LoggerFactory.getLogger(MyController.class);

    @Autowired
    private MyService myService;

    @GetMapping("/doAsync")
    public CompletableFuture<String> doAsync() {
        LOGGER.info("开始执行异步任务");
        return myService.doSomething().thenApply(result -> {
            LOGGER.info("异步任务执行结果：{}", result);
            return result;
        });
    }

}

上述示例中，我们定义了一个名为 MyController 的控制器，其中的 doAsync 方法用来调用 MyService 中的 doSomething 方法，实现异步执行。在该方法中，我们使用了 SLF4J 的日志功能，输出两条日志，然后使用 CompletableFuture 的 thenApply 方法来获取异步执行的结果，最后返回该结果。

代码示例

下面是一个完整的示例，演示了如何使用 @Async注解实现异步执行。

启动类：

@SpringBootApplication
@EnableAsync
public class Application {

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

    @Bean
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(20);
        executor.setQueueCapacity(30);
        executor.initialize();
        return executor;
    }

}

服务类：

@Service
public class MyService {

    private static final Logger LOGGER = LoggerFactory.getLogger(MyService.class);

    @Async
    public CompletableFuture<String> doSomething() {
        LOGGER.info("执行异步任务");
        // 模拟耗时操作
        try {
            Thread.sleep(5000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return CompletableFuture.completedFuture("异步执行完成");
    }

}

控制器类：

@RestController
public class MyController {

    private static final Logger LOGGER = LoggerFactory.getLogger(MyController.class);

    @Autowired
    private MyService myService;

    @GetMapping("/doAsync")
    public CompletableFuture<String> doAsync() {
        LOGGER.info("开始执行异步任务");
        return myService.doSomething().thenApply(result -> {
            LOGGER.info("异步任务执行结果：{}", result);
            return result;
        });
    }

}

总结

@Async 注解是 Spring Boot 中一个非常实用的异步执行注解，可以帮助开发者实现一些耗时的操作，提高应用程序的响应速度。本文介绍了 @Async 注解的基本用法，并附上了代码示例，希望读者可以通过本文更好地理解和使用该注解。