Spring Boot 中@Aynsc的用法详解

Spring Boot 中@Aynsc的用法

1. 启用Aynsc

1.1 添加pom依赖

 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
</dependency>

1.2 在启动类添加@EnableAsync注解

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

1.3 在service中使用@Async注解

这里我们用一个用户注册并发送邮件的场景来说明

controller

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    private MailService mailService;

    @GetMapping("/register")
    public String register(){
        try {
            long start = System.currentTimeMillis();
            userService.insert();
            mailService.sendMail();
            log.info("执行时间"+(System.currentTimeMillis()-start));
            return "注册成功";
        } catch (Exception e) {
            e.printStackTrace();
        }
        return "注册失败";
    }
}

UserService

@Service
@Slf4j
public class UserService {

    public void insert(){
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        log.info("添加用户成功");
    }
}

MailService

@Service
@Slf4j
public class MailService {
    
    @Async
    public void sendMail(){
        try {
            Thread.sleep(10000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        log.info("发送邮件成功");
    }
}

正常如果不使用异步调用的方式时,我们的注册流程耗时应该是11000+ms

使用异步以后耗时情况

2018-11-23 09:44:27.462  INFO 2600 --- [nio-8080-exec-1] com.example.async.service.UserService    : 添加用户成功
2018-11-23 09:44:27.470  INFO 2600 --- [nio-8080-exec-1] c.e.async.controller.UserController      : 执行时间1009
2018-11-23 09:44:37.478  INFO 2600 --- [         task-1] com.example.async.service.MailService    : 发送邮件成功

可以看到耗时只有1009ms

2. 带有返回值的异步

这时候注册流程发生了变化,注册的同时要通过外部系统获取用户的信息更新到本地数据库

修改controller

@RestController
@RequestMapping("/user")
@Slf4j
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    private MailService mailService;

    @Autowired
    private OuterService outerService;

    @GetMapping("/register")
    public String register(){
        try {
            long start = System.currentTimeMillis();
            Future<String> userInfoFuture = outerService.getUserInfo();
            userService.insert();
            mailService.sendMail();
            String userInfo = userInfoFuture.get();
            userService.update(userInfo);
            log.info("执行时间"+(System.currentTimeMillis()-start));
            return "注册成功";
        } catch (Exception e) {
            e.printStackTrace();
        }
        return "注册失败";
    }
}

OuterService

@Service
@Slf4j
public class OuterService {

    @Async
    public Future<String> getUserInfo(){
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            log.error("获取用户详情失败",e);
        }
        log.info("获取用户详情成功");
        return new AsyncResult<>("success");
    }
}

执行日志

2018-11-23 10:04:01.353  INFO 9240 --- [nio-8080-exec-2] com.example.async.service.UserService    : 添加用户成功
2018-11-23 10:04:01.356  INFO 9240 --- [         task-1] com.example.async.service.OuterService   : 获取用户详情成功
2018-11-23 10:04:01.358  INFO 9240 --- [nio-8080-exec-2] com.example.async.service.UserService    : 更新用户成功
2018-11-23 10:04:01.358  INFO 9240 --- [nio-8080-exec-2] c.e.async.controller.UserController      : 执行时间1010
2018-11-23 10:04:11.362  INFO 9240 --- [         task-2] com.example.async.service.MailService    : 发送邮件成功

3. 异常处理

3.1 带有返回值的异常处理

当一个@Async方法有一个Future类型的返回值时,在调Future的get()方法获取任务的执行结果时抛出的异常。

修改OuterService

@Service
@Slf4j
public class OuterService {

    @Async
    public Future<String> getUserInfo() throws Exception {
        try {
            Thread.sleep(1000);
            throw new Exception("获取用户详情异常");
        } catch (InterruptedException e) {
            log.error("获取用户详情失败",e);
        }
        log.info("获取用户详情成功");
        return new AsyncResult<>("success");
    }
}

执行结果

2018-11-23 10:49:26.085  INFO 3752 --- [nio-8080-exec-1] com.example.async.service.UserService    : 添加用户成功
2018-11-23 10:49:26.106 ERROR 3752 --- [nio-8080-exec-1] c.e.async.controller.UserController      : java.lang.Exception: 获取用户详情异常
2018-11-23 10:49:36.090  INFO 3752 --- [         task-2] com.example.async.service.MailService    : 发送邮件成功

我们看到添加和发送邮件成功了 在String userInfo = userInfoFuture.get();处抛出了异常

3.2 不带返回值的异常处理

不带返回值的异常无法被调用者捕获,我们可以实现AsyncUncaughtExceptionHandler来处理异常

创建MyAsyncUncaughtExceptionHandler实现AsyncUncaughtExceptionHandler

@Slf4j
public class MyAsyncUncaughtExceptionHandler implements AsyncUncaughtExceptionHandler {

    @Override
    public void handleUncaughtException(Throwable ex, Method method, Object... params) {
        log.error("ex=",ex);
        // doSomething....
    }
}

