Spring Boot 异步编程

在 Spring Boot 中，异步编程可以显著提高应用程序的性能和响应能力，特别是在处理一些耗时的操作时。下面将详细介绍 Spring Boot 异步编程中异步方法的使用、线程池配置以及异步任务的监控与管理。

1. 异步方法的使用

步骤 1：启用异步支持

在 Spring Boot 主应用类上添加 @EnableAsync 注解来启用异步方法的支持。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;@SpringBootApplication
@EnableAsync
public class AsyncApplication {public static void main(String[] args) {SpringApplication.run(AsyncApplication.class, args);}
}

步骤 2：创建异步方法

在需要异步执行的方法上添加 @Async 注解。注意，异步方法必须是公共方法，并且不能在同一个类中调用自身的异步方法（因为 Spring 的 AOP 代理机制）。

import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;import java.util.concurrent.CompletableFuture;@Service
public class AsyncService {@Asyncpublic CompletableFuture<String> asyncMethod() throws InterruptedException {Thread.sleep(2000); // 模拟耗时操作return CompletableFuture.completedFuture("Async method completed");}
}

步骤 3：调用异步方法

在另一个服务或控制器中调用异步方法。

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;@RestController
public class AsyncController {@Autowiredprivate AsyncService asyncService;@GetMapping("/async")public String asyncRequest() throws InterruptedException {CompletableFuture<String> future = asyncService.asyncMethod();// 可以继续执行其他任务return "Request received, async method is processing";}
}

2. 线程池配置

默认情况下，Spring Boot 使用一个简单的线程池来执行异步任务。但是，为了更好地控制线程池的行为，我们可以自定义线程池。

步骤 1：创建线程池配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;import java.util.concurrent.Executor;@Configuration
@EnableAsync
public class AsyncConfig implements AsyncConfigurer {@Override@Bean(name = "asyncExecutor")public Executor getAsyncExecutor() {ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();executor.setCorePoolSize(5); // 核心线程数executor.setMaxPoolSize(10); // 最大线程数executor.setQueueCapacity(25); // 队列容量executor.setThreadNamePrefix("AsyncThread-"); // 线程名前缀executor.initialize();return executor;}
}

步骤 2：使用自定义线程池

在异步方法上指定使用自定义的线程池。

import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;import java.util.concurrent.CompletableFuture;@Service
public class AsyncService {@Async("asyncExecutor")public CompletableFuture<String> asyncMethod() throws InterruptedException {Thread.sleep(2000); // 模拟耗时操作return CompletableFuture.completedFuture("Async method completed");}
}

3. 异步任务的监控与管理

监控任务状态

可以使用 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;@RestController
public class AsyncController {@Autowiredprivate AsyncService asyncService;@GetMapping("/async")public String asyncRequest() throws InterruptedException {CompletableFuture<String> future = asyncService.asyncMethod();// 检查任务是否完成if (future.isDone()) {return "Async method completed: " + future.get();} else {return "Request received, async method is still processing";}}
}

管理任务

可以使用 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;@RestController
public class AsyncController {@Autowiredprivate AsyncService asyncService;@GetMapping("/async")public String asyncRequest() throws InterruptedException {CompletableFuture<String> future = asyncService.asyncMethod();// 取消任务future.cancel(true);return "Async method cancelled";}
}