Spring boot 注解@Async

從Spring3開始提供了@Async注解，該注解可以被標注在方法上，以便異步地調用該方法。調用者將在調用時立即返回，方法的實際執行將提交給Spring TaskExecutor的任務中，由指定的線程池中的線程執行。

1. TaskExecutor

Spring異步線程池的接口類，其實質是java.util.concurrent.Executor

Spring 已經實現的異常線程池：
1. SimpleAsyncTaskExecutor：不是真的線程池，這個類不重用線程，每次調用都會創建一個新的線程。
2. SyncTaskExecutor：這個類沒有實現異步調用，只是一個同步操作。只適用於不需要多線程的地方
3. ConcurrentTaskExecutor：Executor的適配類，不推薦使用。如果ThreadPoolTaskExecutor不滿足要求時，才用考慮使用這個類
4. SimpleThreadPoolTaskExecutor：是Quartz的SimpleThreadPool的類。線程池同時被quartz和非quartz使用，才需要使用此類
5. ThreadPoolTaskExecutor ：最常使用，推薦。 其實質是對java.util.concurrent.ThreadPoolExecutor的包裝

2. @EnableAsync @Async

(1) springboot的啟動類,@EnableAsync注解開啟異步調用

(2) spring對@Async定義異步任務

異步的方法有3種
1. 最簡單的異步調用，返回值為void， 基於@Async無返回值調用，直接在使用類，使用方法（建議在使用方法）上，加上注解。若需要拋出異常，需手動new一個異常拋出。
2. 帶參數的異步調用 異步方法可以傳入參數
3. 異常調用返回Future，不會被AsyncUncaughtExceptionHandler處理，需要我們在方法中捕獲異常並處理或者在調用方在調用Futrue.get時捕獲異常進行處理

 3. @Async應用默認線程池

spring應用默認的線程池，指在@Async注解在使用時，不指定線程池的名稱。查看源碼，@Async的默認線程池為SimpleAsyncTaskExecutor。

• 默認線程池的弊端

    在線程池應用中，參考阿里巴巴java開發規范：線程池不允許使用Executors去創建，不允許使用系統默認的線程池，推薦通過ThreadPoolExecutor的方式，這樣的處理方式讓開發的工程師更加明確線程池的運行規則，規避資源耗盡的風險。Executors各個方法的弊端：

• newFixedThreadPool和newSingleThreadExecutor：主要問題是堆積的請求處理隊列可能會耗費非常大的內存，甚至OOM。
• newCachedThreadPool和newScheduledThreadPool：要問題是線程數最大數是Integer.MAX_VALUE，可能會創建數量非常多的線程，甚至OOM。

    @Async默認異步配置使用的是SimpleAsyncTaskExecutor，該線程池默認來一個任務創建一個線程，若系統中不斷的創建線程，最終會導致系統占用內存過高，引發OutOfMemoryError錯誤。針對線程創建問題，SimpleAsyncTaskExecutor提供了限流機制，通過concurrencyLimit屬性來控制開關，當concurrencyLimit>=0時開啟限流機制，默認關閉限流機制即concurrencyLimit=-1，當關閉情況下，會不斷創建新的線程來處理任務。基於默認配置，SimpleAsyncTaskExecutor並不是嚴格意義的線程池，達不到線程復用的功能。

4. @Async應用自定義線程池

    自定義線程池，可對系統中線程池更加細粒度的控制，方便調整線程池大小配置，線程執行異常控制和處理。在設置系統自定義線程池代替默認線程池時，雖可通過多種模式設置，但替換默認線程池最終產生的線程池有且只能設置一個（不能設置多個類繼承AsyncConfigurer）。自定義線程池有如下模式：

• 重新實現接口AsyncConfigurer
• 繼承AsyncConfigurerSupport
• 配置由自定義的TaskExecutor替代內置的任務執行器

   通過查看Spring源碼關於@Async的默認調用規則，會優先查詢源碼中實現AsyncConfigurer這個接口的類，實現這個接口的類為AsyncConfigurerSupport。但默認配置的線程池和異步處理方法均為空，所以，無論是繼承或者重新實現接口，都需指定一個線程池。且重新實現 public Executor getAsyncExecutor()方法。

