一文搞懂SpringBoot如何利用@Async实现异步调用

2022-11-13 16:11:19 调用利用一文

前言

异步调用几乎是处理高并发，解决性能问题常用的手段，如何开启异步调用？SpringBoot中提供了非常简单的方式，就是一个注解@Async。今天我们重新认识一下@Async,以及注意事项

简单使用

新建三个作业任务：

@Service
public class TaskDemo {
    private static Logger logger = LoggerFactory.getLogger(TaskDemo.class);
    public void execute1() {
        logger.info("处理耗时任务1......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务1......结束");
    }
    public void execute2() {
        logger.info("处理耗时任务2......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务2......结束");
    }
    public void execute3() {
        logger.info("处理耗时任务3......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务3......结束");
    }
}

测试代码：

@RestController
public class TaskController {
    @Autowired
    private TaskDemo taskDemo;

    @GetMapping("/task/test")
    public String testTask() {
        taskDemo.execute1();
        taskDemo.execute2();
        taskDemo.execute3();
        return "ok";
    }
}

执行后我们可以发现，上面的代码是同一个线程的同步执行，整体耗时9秒才完成。

异步处理

springboot的异步，是非常简单的，加2个注解即可

@Service
public class TaskDemo {

    private static Logger logger = LoggerFactory.getLogger(TaskDemo.class);

    @Async
    public void execute1() {
        logger.info("处理耗时任务1......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务1......结束");
    }

    @Async
    public void execute2() {
        logger.info("处理耗时任务2......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务2......结束");
    }

    @Async
    public void execute3() {
        logger.info("处理耗时任务3......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务3......结束");
    }

}

@SpringBootApplication
@EnableAsync
public class DemoApp {
    public static void main(String[] args) {
        SpringApplication.run(DemoApp.class,args);
    }
}

增加了@Async和@EnableAsync两个注解

从执行结果发现，整个流程用了3秒，以及用了3个线程执行。完成了异步调用

异步回调

有些场景我们需要知道异步处理的任务什么时候完成，需要做额外的业务处理。如：我们需要在3个任务都完成后，提示一下给用户

@Service
public class TaskDemo {

    private static Logger logger = LoggerFactory.getLogger(TaskDemo.class);

    @Async
    public Future<String> execute1() {
        logger.info("处理耗时任务1......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务1......结束");

        return new AsyncResult<>("任务1 ok");
    }

    @Async
    public Future<String> execute2() {
        logger.info("处理耗时任务2......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务2......结束");

        return new AsyncResult<>("任务2 ok");
    }

    @Async
    public Future<String> execute3() {
        logger.info("处理耗时任务3......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务3......结束");

        return new AsyncResult<>("任务3 ok");
    }
}

@RestController
public class TaskController {

    private static Logger logger = LoggerFactory.getLogger(TaskController.class);

    @Autowired
    private TaskDemo taskDemo;

    @GetMapping("/task/test")
    public String testTask() throws InterruptedException {
        Future<String> task1 = taskDemo.execute1();
        Future<String> task2 = taskDemo.execute2();
        Future<String> task3 = taskDemo.execute3();

        while (true){
            if (task1.isDone() && task2.isDone() && task3.isDone()){
                break;
            }
            TimeUnit.SECONDS.sleep(1);
        }

        logger.info(">>>>>>3个任务都处理完成");
        return "ok";
    }
}

执行结果发现，在请求线程里面给用户提示了3个任务都处理完成了。

这段代码主要改变了什么：

1、把具体任务返回类型改为了Future类型对象

2、在调用任务时，循环判断任务是否处理完

自定义线程池

说到异步处理，一定要考虑到线程池，什么是线程池，小伙伴可自行网补。@Async的线程池定义比较方便，直接上代码：

@Configuration
public class ThreadPoolConfig {

    @Bean(name = "taskPool01Executor")
    public ThreadPoolTaskExecutor getTaskPool01Executor() {

        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        //核心线程数
        taskExecutor.setCorePoolSize(10);
        //线程池维护线程的最大数量,只有在缓冲队列满了之后才会申请超过核心线程数的线程
        taskExecutor.setMaxPoolSize(100);
        //缓存队列
        taskExecutor.setQueueCapacity(50);
        //许的空闲时间,当超过了核心线程出之外的线程在空闲时间到达之后会被销毁
        taskExecutor.seTKEepAliveSeconds(200);
        //异步方法内部线程名称
        taskExecutor.setThreadNamePrefix("TaskPool-01-");
        
        taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
        taskExecutor.setWaitForTasksToCompleteOnShutdown(true);

        taskExecutor.initialize();

        return taskExecutor;
    }

    @Bean(name = "taskPool02Executor")
    public ThreadPoolTaskExecutor getTaskPool02Executor() {

        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        //核心线程数
        taskExecutor.setCorePoolSize(10);
        //线程池维护线程的最大数量,只有在缓冲队列满了之后才会申请超过核心线程数的线程
        taskExecutor.setMaxPoolSize(100);
        //缓存队列
        taskExecutor.setQueueCapacity(50);
        //许的空闲时间,当超过了核心线程出之外的线程在空闲时间到达之后会被销毁
        taskExecutor.setKeepAliveSeconds(200);
        //异步方法内部线程名称
        taskExecutor.setThreadNamePrefix("TaskPool-02-");
        
        taskExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
        taskExecutor.setWaitForTasksToCompleteOnShutdown(true);

        taskExecutor.initialize();

        return taskExecutor;
    }

}

定义了2个线程池Bean

@Service
public class TaskDemo {

    private static Logger logger = LoggerFactory.getLogger(TaskDemo.class);

    @Async("taskPool01Executor")
    public Future<String> execute1() {
        logger.info("处理耗时任务1......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务1......结束");

        return new AsyncResult<>("任务1 ok");
    }

    @Async("taskPool01Executor")
    public Future<String> execute2() {
        logger.info("处理耗时任务2......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务2......结束");

        return new AsyncResult<>("任务2 ok");
    }

    @Async("taskPool02Executor")
    public Future<String> execute3() {
        logger.info("处理耗时任务3......开始");
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        logger.info("处理耗时任务3......结束");

        return new AsyncResult<>("任务3 ok");
    }

}

@Async(“线程池名称”)，指定value使用自己定义的线程池：

执行结果利用了线程池。

注意事项（一定注意）

在使用@Async注解时，很多小伙伴都会发现异步使用失败。主要原因是异步方法的定义出了问题。

1、异步方法不能使用static修饰

2、异步类没有使用@Component注解（或其他注解）导致spring无法扫描到异步类

3、异步方法和调用异步方法的方法不能在同一个类

4、类中需要使用@Autowired或@Resource等注解自动注入，不能自己手动new对象

5、如果使用SpringBoot框架必须在启动类中增加@EnableAsync注解

到此这篇关于一文搞懂SpringBoot如何利用@Async实现异步调用的文章就介绍到这了,更多相关SpringBoot @Async异步调用内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

相关文章