SpringBoot 教程之处理异步请求——@EnableAsync@Async

异步

同步就是整个处理过程顺序执行，当各个过程都执行完毕，并返回结果。
异步调用则是只是发送了调用的指令，调用者无需等待被调用的方法完全执行完毕；而是继续执行下面的流程。

例如， 在某个调用中，需要顺序调用 A, B, C三个过程方法；如他们都是同步调用，则需要将他们都顺序执行完毕之后，方算作过程执行完毕； 如B为一个异步的调用方法，则在执行完A之后，调用B，并不等待B完成，而是执行开始调用C，待C执行完毕之后，就意味着这个过程执行完毕了。

@EnableAsync 注解

要使用 @Async，首先需要使用 @EnableAsync 注解开启 Spring Boot 中的异步特性。
同步方法调用的时候必须是按照顺序执行的，上一行代码执行完，才会执行下一行。而异步方法调用是相当于多个线程执行，不需要等待上一行代码的执行结果。

一、@Async异步+多线程

1、在启动类加上@EnableAsync（不一定是启动类，可以是controller、service等启动时加载）

package com.example.worktest.async;

@SpringBootApplication
@EnableAsync
public class AsyncApplication {

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

}

整体目录结构：

controller代码：

package com.example.worktest.async.async_service.controller;

@RestController
@RequestMapping("/v1")
public class HelloController {

    @Autowired
    private HelloService helloService;

    /**
     * 异步方法
     */
    @RequestMapping(value = "/asyn", method = {RequestMethod.GET})
    public String getAsynHello(){
        long n = Instant.now().toEpochMilli();
        String s = helloService.asynchSayHello();
        long f = Instant.now().toEpochMilli();
        return s + " 时间: " + (f-n);

    }

    /**
     * 同步方法
     */
    @GetMapping("/sync")
    public String getSyncHello(){
        long n = Instant.now().toEpochMilli();
        String s = helloService.synchSayHello();
        long f = Instant.now().toEpochMilli();
        return s + " 时间: " + (f-n);
    }
}

HelloServiceImpl、SleepServiceImpl两个实现类代码：

package com.example.worktest.async.async_service.service;

@Service
public class HelloServiceImpl implements HelloService {

    @Autowired
    private SleepService sleepService;
    
    /**
      * @description 异步
     */
    @Override
    public String asynchSayHello() {
        try {
            System.out.println("主线程 "+Thread.currentThread().getName());
            sleepService.asyncSleep();
            return "hello world,这是异步方法";
        } catch (InterruptedException e) {
            e.printStackTrace();
            return "error";
        }
    }
    
    /**
      * @description 同步
     */
    @Override
    public String synchSayHello() {
        try {
            System.out.println("主线程 "+Thread.currentThread().getName());
            sleepService.syncSleep();
            return "hello world,这是同步方法";
        } catch (InterruptedException e) {
            e.printStackTrace();
            return "error";
        }
    }

}

package com.example.worktest.async.async_service.service;

@Service
public class SleepServiceImpl implements SleepService  {

    @Override
    public void syncSleep() throws InterruptedException {
        System.out.println("次线程 " +Thread.currentThread().getName());
        System.out.println("开始同步休眠3秒");
        Thread.sleep(3000);
        System.out.println("同步休眠结束");
    }

    @Override
    @Async
    public void asyncSleep() throws InterruptedException {
        System.out.println("次线程 "+Thread.currentThread().getName());

        System.out.println("开始异步休眠3秒");
        Thread.sleep(3000);
        System.out.println("异步休眠休眠结束");
    }

}

调用异步方法的结果

可以看出使用@Async注解的方法是异步进行的

调用同步方法的结果

可以看出同步方法的两者是同一线程。
同时，异步调用时间远远少于同步调用耗费的时间

注意

1、调用被@Async标记的方法的调用者不能和被调用的方法在同一类中不然不会起作用！！
如下图：

原因：

