@Async注解标注private方法时遇到的坑

Posted 2023-05-14 The Archer

在Spring中，如果想要异步调用一个方法，可以使用@Async注解，代码如下所示：

@Component
public class JustBean 
    @Async
    public void doAsync() 
        System.out.print("doAsync() in ");
        System.out.println(Thread.currentThread().getName());
    


public class Main 
    public static ApplicationContext applicationContext;
    static 
        applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
    
    public static void main(String[] args) 
        JustBean bean = applicationContext.getBean(JustBean.class);
        System.out.println(Thread.currentThread().getName());
        bean.doAsync();
    

执行main方法，输出如下所示，可以看到main和doAsync()在不同的线程中执行。

// 输出：
main
doAsync() in pool-1-thread-1

这里在main中获取了JustBean的代理对象，调用的是代理对象上的doAsync()方法。

而如果想在一个JustBean的方法中，异步调用同一个类下的另一个方法，像下面这种方式直接调用，是行不通的：

@Component
public class JustBean 
    public void invokeDoAsync() 
        System.out.print("invokeDoAsync() in ");
        System.out.println(Thread.currentThread().getName());
        doAsync(); // 调用被代理对象本身的方法，未经过AOP
    
    @Async
    public void doAsync() 
        System.out.print("doAsync() in ");
        System.out.println(Thread.currentThread().getName());
    


public class Main 
    //...
    public static void main(String[] args) 
        JustBean bean = applicationContext.getBean(JustBean.class);
        System.out.println(Thread.currentThread().getName());
        bean.invokeDoAsync();
    

// 输出：
main
invokeDoAsync() in main
doAsync() in main

可以看到三个方法都在main线程中执行。因为这里invokeDoAsync()对doSync()的调用并没有通过代理对象，从而没有执行切面的逻辑。

使用@Transactional时，也应注意不要像这样调用到被代理对象本身的方法。

我们可以使用ApplicationContext.getBean()方法得到代理对象，然后再对其进行调用，即可达到预期效果：

@Component
public class JustBean 
    public void invokeDoAsync() 
        System.out.print("invokeDoAsync() in ");
        System.out.println(Thread.currentThread().getName());
        Main.applicationContext.getBean(JustBean.class).doAsync(); // 获取代理对象并调用其方法
    
    @Async
    public void doAsync() 
        System.out.print("doAsync() in ");
        System.out.println(Thread.currentThread().getName());
    

// 输出：
main
invokeDoAsync() in main
doAsync() in pool-1-thread-1

事情看起来到这就结束了，但这里还有一个小坑：

首先，这里我们的JustBean类没有实现接口，Spring会使用CGLib为其创建一个子类作为代理对象。

代理对象中会持有被代理对象的引用，并且重写方法，其中会执行一些切面的逻辑，并且调用被代理对象自身的方法。

上面的代码中，doAsync()方法是public的，调用时，先执行代理对象中生成的切面逻辑，然后调用被代理对象的doAsync()，这不会有什么问题。

而对于private方法，由于子类无法访问，也就无法进行代理。

通过这里的方法，找到了生成的代理类字节码，发现里面也没有对父类的private字段与方法进行覆盖。

然而，在Java编译器的视角，代理类就是其父类的一个对象，通过静态绑定，可以访问private方法，如下所示：

public void invokeDoAsync() 
      System.out.print("invokeDoAsync() in ");
      System.out.println(Thread.currentThread().getName());
      Main.applicationContext.getBean(JustBean.class).doAsync(); // 代理类中没有这个方法，但依然能调用
  

@Async
private void doAsync() 
      System.out.print("doAsync() in ");
      System.out.println(Thread.currentThread().getName());

// 输出：
main
invokeDoAsync() in main
doAsync() in main

父类的方法就是原始方法，所以这里异步逻辑也不生效。

可以推断，这里doAsync()中的this对象是代理类对象，而在public版本中是被代理对象。

这里就会有个问题，代理类在private方法中对字段的访问全部为null，因为代理类中根本没有这些字段：

