SpringBoot 如何使用 @Async 注解处理异步事件

╰+攻爆jí腚メ 2023-10-12 19:03 5阅读 0赞

## SpringBoot 如何使用 @Async 注解处理异步事件 ##

在现代应用程序中，异步编程已经成为了必备的技能。异步编程使得应用程序可以同时处理多个请求，从而提高了应用程序的吞吐量和响应速度。在 SpringBoot 中，我们可以使用 @Async 注解来实现异步编程。本文将介绍 @Async 注解的使用方法和注意事项。

![在这里插入图片描述][6f70f0e2b17241819e77129b34fed5be.png]

### 什么是 @Async 注解 ###

@Async 注解是 Spring Framework 中的一个注解，它可以用来标记一个方法是异步的。当一个方法被 @Async 注解标记之后，Spring Framework 会自动创建一个线程池，并将这个方法的执行放到线程池中进行。这样，就可以避免在执行这个方法时阻塞主线程，从而提高了应用程序的性能和响应速度。

### 如何使用 @Async 注解 ###

使用 @Async 注解非常简单，只需要在需要异步执行的方法上添加 @Async 注解即可。下面是一个示例代码：

@Service
    public class EmailService {
        
    
        @Autowired
        private JavaMailSender mailSender;
    
        @Async
        public void sendEmail(String to, String subject, String content) {
        
            SimpleMailMessage message = new SimpleMailMessage();
            message.setTo(to);
            message.setSubject(subject);
            message.setText(content);
            mailSender.send(message);
        }
    }

在上面的代码中，我们定义了一个 EmailService 类，其中有一个 sendEmail 方法。这个方法被 @Async 注解标记，表示它是一个异步方法。当我们调用这个方法时，Spring Framework 会自动创建一个线程池，然后将这个方法的执行放到线程池中进行。这样就可以避免在执行 sendEmail 方法时阻塞主线程，从而提高应用程序的性能和用户体验。

需要注意的是，@Async 注解只能用在 public 方法上。在同一个类中的异步方法调用，不会走代理类，而是直接调用该类的方法，这样不会产生异步效果。

除了在 Service 类中使用 @Async 注解，我们还可以在 Controller 类中使用它。例如，我们可以在 Controller 中定义一个异步的方法来处理用户提交的表单数据，从而避免阻塞用户界面。下面是一个示例代码：

@RestController
    public class UserController {
        
    
        @Autowired
        private UserService userService;
    
        @PostMapping("/user")
        public void addUser(@RequestBody User user) {
        
            userService.addUser(user);
        }
    
        @Async
        public void addUserAsync(User user) {
        
            userService.addUser(user);
        }
    }

在上面的代码中，我们定义了一个 addUser 方法和一个 addUserAsync 方法。addUser 方法是一个普通的方法，它会阻塞主线程，而 addUserAsync 方法被 @Async 注解标记，表示它是一个异步方法。当我们调用 addUserAsync 方法时，Spring Framework 会自动创建一个线程池，然后将 addUser 方法的执行放到线程池中进行，从而实现异步处理。

### @Async 注解的注意事项 ###

虽然使用 @Async 注解可以很方便地实现异步编程，但是在使用 @Async 注解时，我们也需要注意一些事项。

#### 1. 确保异步方法是线程安全的 ####

由于异步方法是在一个单独的线程中执行的，因此我们需要确保异步方法是线程安全的。如果异步方法中使用了共享变量或者存在竞争条件，那么就需要使用同步机制来保证线程安全。

#### 2. 使用合适的线程池 ####

当我们使用 @Async 注解时，Spring Framework 会自动创建一个线程池来执行异步方法。默认情况下，Spring Framework 会创建一个线程数为 1 的线程池。如果我们需要同时执行多个异步方法，那么就需要将线程池的大小调整为合适的大小。

我们可以通过配置文件来调整线程池的大小。例如，在 application.properties 文件中，我们可以添加以下配置：

spring.task.execution.pool.core-size=10
    spring.task.execution.pool.max-size=50
    spring.task.execution.pool.queue-capacity=1000

在上面的配置中，我们将线程池的核心大小设置为 10，最大大小设置为 50，队列容量设置为 1000。这样，当我们执行多个异步方法时，线程池就可以自动扩展，从而更好地处理异步任务。

#### 3. 使用 CompletableFuture 异步编程 ####

除了使用 @Async 注解来实现异步编程外，我们还可以使用 Java 8 中新增的 CompletableFuture 类来实现异步编程。CompletableFuture 类提供了更加灵活的异步编程方式，可以更好地处理异步任务的结果。

下面是一个使用 CompletableFuture 实现异步编程的示例代码：

@Service
    public class EmailService {
        
    
        @Autowired
        private JavaMailSender mailSender;
    
        public CompletableFuture<Void> sendEmail(String to, String subject, String content) {
        
            return CompletableFuture.runAsync(() -> {
        
                SimpleMailMessage message = new SimpleMailMessage();
                message.setTo(to);
                message.setSubject(subject);
                message.setText(content);
                mailSender.send(message);
            });
        }
    }

在上面的代码中，我们使用了 CompletableFuture 类来实现异步编程。我们定义了一个 sendEmail 方法，这个方法返回一个 CompletableFuture 对象。在这个方法中，我们使用 CompletableFuture.runAsync() 方法来创建一个异步任务，然后将 sendEmail 的执行放到异步任务中进行。最后，我们返回一个 CompletableFuture 对象，表示异步任务执行完成。

使用 CompletableFuture 可以更加灵活地处理异步任务的结果。例如，我们可以使用 CompletableFuture.supplyAsync() 方法来创建一个带返回值的异步任务：

public CompletableFuture<String> getUserInfo(String userId) {
        
        return CompletableFuture.supplyAsync(() -> {
        
            // 查询用户信息
            return userInfo;
        });
    }

在上面的代码中，我们使用 CompletableFuture.supplyAsync() 方法来创建一个带返回值的异步任务，这个任务会查询用户信息，并返回一个字符串类型的结果。使用 CompletableFuture 可以更好地处理异步任务的结果，让异步编程更加灵活和高效。

### 总结 ###

使用 @Async 注解可以很方便地实现异步编程，提高应用程序的性能和用户体验。需要注意的是，在使用 @Async 注解时，我们需要确保异步方法是线程安全的，并使用合适的线程池来处理异步任务。除了使用 @Async 注解，我们还可以使用 CompletableFuture 类来实现异步编程，更加灵活地处理异步任务的结果。

[6f70f0e2b17241819e77129b34fed5be.png]: https://img-blog.csdnimg.cn/6f70f0e2b17241819e77129b34fed5be.png