深入了解Spring Boot中@Async注解的8大坑点

客官°小女子只卖身不卖艺 2024-04-15 14:02 79阅读 0赞

#### 文章目录 ####

*   *  1. 缺少@EnableAsync注解
     *  2. 异步方法需独立
     *  3. 不同的异步方法间无法相互调用
     *  4. 返回值为void的异步方法无法捕获异常
     *  5. 外部无法直接调用带有@Async注解的方法
     *  6. @Async方法不适用于private方法
     *  7. 缺失异步线程池配置
     *  8. 异步方法与事务的兼容
     *  结语

![在这里插入图片描述][579a429daf314744b995f37351b46548.gif_pic_center]

> ?深入了解Spring Boot中@Async注解的8大坑点
> 
> --------------------
> 
>  *  ☆\* o(≧▽≦)o \*☆嗨~我是IT·陈寒?
>  *  ✨博客主页：[IT·陈寒的博客][IT]
>  *  ?该系列文章专栏：[架构设计][Link 1]
>  *  ?其他专栏：[Java学习路线][Java] [Java面试技巧][Java 1] [Java实战项目][Java 2] [AIGC人工智能][AIGC] [数据结构学习][Link 2]
>  *  ?文章作者技术和水平有限，如果文中出现错误，希望大家能指正?
>  *  ? 欢迎大家关注！ ❤️

--------------------

Spring Boot是一个流行的Java开发框架，提供了丰富的功能和便捷的配置，使得开发者可以更专注于业务逻辑。在异步编程方面，Spring Boot提供了`@Async`注解，它能够让方法异步执行，提高系统的并发性能。然而，在使用`@Async`注解时，有一些潜在的坑需要注意。本文将深入探讨Spring Boot中使用`@Async`注解时可能遇到的8大坑点，并提供相应的解决方案。  
![在这里插入图片描述][f9ecd814f51f474b93b5ba6c182cea74.png_pic_center]

### 1. 缺少@EnableAsync注解 ###

在使用`@Async`注解之前，必须在Spring Boot应用程序的主配置类上添加`@EnableAsync`注解，以启用异步方法的支持。如果忽略了这一步，`@Async`注解将不会生效。

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

### 2. 异步方法需独立 ###

被`@Async`注解修饰的方法不能直接被同一个类中的其他方法调用。因为Spring会在运行时生成一个代理类，调用异步方法时实际上是调用这个代理类的方法。因此，如果在同一个类中直接调用异步方法，`@Async`注解将不会生效。

@Service
    public class YourService {
        
        @Async
        public void asyncMethod() {
        
            // 异步执行的逻辑
        }
    
        public void callingAsyncMethod() {
        
            // 直接调用asyncMethod将无法异步执行
            asyncMethod();
        }
    }

解决方案是通过注入`YourService`的代理对象来调用异步方法。

@Service
    public class YourService {
        
        @Autowired
        private YourService self;
    
        @Async
        public void asyncMethod() {
        
            // 异步执行的逻辑
        }
    
        public void callingAsyncMethod() {
        
            // 通过代理对象调用异步方法
            self.asyncMethod();
        }
    }

### 3. 不同的异步方法间无法相互调用 ###

在同一个类中，一个异步方法调用另一个异步方法，也会出现不会异步执行的问题。这是由于Spring默认使用基于代理的AOP来实现异步方法，代理对象内部的方法调用不会触发AOP拦截。

@Service
    public class YourService {
        
        @Async
        public void asyncMethod1() {
        
            // 异步执行的逻辑
        }
    
        @Async
        public void asyncMethod2() {
        
            // 异步执行的逻辑
            asyncMethod1(); // 这里调用将不会异步执行
        }
    }

解决方案是通过AopContext.currentProxy()获取当前代理对象，再调用异步方法。