@Component
public class JustBean 
    @Autowired
    private JustAnotherBean justAnotherBean;

    public void invokeDoAsync() 
        System.out.println("被代理对象的this: " + System.identityHashCode(this));
        System.out.println("被代理对象的this.justAnotherBean: " + this.justAnotherBean);
        System.out.print("invokeDoAsync() in ");
        System.out.println(Thread.currentThread().getName());
        Main.applicationContext.getBean(JustBean.class).doAsync();
    
    @Async
    private void doAsync() 
        System.out.println("代理对象的this: " + System.identityHashCode(this));
        System.out.println("代理对象的this.justAnotherBean: " + this.justAnotherBean); // null
        System.out.print("doAsync() in ");
        System.out.println(Thread.currentThread().getName());
    

// 输出：
main
被代理对象的this: 2114684409
被代理对象的this.justAnotherBean: com.async.JustAnotherBean@63355449
invokeDoAsync() in main
代理对象的this: 154482552
代理对象的this.justAnotherBean: null
doAsync() in main

注意：代理类重写了toString()，如果直接输出this，会发现代理对象和被代理对象输出的结果相同，所以这里使用System.identityHashCode()进行区分。

综上，不要使用@Async修饰private方法，首先异步会失效，其次会有访问字段为null，从而NPE的风险。

Spring使用@Async注解,多线程

@Async注解的原理及使用

    本文讲述@Async注解，在Spring体系中的应用。本文仅说明@Async注解的应用规则，对于原理，调用逻辑，源码分析，暂不介绍。对于异步方法调用，从Spring3开始提供了@Async注解，该注解可以被标注在方法上，以便异步地调用该方法。调用者将在调用时立即返回，方法的实际执行将提交给Spring TaskExecutor的任务中，由指定的线程池中的线程执行。

    在项目应用中，@Async调用线程池，推荐使用自定义线程池的模式。自定义线程池常用方案：重新实现接口AsyncConfigurer。

简介

应用场景    

   同步：同步就是整个处理过程顺序执行，当各个过程都执行完毕，并返回结果。

   异步： 异步调用则是只是发送了调用的指令，调用者无需等待被调用的方法完全执行完毕；而是继续执行下面的流程。例如， 在某个调用中，需要顺序调用 A, B, C三个过程方法；如他们都是同步调用，则需要将他们都顺序执行完毕之后，方算作过程执行完毕； 如B为一个异步的调用方法，则在执行完A之后，调用B，并不等待B完成，而是执行开始调用C，待C执行完毕之后，就意味着这个过程执行完毕了。在Java中，一般在处理类似的场景之时，都是基于创建独立的线程去完成相应的异步调用逻辑，通过主线程和不同的业务子线程之间的执行流程，从而在启动独立的线程之后，主线程继续执行而不会产生停滞等待的情况。

Spring 已经实现的线程池

1. SimpleAsyncTaskExecutor：不是真的线程池，这个类不重用线程，默认每次调用都会创建一个新的线程。
2. SyncTaskExecutor：这个类没有实现异步调用，只是一个同步操作。只适用于不需要多线程的地方。
3. ConcurrentTaskExecutor：Executor的适配类，不推荐使用。如果ThreadPoolTaskExecutor不满足要求时，才用考虑使用这个类。
4. SimpleThreadPoolTaskExecutor：是Quartz的SimpleThreadPool的类。线程池同时被quartz和非quartz使用，才需要使用此类。
5. ThreadPoolTaskExecutor ：最常使用，推荐。 其实质是对java.util.concurrent.ThreadPoolExecutor的包装。

异步的方法有：

1. 最简单的异步调用，返回值为void
2. 带参数的异步调用，异步方法可以传入参数
3. 存在返回值，常调用返回Future

@Async应用默认线程池

    Spring应用默认的线程池，指在@Async注解在使用时，不指定线程池的名称。查看源码，@Async的默认线程池为SimpleAsyncTaskExecutor。

• 无返回值调用   

    基于@Async无返回值调用，直接在使用类，使用方法（建议在使用方法）上，加上注解。若需要抛出异常，需手动new一个异常抛出。

 1  /**
 2      * 带参数的异步调用 异步方法可以传入参数
 3      *  对于返回值是void，异常会被AsyncUncaughtExceptionHandler处理掉
 4      * @param s
 5      */
 6     @Async
 7     public void asyncInvokeWithException(String s) {
 8         log.info("asyncInvokeWithParameter, parementer={}", s);
 9         throw new IllegalArgumentException(s);
10     }

• 有返回值Future调用

 1  /**
 2      * 异常调用返回Future
 3      *  对于返回值是Future，不会被AsyncUncaughtExceptionHandler处理，需要我们在方法中捕获异常并处理
 4      *  或者在调用方在调用Futrue.get时捕获异常进行处理
 5      * 
 6      * @param i
 7      * @return
 8      */
 9     @Async
