目录
本文带你快速了解@async注解的用法，包括异步方法无返回值、有返回值，最后总结了@async注解失效的几个坑。
在 springboot 应用中，经常会遇到在一个接口中，同时做事情1，事情2，事情3，如果同步执行的话，则本次接口时间取决于事情1 2 3执行时间之和；如果三件事同时执行，则本次接口时间取决于事情1 2 3执行时间最长的那个，合理使用多线程，可以大大缩短接口时间。那么在 springboot 应用中如何优雅的使用多线程呢？
don't bb, show me code.
快速使用
springboot应用中需要添加@enableasync注解，来开启异步调用，一般还会配置一个线程池，异步的方法交给特定的线程池完成，如下：
@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;
}
}
使用的方式非常简单，在需要异步的方法上加@async注解
@restcontroller
public class asynccontroller {
@autowired
private asyncservice asyncservice;
@getmapping("/open/something")
public string something() {
int count = 10;
for (int i = 0; i < count; i ) {
asyncservice.dosomething("index = " i);
}
return "success";
}
}
@slf4j
@service
public class asyncservice {
// 指定使用beanname为dosomethingexecutor的线程池
@async("dosomethingexecutor")
public string dosomething(string message) {
log.info("do something, message={}", message);
try {
thread.sleep(1000);
} catch (interruptedexception e) {
log.error("do something error: ", e);
}
return message;
}
}
访问：127.0.0.1:8080/open/something，日志如下
2023-02-06 23:42:42.486 info 21168 --- [io-8200-exec-17] x.g.b.system.controller.asynccontroller : do something end, time 8 milliseconds
2023-02-06 23:42:42.488 info 21168 --- [ do-something-1] x.gits.boot.system.service.asyncservice : do something, message=index = 0
2023-02-06 23:42:42.488 info 21168 --- [ do-something-5] x.gits.boot.system.service.asyncservice : do something, message=index = 4
2023-02-06 23:42:42.488 info 21168 --- [ do-something-4] x.gits.boot.system.service.asyncservice : do something, message=index = 3
2023-02-06 23:42:42.488 info 21168 --- [ do-something-6] x.gits.boot.system.service.asyncservice : do something, message=index = 5
2023-02-06 23:42:42.488 info 21168 --- [ do-something-9] x.gits.boot.system.service.asyncservice : do something, message=index = 8
2023-02-06 23:42:42.488 info 21168 --- [ do-something-8] x.gits.boot.system.service.asyncservice : do something, message=index = 7
2023-02-06 23:42:42.488 info 21168 --- [do-something-10] x.gits.boot.system.service.asyncservice : do something, message=index = 9
2023-02-06 23:42:42.488 info 21168 --- [ do-something-7] x.gits.boot.system.service.asyncservice : do something, message=index = 6
2023-02-06 23:42:42.488 info 21168 --- [ do-something-2] x.gits.boot.system.service.asyncservice : do something, message=index = 1
2023-02-06 23:42:42.488 info 21168 --- [ do-something-3] x.gits.boot.system.service.asyncservice : do something, message=index = 2
由此可见已经达到异步执行的效果了，并且使用到了咱们配置的线程池。
获取异步方法返回值
当异步方法有返回值时，如何获取异步方法执行的返回结果呢？这时需要异步调用的方法带有返回值completablefuture。
completablefuture是对feature的增强，feature只能处理简单的异步任务，而completablefuture可以将多个异步任务进行复杂的组合。如下：
@restcontroller
public class asynccontroller {
@autowired
private asyncservice asyncservice;
@sneakythrows
@apioperation("异步 有返回值")
@getmapping("/open/somethings")
public string somethings() {
completablefuture createorder = asyncservice.dosomething1("create order");
completablefuture reduceaccount = asyncservice.dosomething2("reduce account");
completablefuture savelog = asyncservice.dosomething3("save log");
// 等待所有任务都执行完
completablefuture.allof(createorder, reduceaccount, savelog).join();
// 获取每个任务的返回结果
string result = createorder.get() reduceaccount.get() savelog.get();
return result;
}
}
@slf4j
@service
public class asyncservice {
@async("dosomethingexecutor")
public completablefuture dosomething1(string message) throws interruptedexception {
log.info("do something1: {}", message);
thread.sleep(1000);
return completablefuture.completedfuture("do something1: " message);
}
@async("dosomethingexecutor")
public completablefuture dosomething2(string message) throws interruptedexception {
log.info("do something2: {}", message);
thread.sleep(1000);
return completablefuture.completedfuture("; do something2: " message);
}
@async("dosomethingexecutor")
public completablefuture dosomething3(string message) throws interruptedexception {
log.info("do something3: {}", message);
thread.sleep(1000);
return completablefuture.completedfuture("; do something3: " message);
}
}
访问接口
c:\users\administrator>curl -x get "http://localhost:8080/open/something" -h "accept: */*"
do something1: create order;
do something2: reduce account;
do something3: save log
控制台上关键日志如下：
2023-02-06 00:27:42.238 info 5672 --- [ do-something-3] x.gits.boot.system.service.asyncservice : do something3: save log
2023-02-06 00:27:42.238 info 5672 --- [ do-something-2] x.gits.boot.system.service.asyncservice : do something2: reduce account
2023-02-06 00:27:42.238 info 5672 --- [ do-something-1] x.gits.boot.system.service.asyncservice : do something1: create order
注意事项
@async注解会在以下几个场景失效，也就是说明明使用了@async注解，但就没有走多线程。
- 异步方法使用static关键词修饰；
- 异步类不是一个spring容器的bean（一般使用注解@component和@service，并且能被spring扫描到）；
- springboot应用中没有添加@enableasync注解；
- 在同一个类中，一个方法调用另外一个有@async注解的方法，注解不会生效。原因是@async注解的方法，是在代理类中执行的。
需要注意的是： 异步方法使用注解@async的返回值只能为void或者future及其子类，当返回结果为其他类型时，方法还是会异步执行，但是返回值都是null，部分源码如下：
asyncexecutioninterceptor#invoke
通过上边几个示例，@async实际还是通过future或completablefuture来异步执行的，spring又封装了一下，让我们使用的更方便。
以上就是详解在springboot如何优雅的使用多线程的详细内容，更多关于springboot多线程的资料请关注其它相关文章！
