@EnableAsync 和 @Async 注解的使用方法
@EnableAsync 和 @Async 是Spring框架中的两个注解，用于启用和使用异步方法执行。它们可以帮助你在Spring应用程序中实现异步编程，从而提高应用程序的性能和响应速度。
@EnableAsync
@EnableAsync 注解用于启用Spring的异步方法执行功能。你需要在配置类或主应用程序类上添加这个注解，以便Spring能够扫描并处理 @Async 注解的方法。
@Async
@Async 注解用于标记一个方法为异步方法。当Spring调用这个方法时，它会在一个独立的线程中执行，而不会阻塞调用者的线程。
使用步骤
- 启用异步支持：在配置类或主应用程序类上添加
@EnableAsync注解。 - 标记异步方法：在需要异步执行的方法上添加
@Async注解。
示例代码
1. 启用异步支持
在主应用程序类或配置类上添加 @EnableAsync 注解。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;@SpringBootApplication
@EnableAsync
public class MyApplication {public static void main(String[] args) {SpringApplication.run(MyApplication.class, args);}
}
2. 标记异步方法
在需要异步执行的方法上添加 @Async 注解。
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;@Service
public class MyService {@Asyncpublic void performAsyncTask() {// 这个方法将在一个独立的线程中执行System.out.println("执行异步任务");try {Thread.sleep(5000); // 模拟耗时操作} catch (InterruptedException e) {e.printStackTrace();}System.out.println("异步任务完成");}
}
3. 调用异步方法
在其他地方调用异步方法。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyController {@Autowiredprivate MyService myService;@GetMapping("/async")public String executeAsyncTask() {myService.performAsyncTask();return "异步任务已提交";}
}
注意事项
- 返回类型：异步方法可以返回
void、Future或CompletableFuture。如果需要获取异步方法的结果，可以使用Future或CompletableFuture。
@Async
public CompletableFuture<String> performAsyncTaskWithResult() {// 这个方法将在一个独立的线程中执行System.out.println("执行异步任务");try {Thread.sleep(5000); // 模拟耗时操作} catch (InterruptedException e) {e.printStackTrace();}return CompletableFuture.completedFuture("异步任务完成");
}
- 线程池配置：默认情况下，Spring使用一个简单的线程池来执行异步任务。你可以自定义线程池，以满足特定的性能需求。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;import java.util.concurrent.Executor;@Configuration
@EnableAsync
public class AsyncConfig {@Bean(name = "taskExecutor")public Executor taskExecutor() {ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();executor.setCorePoolSize(5);executor.setMaxPoolSize(10);executor.setQueueCapacity(25);executor.setThreadNamePrefix("Async-");executor.initialize();return executor;}
}
- 类级别的
@Async：你也可以在类级别上使用@Async注解，表示该类中的所有方法都将异步执行。
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;@Service
@Async
public class MyService {public void performAsyncTask() {// 这个方法将在一个独立的线程中执行System.out.println("执行异步任务");}
}
通过使用 @EnableAsync 和 @Async 注解，你可以轻松地在Spring应用程序中实现异步方法执行，从而提高应用程序的性能和响应速度。
获取异步结果
主线程可以通过 CompletableFuture 的方法来获取异步任务的结果。
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;@RestController
public class MyController {@Autowiredprivate MyService myService;@GetMapping("/async")public String executeAsyncTask() throws ExecutionException, InterruptedException {// 调用异步方法，立即返回一个 CompletableFuture 对象CompletableFuture<String> future = myService.performAsyncTaskWithResult();// 主线程不会被阻塞，可以继续执行其他操作System.out.println("异步任务已提交");// 获取异步任务的结果（会阻塞直到结果可用）String result = future.get();return result;}
}
总结
- 调用异步方法时：由于
@Async注解，异步方法将在一个独立的线程中执行，调用该方法的主线程不会被阻塞。 - 立即返回
CompletableFuture对象：调用异步方法后，主线程会立即返回一个CompletableFuture对象，表示异步任务的结果。 - 获取结果：主线程可以通过
CompletableFuture的方法来获取异步任务的结果，而不需要等待异步任务完成。
)