创建AsyncConfig实现AsyncConfigurer并覆盖AsyncUncaughtExceptionHandler方法

@Configuration
@Slf4j
public class AsyncConfig implements AsyncConfigurer {
   
    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return new MyAsyncUncaughtExceptionHandler();
    }
}

4. 自定义线程池

Spring boot 默认配置的线程池是ThreadPoolTaskExecutor,我们可以通过一些配置来配置线程池

spring.task.execution.pool.core-size=8
spring.task.execution.pool.max-threads=16
spring.task.execution.pool.queue-capacity=100
spring.task.execution.pool.keep-alive=10s

这会将线程池更改为使用有界队列,最小线程数为8,最大线程数为16,队列最大数量为100,当线程空闲10秒(而不是默认情况下的60秒)时回收线程时

如果我们想更清楚的控制线程池,也可以配置我们自己的线程池

修改AsyncConfig

@Configuration
@Slf4j
public class AsyncConfig implements AsyncConfigurer {
    @Override
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(100);
        executor.setQueueCapacity(100);
        executor.setThreadNamePrefix("my-executor-");
        //如果不初始化,导致找到不到执行器
        executor.initialize();
        return executor;
    }
    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return new MyAsyncUncaughtExceptionHandler();
    }
}

这里我们自定义了我们线程池的前缀改成了my-executor-

2018-11-23 16:02:04.797  INFO 15588 --- [nio-8080-exec-2] com.example.async.service.UserService    : 添加用户成功
2018-11-23 16:02:04.800  INFO 15588 --- [  my-executor-1] com.example.async.service.OuterService   : 获取用户详情成功
2018-11-23 16:02:04.800  INFO 15588 --- [nio-8080-exec-2] com.example.async.service.UserService    : 更新用户成功
2018-11-23 16:02:04.800  INFO 15588 --- [nio-8080-exec-2] c.e.async.controller.UserController      : 执行时间1006
2018-11-23 16:02:14.799  INFO 15588 --- [  my-executor-2] com.example.async.service.MailService    : 发送邮件成功

5. 多个线程池

有时候我们想让我们的线程池只做一件事防止多个共用线程池出线抢占溢出情况

我们在AsyncConfig中添加两个线程池mailExecutor和outerExecutor

@Configuration
@Slf4j
public class AsyncConfig implements AsyncConfigurer {


    @Bean
    public Executor mailExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(100);
        executor.setQueueCapacity(100);
        executor.setThreadNamePrefix("mail-executor-");
        executor.initialize();
        return executor;
    }
    @Bean
    public Executor outerExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(10);
        executor.setMaxPoolSize(100);
        executor.setQueueCapacity(100);
        executor.setThreadNamePrefix("out-executor-");
        executor.initialize();
        return executor;
    }
    @Override
    public Executor getAsyncExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(1);
        executor.setMaxPoolSize(2);
        executor.setQueueCapacity(10);
        executor.setThreadNamePrefix("my-executor-");
        //如果不初始化,导致找到不到执行器
        executor.initialize();
        return executor;
    }
    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return new MyAsyncUncaughtExceptionHandler();
    }
}

然后我们service中分别使用这两个线程池

MailService使用mailExecutor

@Service
@Slf4j
public class MailService {

    @Async("mailExecutor")
    public void sendMail() throws Exception {
        try {
            Thread.sleep(10000);
        } catch (InterruptedException e) {
            log.error(e.getMessage());
        }
        log.info("发送邮件成功");
    }
}

OuterService使用outerExecutor

@Service
@Slf4j
public class OuterService {

    @Async("outerExecutor")
    public Future<String> getUserInfo() throws Exception {
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            log.error("获取用户详情失败",e);
        }
        log.info("获取用户详情成功");
        return new AsyncResult<>("success");
    }
}

运行效果

2018-11-23 16:18:01.696  INFO 1552 --- [ out-executor-2] com.example.async.service.OuterService   : 获取用户详情成功
2018-11-23 16:18:01.696  INFO 1552 --- [nio-8080-exec-5] com.example.async.service.UserService    : 添加用户成功
2018-11-23 16:18:01.697  INFO 1552 --- [nio-8080-exec-5] com.example.async.service.UserService    : 更新用户成功
2018-11-23 16:18:01.697  INFO 1552 --- [nio-8080-exec-5] c.e.async.controller.UserController      : 执行时间1001
2018-11-23 16:18:11.699  INFO 1552 --- [mail-executor-2] com.example.async.service.MailService    : 发送邮件成功

完!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,511评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,495评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,595评论 0 225
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,558评论 0 190
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,715评论 3 270
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,672评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,112评论 2 291
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,837评论 0 181
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,417评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,928评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,316评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,773评论 2 234
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,253评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,827评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,440评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,523评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,583评论 2 249

推荐阅读更多精彩内容