原因：spring对@Transactional注解时也有类似问题，spring扫描时具有@Transactional注解方法的类时，是生成一个代理类，由代理类去开启关闭事务，而在同一个类中，方法调用是在类体内执行的，spring无法截获这个方法调用。
即，它绕过了代理并直接调用了底层方法

2、注释的方法必须为public
3、不能用在静态方法static

二、@Async异步+线程池的两种方式

1、实现AsyncConfigurer接口

接口源码如下：

package org.springframework.scheduling.annotation;

import java.util.concurrent.Executor;
import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler;
import org.springframework.lang.Nullable;

public interface AsyncConfigurer {
    @Nullable
    default Executor getAsyncExecutor() {
        return null;
    }

    @Nullable
    default AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return null;
    }
}

实现AsyncConfigurer接口，重写里面的两个方法：

package com.example.worktest.async.async_threadpool.config;

@Configuration
@EnableAsync
public class AsyncConfiguration implements AsyncConfigurer {

    @Override
    public Executor getAsyncExecutor(){
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        //核心线程池数量，方法: 返回可用处理器的Java虚拟机的数量。
        executor.setCorePoolSize(Runtime.getRuntime().availableProcessors());
        //最大线程数量
        executor.setMaxPoolSize(Runtime.getRuntime().availableProcessors()*5);
        //线程池的队列容量
        executor.setQueueCapacity(Runtime.getRuntime().availableProcessors()*2);
        //线程名称的前缀
        executor.setThreadNamePrefix("this-excutor-");
        // setRejectedExecutionHandler：当pool已经达到max size的时候，如何处理新任务
        // CallerRunsPolicy：不在新线程中执行任务，而是由调用者所在的线程来执行
        //executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        executor.initialize();
        return executor;
    }
    /*异步任务中异常处理*/
    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return new SimpleAsyncUncaughtExceptionHandler();
    }
}

整体代码结构：

controller入口类：

package com.example.worktest.async.async_threadpool.controller;

@RestController
public class controller {
    @Autowired
    private AsyncService asyncService;

    @GetMapping("/open/something")
    public String something() {
        int count = 20;
        for (int i = 0; i < count; i++) {
            asyncService.doSomething("index = " + i);
        }
        return "success";
    }

}

实现类：

@Slf4j
@Service
public class AsyncService {
    @Async
    public String doSomething(String message) {
        System.out.println(Thread.currentThread().getName()+", message={}"+ message);
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            log.error("do something error: ", e);
        }
        return message;
    }
}

执行结果：

2、@Async自定义线程池

@Async("doSomethingExecutor")   //在这里指定线程池

自定义config，在里面定义线程池：

@Configuration
@EnableAsync
public class AsyncConfiguration{

    @Bean("doSomethingExecutor")
    public Executor doSomethingExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        // 核心线程数：线程池创建时候初始化的线程数
        executor.setCorePoolSize(10);
        // 最大线程数：线程池最大的线程数，只有在缓冲队列满了之后才会申请超过核心线程数的线程
        executor.setMaxPoolSize(20);
        // 缓冲队列：用来缓冲执行任务的队列
        executor.setQueueCapacity(500);
        // 允许线程的空闲时间60秒：当超过了核心线程之外的线程在空闲时间到达之后会被销毁
        executor.setKeepAliveSeconds(60);
        // 线程池名的前缀：设置好了之后可以方便我们定位处理任务所在的线程池
        executor.setThreadNamePrefix("do-something-");  //~~~~~~~~~~
        // 缓冲队列满了之后的拒绝策略：由调用线程处理（一般是主线程）
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.DiscardPolicy());
        executor.initialize();
        return executor;
    }

@Slf4j
@Service
public class AsyncService {

    // 指定使用beanname为doSomethingExecutor的线程池
    @Async("doSomethingExecutor")
    public String doSomething(String message) {
        System.out.println(Thread.currentThread().getName()+", message={}"+ message);
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            log.error("do something error: ", e);
        }
        return message;
    }
}

执行结果：