Spring Boot 异步框架的使用详解

SpringBoot异步框架的使用详解

Spring Boot提供了异步执行任务的能力。这样的好处是可以让Tomcat等容器可以释放当前线程，从而不会阻塞其他的请求，并且优化服务器资源，从而提供更好的性能。

异步框架概述

Spring Boot中异步框架主要包括异步调用和异步任务两方面。

异步调用

直接从控制器中异步执行一个函数。当这个异步函数执行完成之后，返回值会被封装到CompletableFuture对象中，然后再进行数据的处理。

@RestController
public class TestController {

    @Autowired
    TestService testService;

    @GetMapping("/hello")
    public CompletableFuture<String> sayHello() {
        return testService.sayHello();
    }
}

@Service
public class TestService {

    @Async("taskExecutor")
    public CompletableFuture<String> sayHello() {
        return CompletableFuture.completedFuture("Hello");
    }
}

这里需要注意的是，异步函数是在TestService中执行，主要是设置了@Async("taskExecutor")注解，这个注解表示异步函数在一个自定义的线程池中执行，具体的线程池配置可以在配置文件中进行设置。而控制器中调用了TestService中的异步函数，函数返回值是一个CompletableFuture对象，它可以表示异步任务的状态，可以通过调用get()方法来获取函数执行的结果，当然这个方法也可以选择阻塞或不阻塞的方式来获取结果。

异步任务

通过异步任务实现将一些操作放到后台线程中执行，不影响主线程的执行，同时可以实现一些任务的批处理，大大地提高了程序的执行效率。

@Component
public class TestTask {

    @Autowired
    TestDao testDao;

    @Async("asyncExecutor")
    public void clearCache() {
        testDao.clearCache();
    }
}

这里需要注意的是，异步任务的实现需要使用@Async("asyncExecutor")注解，后面的参数指定了异步任务执行时所使用的线程池，具体的线程池配置可以在配置文件中进行设置。异步任务的执行不需要返回值，如果有需要返回值的情况可以考虑使用CompletableFuture对象进行封装。

异步框架的配置

在Spring Boot中配置异步框架需要进行以下步骤：

1. 添加@EnableAsync注解，激活异步框架。
2. 配置线程池，指定异步函数或任务的执行线程池。

下面我们结合示例来进行说明。

@SpringBootApplication
@EnableAsync
public class AsyncApplication {

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

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

    @Bean("asyncExecutor")
    public ThreadPoolTaskExecutor asyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(5);
        executor.setMaxPoolSize(10);
        executor.setQueueCapacity(100);
        executor.initialize();
        return executor;
    }
}

上述配置中，我们定义了两个线程池，一个是taskExecutor，用于组合异步函数。另外一个是asyncExecutor，用于执行异步任务。它们的具体参数设置可以根据实际的需求进行调整。

示例1：异步调用

我们先来看一个异步调用示例：

定义异步函数：

@Service
public class TestService {

    @Async("taskExecutor")
    public CompletableFuture<String> sayHello() {
        try {
            Thread.sleep(5000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return CompletableFuture.completedFuture("Hello");
    }
}

定义控制器：

@RestController
public class TestController {

    @Autowired
    TestService testService;

    @GetMapping("/hello")
    public CompletableFuture<String> sayHello() {
        return testService.sayHello();
    }
}

在这个示例中，我们定义了一个异步函数sayHello，这个函数其实什么都没做，只是将当前线程休眠了5000毫秒然后返回"Hello"。在控制器中我们直接调用了sayHello函数，返回值是一个CompletableFuture对象，当sayHello函数执行完成之后，会将结果封装在这个对象中，我们可以通过调用get()方法来获取异步函数的结果。

示例2：异步任务

接下来我们再来看一个异步任务的示例：

定义异步任务：

@Component
public class TestTask {

    @Async("asyncExecutor")
    public void clearCache() {
        System.out.println("Clearing cache...");
        try {
            Thread.sleep(5000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("Cache cleared.");
    }
}

定义控制器：

@RestController
public class TestController {

    @Autowired
    TestTask testTask;

    @GetMapping("/clearCache")
    public String clearCache() {
        testTask.clearCache();
        return "Clearing cache started.";
    }
}

在这个示例中，我们定义了一个异步任务clearCache，这个任务也什么都没做，只是将当前线程休眠了5000毫秒然后输出一些信息。在控制器中我们直接调用了clearCache方法，这个方法不会返回任何结果，只是在后台线程中执行异步任务。

总结

在本文中，我们先介绍了Spring Boot异步框架的两个主要部分：异步调用和异步任务。然后通过示例讲解了如何配置和使用Spring Boot异步框架。当然，这只是一个简单的介绍，实际上Spring Boot提供的异步框架还有很多强大的功能，比如定时任务等，读者可以根据自己的需求进行进一步的学习和调整。