10     public Future<String> asyncInvokeReturnFuture(int i) {
11         log.info("asyncInvokeReturnFuture, parementer={}", i);
12         Future<String> future;
13         try {
14             Thread.sleep(1000 * 1);
15             future = new AsyncResult<String>("success:" + i);
16             throw new IllegalArgumentException("a");
17         } catch (InterruptedException e) {
18             future = new AsyncResult<String>("error");
19         } catch(IllegalArgumentException e){
20             future = new AsyncResult<String>("error-IllegalArgumentException");
21         }
22         return future;
23     }

• 有返回值CompletableFuture调用

     CompletableFuture 并不使用@Async注解，可达到调用系统线程池处理业务的功能。

    JDK5新增了Future接口，用于描述一个异步计算的结果。虽然 Future 以及相关使用方法提供了异步执行任务的能力，但是对于结果的获取却是很不方便，只能通过阻塞或者轮询的方式得到任务的结果。阻塞的方式显然和我们的异步编程的初衷相违背，轮询的方式又会耗费无谓的 CPU 资源，而且也不能及时地得到计算结果。

• CompletionStage代表异步计算过程中的某一个阶段，一个阶段完成以后可能会触发另外一个阶段

• 一个阶段的计算执行可以是一个Function，Consumer或者Runnable。比如：stage.thenApply(x -> square(x)).thenAccept(x -> System.out.print(x)).thenRun(() -> System.out.println())

• 一个阶段的执行可能是被单个阶段的完成触发，也可能是由多个阶段一起触发

    在Java8中，CompletableFuture提供了非常强大的Future的扩展功能，可以帮助我们简化异步编程的复杂性，并且提供了函数式编程的能力，可以通过回调的方式处理计算结果，也提供了转换和组合 CompletableFuture 的方法。

• 它可能代表一个明确完成的Future，也有可能代表一个完成阶段（ CompletionStage ），它支持在计算完成以后触发一些函数或执行某些动作。
• 它实现了Future和CompletionStage接口

 1  /**
 2      * 数据查询线程池
 3      */
 4     private static final ThreadPoolExecutor SELECT_POOL_EXECUTOR = new ThreadPoolExecutor(10, 20, 5000,
 5             TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(1024), new ThreadFactoryBuilder().setNameFormat("selectThreadPoolExecutor-%d").build());
 6 
 7 // tradeMapper.countTradeLog(tradeSearchBean)方法表示，获取数量，返回值为int
 8  // 获取总条数
 9         CompletableFuture<Integer> countFuture = CompletableFuture
10                 .supplyAsync(() -> tradeMapper.countTradeLog(tradeSearchBean), SELECT_POOL_EXECUTOR);
11 // 同步阻塞
12     CompletableFuture.allOf(countFuture).join();
13 // 获取结果
14  int count = countFuture.get();       

• 默认线程池的弊端

    在线程池应用中，参考阿里巴巴java开发规范：线程池不允许使用Executors去创建，不允许使用系统默认的线程池，推荐通过ThreadPoolExecutor的方式，这样的处理方式让开发的工程师更加明确线程池的运行规则，规避资源耗尽的风险。Executors各个方法的弊端：

• newFixedThreadPool和newSingleThreadExecutor：主要问题是堆积的请求处理队列可能会耗费非常大的内存，甚至OOM。
• newCachedThreadPool和newScheduledThreadPool：要问题是线程数最大数是Integer.MAX_VALUE，可能会创建数量非常多的线程，甚至OOM。

    @Async默认异步配置使用的是SimpleAsyncTaskExecutor，该线程池默认来一个任务创建一个线程，若系统中不断的创建线程，最终会导致系统占用内存过高，引发OutOfMemoryError错误。针对线程创建问题，SimpleAsyncTaskExecutor提供了限流机制，通过concurrencyLimit属性来控制开关，当concurrencyLimit>=0时开启限流机制，默认关闭限流机制即concurrencyLimit=-1，当关闭情况下，会不断创建新的线程来处理任务。基于默认配置，SimpleAsyncTaskExecutor并不是严格意义的线程池，达不到线程复用的功能。

 @Async应用自定义线程池

    自定义线程池，可对系统中线程池更加细粒度的控制，方便调整线程池大小配置，线程执行异常控制和处理。在设置系统自定义线程池代替默认线程池时，虽可通过多种模式设置，但替换默认线程池最终产生的线程池有且只能设置一个（不能设置多个类继承AsyncConfigurer）。自定义线程池有如下模式：

