springboot 异步注解

### Spring Boot 异步处理注解及其使用方法 #### 启用异步支持 为了在Spring Boot中启用异步处理，需要在启动类或配置类上添加`@EnableAsync`注解[^3]。 ```java import org.springframework.scheduling.annotation.EnableAsync; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication @EnableAsync public class AsyncApplication { public static void main(String[] args) { SpringApplication.run(AsyncApplication.class, args); } } ``` #### 定义异步方法 对于想要标记为异步执行的方法，在其声明前加上`@Async`注解即可。需要注意的是，如果该方法位于同一组件内部被调用，则不会触发真正的异步行为；因此建议将此类方法放置于独立的服务层或其他组件之中。 ```java import org.springframework.scheduling.annotation.Async; import org.springframework.stereotype.Service; @Service public class AsyncTaskService { @Async public void executeAsyncTask() throws InterruptedException { System.out.println("Start executing async task..."); Thread.sleep(5000); // Simulate a long-running operation. System.out.println("Finish executing async task."); } @Async public CompletableFuture<String> getHelloWorldMessage() throws InterruptedException { System.out.println("Processing hello world message asynchronously..."); Thread.sleep(2000L); return CompletableFuture.completedFuture("Hello World!"); } } ``` 上述例子展示了两种不同类型的返回值：一种是没有返回值(`void`)的情况，另一种则是带有返回值(`CompletableFuture<T>`)[^4]。当期望获取到异步操作的结果时，推荐采用后者的形式以便后续能够更加灵活地组合多个异步任务。 #### 调用异步服务 下面是一个控制器的例子，它会调用上面定义好的异步服务并等待结果完成： ```java @RestController @RequestMapping("/async") public class AsyncController { private final Logger logger = LoggerFactory.getLogger(this.getClass()); @Autowired private AsyncTaskService asyncTaskService; @GetMapping("/execute-task") public String executeTask() throws ExecutionException, InterruptedException { asyncTaskService.executeAsyncTask(); return "Invoked asynchronous task."; } @GetMapping("/hello-world") public ResponseEntity<?> sayHelloWorld() throws Exception { CompletableFuture<String> futureResult = asyncTaskService.getHelloWorldMessage(); // Do other things while waiting for the result... String result = futureResult.get(); // Wait until completion and retrieve value. return new ResponseEntity<>(result, HttpStatus.OK); } } ``` 在这个案例里，`sayHelloWorld()`端点会在后台发起一个异步消息构建过程的同时继续做别的事情，最后再收集最终的消息作为HTTP响应的一部分发送给客户端。

Spring Boot 提供了多种异步处理的注解，用于简化基于任务（Task-based）或消息驱动（Message-driven）的应用程序开发。其中两个常用的异步注解包括： 1. `@Async`: 这个注解可以标记在方法上，使得该方法会在后台线程池中异步执行，而不会阻塞主线程。例如： ```java @Autowired private TaskExecutor executor; @Async("customThreadPool") public void asyncMethod() { // 长时间运行的任务 } ``` 在这里，`customThreadPool`是你自定义的一个线程池名称。 2. `@Scheduled`: 如果你需要定期执行某个任务，比如定时发送邮件或者数据统计，可以使用这个注解配合`Spring Scheduler`。例如： ```java @Component @EnableScheduling public class MyTask { @Scheduled(cron = "0 0/5 * * * ?") // 每五分钟执行一次 public void scheduledTask() { // 执行任务 } } ``` 这两个注解都允许你在Spring Boot应用中轻松地添加异步和调度功能。使用它们可以使你的代码更简洁、易于理解和维护。