(1)實現接口AsyncConfigurer

@Configuration
public class AsyncConfiguration implements AsyncConfigurer {
    @Bean("kingAsyncExecutor")
    public ThreadPoolTaskExecutor executor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        int corePoolSize = 10;
        executor.setCorePoolSize(corePoolSize);
        int maxPoolSize = 50;
        executor.setMaxPoolSize(maxPoolSize);
        int queueCapacity = 10;
        executor.setQueueCapacity(queueCapacity);
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        String threadNamePrefix = "kingDeeAsyncExecutor-";
        executor.setThreadNamePrefix(threadNamePrefix);
        executor.setWaitForTasksToCompleteOnShutdown(true);
        // 使用自定義的跨線程的請求級別線程工廠類
        RequestContextThreadFactory threadFactory = RequestContextThreadFactory.getDefault();
        executor.setThreadFactory(threadFactory);
        int awaitTerminationSeconds = 5;
        executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
        executor.initialize();
        return executor;
    }

    @Override
    public Executor getAsyncExecutor() {
        return executor();
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("執行異步任務'%s'", method), ex);
    }
}

(2)繼承AsyncConfigurerSupport

@Configuration  
@EnableAsync  
class SpringAsyncConfigurer extends AsyncConfigurerSupport {  
  
    @Bean  
    public ThreadPoolTaskExecutor asyncExecutor() {  
        ThreadPoolTaskExecutor threadPool = new ThreadPoolTaskExecutor();  
        threadPool.setCorePoolSize(3);  
        threadPool.setMaxPoolSize(3);  
        threadPool.setWaitForTasksToCompleteOnShutdown(true);  
        threadPool.setAwaitTerminationSeconds(60 * 15);  
        return threadPool;  
    }  
  
    @Override  
    public Executor getAsyncExecutor() {  
        return asyncExecutor;  
}  

  @Override  
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
    return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("執行異步任務'%s'", method), ex);
}
}

(3)配置自定義的TaskExecutor

由於AsyncConfigurer的默認線程池在源碼中為空，Spring通過beanFactory.getBean(TaskExecutor.class)先查看是否有線程池，未配置時，通過beanFactory.getBean(DEFAULT_TASK_EXECUTOR_BEAN_NAME, Executor.class)，又查詢是否存在默認名稱為TaskExecutor的線程池。所以可在項目中，定義名稱為TaskExecutor的bean生成一個默認線程池。也可不指定線程池的名稱，申明一個線程池，本身底層是基於TaskExecutor.class便可。

比如：

 Executor.class:ThreadPoolExecutorAdapter->ThreadPoolExecutor->AbstractExecutorService->ExecutorService->Executor（這樣的模式，最終底層為Executor.class，在替換默認的線程池時，需設置默認的線程池名稱為TaskExecutor）

 Executor.class:ThreadPoolTaskExecutor->SchedulingTaskExecutor->AsyncTaskExecutor->TaskExecutor（這樣的模式，最終底層為TaskExecutor.class，在替換默認的線程池時，可不指定線程池名稱。）

package intellif.configs;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.aop.interceptor.AsyncUncaughtExceptionHandler;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.scheduling.annotation.AsyncConfigurer;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import org.springframework.stereotype.Component;

import java.util.concurrent.Executor;
import java.util.concurrent.ThreadPoolExecutor;

/**
 * @author liuyu
 * @className TaskConfiguration
 * @date 2019/12/17 11:40
 * @description
 */


@Component
public class TaskConfiguration implements AsyncConfigurer {

    private static Logger logger = LogManager.getLogger(TaskConfiguration.class);

    @Value("${thread.pool.corePoolSize:10}")
    private int corePoolSize;

    @Value("${thread.pool.maxPoolSize:20}")
    private int maxPoolSize;

    @Value("${thread.pool.keepAliveSeconds:4}")
    private int keepAliveSeconds;

    @Value("${thread.pool.queueCapacity:512}")
    private int queueCapacity;

    @Value("${thread.pool.waitForTasksToCompleteOnShutdown:true}")
    private boolean waitForTasksToCompleteOnShutdown;

