springboot 异步 @Async 的日常使用

本文主要介绍 @Async 在日常开发中的使用和注意点(@Async 注解失效场景)，不做原理的解释说明。

引言

在 java 中很多业务涉及到异步线程，比如在业务流处理时，需要发短信发邮件通知用户，或者需要上传一些文件资源到其他服务器这种耗时的操作。
这种比较耗时的操作如果都在主线程里处理会阻塞整理流程，而且我们也不需要等待处理结果之后再进行下一步操作，这时候就可以使用异步线程进行处理，这样主线程不会因为这些耗时的操作而阻塞，保证主线程的流程可以正常进行。

一、@Async 使用位置

1. 在方法上使用该@Async注解，表明该方法是一个异步任务
2. 在类上面使用该@Async注解，表明该类中的所有方法都是异步任务

二、@Async 使用

在 Springboot 中使用 @Async：

• @Async 注解在使用时，如果不指定线程池的名称，则使用默认的线程池，Spring默认的线程池为 SimpleAsyncTaskExecutor。
• 方法上一旦标记了这个 @Async 注解，当其它线程调用这个方法时，就会开启一个新的子线程去异步处理该业务逻辑。
• 启动类中增加 @EnableAsync 注解

代码示例：

本文不做新配置，全部使用默认的线程池及配置。

（1）创建 AsyncService 写异步方法

import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

@Service
public class AsyncService {

    @Async
    public void Async() throws InterruptedException {
        Thread.sleep(10000);
        System.out.println("程序睡眠结束");

    }

（2）编写业务层 AsyncTestService

package com.ruoyi.system.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

@Service
public class AsyncTestService {
    @Autowired
    private AsyncService asyncService;


    public String testSync() throws InterruptedException {
        System.out.println("开始进入方法");
        System.out.println("进行时");
        System.out.println("正在进行时");
		asyncService.Async();
        return "成功";
    }
}

（3）编写接口 AsyncTestController

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(value = "/async/lost")
public class AsyncTestController {

    @Autowired
    private AsyncTestService asyncTestService;

    @RequestMapping(value = "/test", method = {RequestMethod.POST})
    public String testAsync() throws InterruptedException {
        asyncTestService.testSync();
        System.out.println("调用Controller控制器结束");
        return "成功";
    }
}

postman 测试：

从下图测试结果可知，打印语句 “调用Controller控制器结束” 在 “程序睡眠结束” 之前执行，异步实现成功，没有影响到主线程的任务。

三、注解 @Async 失效的情况

（1）调用同一个类中的异步方法（内部调用）

从上面的 @Async 使用我们看到，添加注解的异步方法在一个单独的类 AsyncService 中，然后注入到 AsyncTestService 中进行调用。如果异步方法和调用的方法在同一个类中，还会正常进行异步调用吗？

AsyncTestService 代码如下：

@Service
public class AsyncTestService {

    public String testSync() throws InterruptedException {
        System.out.println("开始进入方法");
        System.out.println("进行时");
        System.out.println("正在进行时");
        Async();
        return "成功";
    }

    @Async
    public void Async() throws InterruptedException {
        Thread.sleep(10000);
        System.out.println("程序睡眠结束");

    }
}

postman 测试：

如上图所示，打印语句 “调用Controller控制器结束” 在 “程序睡眠结束” 之后执行，说明异步并没有生效，程序还是走了主线程。

这是因为 @Async注解是通过aop代理实现的，需要通过JDK动态代理或者cglib，生成代理对象。异步的功能，是在代理对象中增加的，我们必须调用代理对象的 testSync() 方法才行。而在类中直接进行方法的内部调用，在 testSync() 方法中调用Async()方法，调用的是该类原对象的Async方法，相当于调用了this.Async()方法，而并非AsyncTestService 代理类的 Async() 方法。 因此，像这种内部方法调用，@Async注解的异步功能会失效。

要想在同一个类中调用异步方法，需要使用 ApplicationContext 获得到该类。

AsyncTestService 代码如下：

import org.springframework.aop.support.AopUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;

@Service
public class AsyncTestService {

    @Autowired
    private ApplicationContext applicationContext;


    public String testSync() throws InterruptedException {
        AsyncTestService asyncBean = applicationContext.getBean(AsyncTestService.class);
        System.out.println("当前对象是否是代理对象:" + AopUtils.isAopProxy(asyncBean));
        System.out.println("是否是cglib代理对象:" + AopUtils.isCglibProxy(asyncBean));
        System.out.println("是否是jdk代理对象:" + AopUtils.isJdkDynamicProxy(asyncBean));
        System.out.println(asyncBean == this);
        asyncBean.Async();
        return "成功";
    }

    @Async
    public void Async() throws InterruptedException {
        Thread.sleep(10000);
        System.out.println("程序睡眠结束");

    }
}

postman 测试：

打印控制器语句在前，异步实现成功。

（2）未使用 @EnableAsync 注解

在 Springboot 中要开启@Async注解异步的功能，需要在项目的启动类，或者配置类上，使用@EnableAsync注解。

@EnableAsync注解相当于一个开关，控制是否开启@Async注解异步的功能，默认是关闭的。

@EnableAsync
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
public class Application {

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

（3）注解@Async的方法不是public方法

异步的方法必须是 public修饰的，否则 aop 代理异常，异步失效。

（4）返回值错误

注解 @Async 的返回值只能为 void 或 Future。

（5）方法用static修饰了

使用@Async注解声明的方法，必须是能被重写的，很显然static修饰的方法，是类的静态方法，是不允许被重写的。
因此这种情况下，@Async注解的异步功能会失效。

（6）类中需要使用@Autowired或@Resource等注解自动注入,不能自己手动new对象

（7）方法用final修饰

（8）业务类没加@Service注解

================================

（时间宝贵，分享不易，非常感谢您的捐赠回馈）