• 重新实现接口AsyncConfigurer
• 继承AsyncConfigurerSupport
• 配置由自定义的TaskExecutor替代内置的任务执行器

   通过查看Spring源码关于@Async的默认调用规则，会优先查询源码中实现AsyncConfigurer这个接口的类，实现这个接口的类为AsyncConfigurerSupport。但默认配置的线程池和异步处理方法均为空，所以，无论是继承或者重新实现接口，都需指定一个线程池。且重新实现 public Executor getAsyncExecutor()方法。

•  实现接口AsyncConfigurer

 1 @Configuration
 2 public class AsyncConfiguration implements AsyncConfigurer {
 3     @Bean("kingAsyncExecutor")
 4     public ThreadPoolTaskExecutor executor() {
 5         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
 6         int corePoolSize = 10;
 7         executor.setCorePoolSize(corePoolSize);
 8         int maxPoolSize = 50;
 9         executor.setMaxPoolSize(maxPoolSize);
10         int queueCapacity = 10;
11         executor.setQueueCapacity(queueCapacity);
12         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
13         String threadNamePrefix = "kingDeeAsyncExecutor-";
14         executor.setThreadNamePrefix(threadNamePrefix);
15         executor.setWaitForTasksToCompleteOnShutdown(true);
16         // 使用自定义的跨线程的请求级别线程工厂类
17         RequestContextThreadFactory threadFactory = RequestContextThreadFactory.getDefault();
18         executor.setThreadFactory(threadFactory);
19         int awaitTerminationSeconds = 5;
20         executor.setAwaitTerminationSeconds(awaitTerminationSeconds);
21         executor.initialize();
22         return executor;
23     }
24 
25     @Override
26     public Executor getAsyncExecutor() {
27         return executor();
28     }
29 
30     @Override
31     public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
32         return (ex, method, params) -> ErrorLogger.getInstance().log(String.format("执行异步任务\'%s\'", method), ex);
33     }
34 }

•  继承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);
}
} 

• 配置自定义的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）

 TaskExecutor.class:ThreadPoolTaskExecutor->SchedulingTaskExecutor->AsyncTaskExecutor->TaskExecutor（这样的模式，最终底层为TaskExecutor.class，在替换默认的线程池时，可不指定线程池名称。）

 1 @EnableAsync
 2 @Configuration
 3 public class TaskPoolConfig {
 4     @Bean(name = AsyncExecutionAspectSupport.DEFAULT_TASK_EXECUTOR_BEAN_NAME)
 5     public Executor taskExecutor() {
 6         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
 7          //核心线程池大小
 8         executor.setCorePoolSize(10);
 9         //最大线程数
10         executor.setMaxPoolSize(20);
11         //队列容量
12         executor.setQueueCapacity(200);
13         //活跃时间
14         executor.setKeepAliveSeconds(60);
15         //线程名字前缀
16         executor.setThreadNamePrefix("taskExecutor-");
17         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
18         return executor;
19     }

      @Bean(name = "new_task")
 5     public Executor taskExecutor() {
 6         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
 7          //核心线程池大小
 8         executor.setCorePoolSize(10);
 9         //最大线程数
10         executor.setMaxPoolSize(20);
11         //队列容量
12         executor.setQueueCapacity(200);
13         //活跃时间
14         executor.setKeepAliveSeconds(60);
15         //线程名字前缀
16         executor.setThreadNamePrefix("taskExecutor-");
17         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
18         return executor;
19     }

20 }

• 多个线程池

   @Async注解，使用系统默认或者自定义的线程池（代替默认线程池）。可在项目中设置多个线程池，在异步调用时，指明需要调用的线程池名称，如@Async("new_task")。

@Async部分重要源码解析

源码-获取线程池方法

 源码-设置默认线程池defaultExecutor，默认是空的，当重新实现接口AsyncConfigurer的getAsyncExecutor()时，可以设置默认的线程池。

源码-寻找系统默认线程池

源码-都没有找到项目中设置的默认线程池时，采用spring 默认的线程池

 

上面文章摘自https://www.cnblogs.com/wlandwl/p/async.html