@Service
    public class YourService {
        
        @Autowired
        private YourService self;
    
        @Async
        public void asyncMethod1() {
        
            // 异步执行的逻辑
        }
    
        @Async
        public void asyncMethod2() {
        
            // 异步执行的逻辑
            self.asyncMethod1(); // 通过代理对象调用将异步执行
        }
    }

### 4. 返回值为void的异步方法无法捕获异常 ###

如果使用`@Async`注解的异步方法的返回值为`void`，那么这个方法中抛出的异常将无法被捕获。这是因为在异步方法的调用线程和实际执行异步方法的线程之间无法传递异常。

@Service
    public class YourService {
        
        @Async
        public void asyncMethod() {
        
            // 异步执行的逻辑
            throw new RuntimeException("Async method exception");
        }
    }

解决方案是将返回值设置为`Future`，这样就可以在调用`get()`方法时捕获到异常。

@Service
    public class YourService {
        
        @Async
        public Future<Void> asyncMethod() {
        
            // 异步执行的逻辑
            throw new RuntimeException("Async method exception");
        }
    }

在调用异步方法时，可以通过`Future`的`get()`方法捕获到异常。

@Service
    public class YourService {
        
        @Autowired
        private YourService self;
    
        public void callAsyncMethod() {
        
            try {
        
                self.asyncMethod().get();
            } catch (Exception e) {
        
                // 捕获异常
            }
        }
    }

### 5. 外部无法直接调用带有@Async注解的方法 ###

如果在同一个类中直接调用带有`@Async`注解的方法，是无法异步执行的。因为Spring会在运行时生成一个代理类，外部直接调用实际上是调用的原始类的方法，而不是代理类的方法。

@Service
    public class YourService {
        
        @Async
        public void asyncMethod() {
        
            // 异步执行的逻辑
        }
    }
    
    @Service
    public class AnotherService {
        
        @Autowired
        private YourService yourService;
    
        public void callAsyncMethod() {
        
            // 外部直接调用asyncMethod将无法异步执行
            yourService.asyncMethod();
        }
    }

解决方案是通过注入`YourService`的代理对象来调用异步方法。

@Service
    public class YourService {
        
        @Autowired
        private YourService self;
    
        @Async
        public void asyncMethod() {
        
            // 异步执行的逻辑
        }
    }
    
    @Service
    public class AnotherService {
        
        @Autowired
        private YourService self;
    
        public void callAsyncMethod() {
        
            // 通过代理对象调用异步方法
            self.asyncMethod();
        }
    }

### 6. @Async方法不适用于private方法 ###