    @Value("${thread.pool.awaitTerminationSeconds:60}")
    private int awaitTerminationSeconds;


    @Override
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        //核心線程數
        executor.setCorePoolSize(corePoolSize);
        //線程池最大的線程數，只有在緩沖隊列滿了之后，才會申請超過核心線程數的線程
        executor.setMaxPoolSize(maxPoolSize);
        //允許線程的空閑時間,當超過了核心線程之外的線程,在空閑時間到達之后會被銷毀
        executor.setKeepAliveSeconds(keepAliveSeconds);
        ////用來緩沖執行任務的隊列
        executor.setQueueCapacity(queueCapacity);
        //線程池名的前綴,可以用於定位處理任務所在的線程池
        executor.setThreadNamePrefix("taskExecutor-");
        //線程池對拒絕任務的處理策略
        executor.setRejectedExecutionHandler((Runnable r, ThreadPoolExecutor exe) -> {
            logger.warn("當前任務線程池隊列已滿.");
        });
        //該方法用來設置線程池關閉的時候等待所有任務都完成后,再繼續銷毀其他的Bean，這樣這些異步任務的銷毀就會先於數據庫連接池對象的銷毀。
        executor.setWaitForTasksToCompleteOnShutdown(waitForTasksToCompleteOnShutdown);
        //該方法用來設置線程池中,任務的等待時間,如果超過這個時間還沒有銷毀就強制銷毀,以確保應用最后能夠被關閉,而不是阻塞住。
        executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
        executor.initialize();
        return executor;
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return (ex, method, params) -> logger.error("線程池執行任務發生未知異常.", ex);
    }
}

• 多個線程池

   @Async注解，使用系統默認或者自定義的線程池（代替默認線程池）。可在項目中設置多個線程池，在異步調用時，指明需要調用的線程池名稱，如@Async("new_task")。

5. @Async注解失效原因

沒有過去到代理類,本類調用時,直接自己內部調用,沒有走代理類

1.沒有在@SpringBootApplication啟動類當中添加注解@EnableAsync注解。
2.異步方法使用注解@Async的返回值只能為void或者Future。
3.沒有走Spring的代理類。因為@Transactional和@Async注解的實現都是基於Spring的AOP，而AOP的實現是基於動態代理模式實現的。那么注解失效的原因就很明顯了，有可能因為調用方法的是對象本身而不是代理對象，因為沒有經過Spring容器。

解決方法:

這里具體說一下第三種情況的解決方法。
1.注解的方法必須是public方法。
2.方法一定要從另一個類中調用，也就是從類的外部調用，類的內部調用是無效的。
3.如果需要從類的內部調用，需要先獲取其代理類，下面上代碼

@Service
public class AsyncService{
  public void methodA(){
    ...
    AsyncService asyncServiceProxy = SpringUtil.getBean(AsyncService.class);
    asyncServiceProxy .methodB();
    ...
  }
 
  @Async
  public void methodB() {
    ...
  }
}

本類中可以定義實現本類中調用的本類的異步多線程方法；

必須實現的兩種：

• public方法
• 手動獲取spring bean

SpringUtils的工具類，手動獲取bean方法：

package intellif.util;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

/**
 * @author liuyu
 * @className SpringUtils
 * @date 2019/12/16 20:55
 * @description
 */

@Component("springContextUtil")
public class SpringUtils implements ApplicationContextAware {

    private static ApplicationContext applicationContext = null;

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    @SuppressWarnings("unchecked")
    public static <T> T getBean(String beanId) {
        return (T) applicationContext.getBean(beanId);
    }

    public static <T> T getBean(Class<T> requiredType) {
        return (T) applicationContext.getBean(requiredType);
    }
    /**
     * Spring容器啟動后，會把 applicationContext 給自動注入進來，然后我們把 applicationContext
     *  賦值到靜態變量中，方便后續拿到容器對象
     * @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)
     */
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringUtils.applicationContext = applicationContext;
    }
}

 

參考文章:

https://www.cnblogs.com/wlandwl/p/async.html

https://blog.csdn.net/YoungLee16/article/details/88398045