`@Async`注解只对公有方法有效，因此\`private

`方法无法异步执行。如果尝试给一个`private`方法添加`@Async\`注解，将不会产生任何效果。

@Service
    public class YourService {
        
        @Async
        private void asyncMethod() {
        
            // 这里的@Async注解将不会生效
        }
    }

解决方案是将要异步执行的逻辑抽取到一个公有方法中，并在私有方法中调用这个公有方法。

@Service
    public class YourService {
        
        @Async
        public void asyncMethod() {
        
            doAsyncMethod();
        }
    
        private void doAsyncMethod() {
        
            // 异步执行的逻辑
        }
    }

### 7. 缺失异步线程池配置 ###

在使用`@Async`注解时，Spring Boot默认会创建一个线程池来执行异步方法。如果没有进行配置，默认使用的是`SimpleAsyncTaskExecutor`，这是一个单线程的执行器，可能会导致性能瓶颈。

为了解决这个问题，可以配置一个合适的线程池。以下是一个示例的配置：

@Configuration
    @EnableAsync
    public class AsyncConfig extends AsyncConfigurerSupport {
        
        @Override
        public Executor getAsyncExecutor() {
        
            ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
            executor.setCorePoolSize(5);
            executor.setMaxPoolSize(10);
            executor.setQueueCapacity(25);
            executor.setThreadNamePrefix("Async-");
            executor.initialize();
            return executor;
        }
    }

这个配置使用了`ThreadPoolTaskExecutor`，并设置了核心线程数、最大线程数、队列容量等参数，根据实际情况进行调整。

### 8. 异步方法与事务的兼容 ###

在默认情况下，使用`@Async`注解的方法与事务是不兼容的。因为在使用事务的方法中调用使用`@Async`注解的方法时，事务将无法传播到异步方法中，异步方法将在没有事务的情况下执行。

解决方案是将`@Async`注解添加到另外一个类的方法上，通过代理对象来调用异步方法。

@Service
    public class YourService {
        
        @Autowired
        private AsyncService asyncService;
    
        @Transactional
        public void transactionalMethod() {
        
            // 在事务中调用异步方法
            asyncService.asyncMethod();
        }
    }
    
    @Service
    public class AsyncService {
        
        @Async
        public void asyncMethod() {
        
            // 异步执行的逻辑
        }
    }

通过将异步方法移动到另一个类中，可以确保异步方法在新的事务中执行，与外部事务不会产生冲突。

### 结语 ###

使用`@Async`注解能够提高系统的并发性能，但在使用时需要注意一些潜在的问题。通过深入了解Spring Boot中`@Async`注解的这8大坑点，并采取相应的解决方案，可以更好地应用异步编程，确保系统的可靠性和性能。希望本文对您理解和使用Spring Boot中的异步注解有所帮助。

--------------------

> ?结尾 ❤️ 感谢您的支持和鼓励！ ??  
> ?您可能感兴趣的内容：
> 
>  *  【[Java面试技巧][Java 1]】[Java面试八股文 - 掌握面试必备知识（目录篇）][Java_ -]
>  *  【[Java学习路线][Java]】[2023年完整版Java学习路线图][2023_Java]
>  *  【[AIGC人工智能][AIGC]】[Chat GPT是什么，初学者怎么使用Chat GPT，需要注意些什么][Chat GPT_Chat GPT]
>  *  【[Java实战项目][Java 2]】[SpringBoot+SSM实战：打造高效便捷的企业级Java外卖订购系统][SpringBoot_SSM_Java]
>  *  【[数据结构学习][Link 2]】[从零起步：学习数据结构的完整路径][Link 3]
> 
> > ![在这里插入图片描述][d7565cfc032647bfb69e7971731a06a2.gif_pic_center]

[579a429daf314744b995f37351b46548.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/520160b2ea5347d197c960e3b64aebc7.gif
[IT]: https://blog.csdn.net/qq_43546721?type=blog
[Link 1]: https://blog.csdn.net/qq_43546721/category_12435443.html?spm=1001.2014.3001.5482
[Java]: https://blog.csdn.net/qq_43546721/category_12367981.html
[Java 1]: https://blog.csdn.net/qq_43546721/category_12384780.html?spm=1001.2014.3001.5482
[Java 2]: https://blog.csdn.net/qq_43546721/category_12378614.html?spm=1001.2014.3001.5482
[AIGC]: https://blog.csdn.net/qq_43546721/category_12369819.html?spm=1001.2014.3001.5482
[Link 2]: https://blog.csdn.net/qq_43546721/category_12417284.html?spm=1001.2014.3001.5482
[f9ecd814f51f474b93b5ba6c182cea74.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/2a111b0e7ec2490abdf26a27fe69b701.png
[Java_ -]: https://blog.csdn.net/qq_43546721/article/details/131832856
[2023_Java]: https://blog.csdn.net/qq_43546721/article/details/131550605
[Chat GPT_Chat GPT]: https://blog.csdn.net/qq_43546721/article/details/131866932
[SpringBoot_SSM_Java]: https://blog.csdn.net/qq_43546721/article/details/132119791
[Link 3]: https://blog.csdn.net/qq_43546721/article/details/132404477
[d7565cfc032647bfb69e7971731a06a2.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/481a12e8dcfc48589f8f166d6cbed7eb.gif