脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring 异步接口

Spring 异步接口返回结果的四种方式

 更新时间：2022年08月28日 16:52:27   作者：鱼找水需要时间  
这篇文章主要介绍了Spring 异步接口返回结果的四种方式，文章围绕主题展开详细的内容介绍，具有一定的参考价值，感兴趣的小伙伴可以参考一下

1. 需求

开发中我们经常遇到异步接口需要执行一些耗时的操作，并且接口要有返回结果。

使用场景：用户绑定邮箱、手机号，将邮箱、手机号保存入库后发送邮件或短信通知
接口要求：数据入库后给前台返回成功通知，后台异步执行发邮件、短信通知操作

一般的话在企业中会借用消息队列来实现发送，业务量大的话有一个统一消费、管理的地方。但有时项目中没有引用mq相关组件，这时为了实现一个功能去引用、维护一个消息组件有点大材小用，下面介绍几种不引用消息队列情况下的解决方式

定义线程池：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.task.TaskExecutor;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import java.util.concurrent.ThreadPoolExecutor;
/**
 * @description: 公共配置
 * @author: yh
 * @date: 2022/8/26
 */
@EnableAsync
@Configuration
public class CommonConfig {
    @Bean
    public TaskExecutor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();

        // 设置核心线程数
        executor.setCorePoolSize(50);
        // 设置最大线程数
        executor.setMaxPoolSize(200);
        // 设置队列容量
        executor.setQueueCapacity(200);
        // 设置线程活跃时间（秒）
        executor.setKeepAliveSeconds(800);
        // 设置默认线程名称
        executor.setThreadNamePrefix("task-");
        // 设置拒绝策略
        executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
        // 等待所有任务结束后再关闭线程池
        executor.setWaitForTasksToCompleteOnShutdown(true);
        return executor;
    }
}

2. 解决方案

2.1 @Async

定义异步任务，如发送邮件、短信等

@Service
public class ExampleServiceImpl implements ExampleService {
    @Async("taskExecutor")
    @Override
    public void sendMail(String email) {
        try {
            Thread.sleep(3000);
            System.out.println("异步任务执行完成, " + email + " 当前线程：" + Thread.currentThread().getName());
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }
}

Controller

@RequestMapping(value = "/api")
@RestController
public class ExampleController {
    @Resource
    private ExampleService exampleService;

    @RequestMapping(value = "/bind",method = RequestMethod.GET)
    public String bind(@RequestParam("email") String email) {
        long startTime = System.currentTimeMillis();
        try {
            // 绑定邮箱....业务
            Thread.sleep(2000);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        //模拟异步任务(发邮件通知、短信等)
        exampleService.sendMail(email);

        long endTime = System.currentTimeMillis();
        System.out.println("方法执行完成返回，耗时：" + (endTime - startTime));
        return "ok";
    }
}

运行结果：

2.2 TaskExecutor

@RequestMapping(value = "/api")
@RestController
public class ExampleController {
    @Resource
    private ExampleService exampleService;
    @Resource
    private TaskExecutor taskExecutor;

    @RequestMapping(value = "/bind", method = RequestMethod.GET)
    public String bind(@RequestParam("email") String email) {
        long startTime = System.currentTimeMillis();
        try {
            // 绑定邮箱....业务
            Thread.sleep(2000);

            // 将发送邮件交给线程池去执行
            taskExecutor.execute(() -> {
                exampleService.sendMail(email);
            });
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }

        long endTime = System.currentTimeMillis();
        System.out.println("方法执行完成返回，耗时：" + (endTime - startTime));
        return "ok";
    }
}

运行结果：

2.3 Future

首先去掉Service方法中的@Async("taskExecutor")，此时执行就会变成同步，总计需要5s才能完成接口返回。这次我们使用jdk1.8中的CompletableFuture来实现异步任务

@RequestMapping(value = "/api")
@RestController
public class ExampleController {
    @Resource
    private ExampleService exampleService;
    @Resource
    private TaskExecutor taskExecutor;

    @RequestMapping(value = "/bind", method = RequestMethod.GET)
    public String bind(@RequestParam("email") String email) {
        long startTime = System.currentTimeMillis();
        try {
            // 绑定邮箱....业务
            Thread.sleep(2000);

            // 将发送邮件交给异步任务Future，需要记录返回值用supplyAsync
            CompletableFuture.runAsync(() -> {
                exampleService.sendMail(email);
            }, taskExecutor);

        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }

        long endTime = System.currentTimeMillis();
        System.out.println("方法执行完成返回，耗时：" + (endTime - startTime));
        return "ok";
    }
}

运行结果：

2.4 @EventListener

Spring为我们提供的一个事件监听、订阅的实现，内部实现原理是观察者设计模式；为的就是业务系统逻辑的解耦,提高可扩展性以及可维护性。事件发布者并不需要考虑谁去监听，监听具体的实现内容是什么，发布者的工作只是为了发布事件而已。

2.4.1 定义event事件模型

public class NoticeEvent extends ApplicationEvent {
    private String email;
    private String phone;
    public NoticeEvent(Object source, String email, String phone) {
        super(source);
        this.email = email;
        this.phone = phone;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    public String getPhone() {
        return phone;
    }
    public void setPhone(String phone) {
        this.phone = phone;
    }
}

2.4.2 事件监听

@Component
public class ComplaintEventListener {

    /**
     * 只监听NoticeEvent事件
     * @author: yh
     * @date: 2022/8/27
     */
    @Async
    @EventListener(value = NoticeEvent.class)
//    @Order(1) 指定事件执行顺序
    public void sendEmail(NoticeEvent noticeEvent) {
        //发邮件
        try {
            Thread.sleep(3000);
            System.out.println("发送邮件任务执行完成, " + noticeEvent.getEmail() + " 当前线程：" + Thread.currentThread().getName());
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }

    @Async
    @EventListener(value = NoticeEvent.class)
//    @Order(2) 指定事件执行顺序
    public void sendMsg(NoticeEvent noticeEvent) {
        //发短信
        try {
            Thread.sleep(3000);
            System.out.println("发送短信步任务执行完成, " + noticeEvent.getPhone() + " 当前线程：" + Thread.currentThread().getName());
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }
}

2.4.5 事件发布

@RequestMapping(value = "/api")
@RestController
public class ExampleController {
    /**
     * 用于事件推送
     * @author:  yh
     * @date:  2022/8/27
     */
    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    @RequestMapping(value = "/bind", method = RequestMethod.GET)
    public String bind(@RequestParam("email") String email) {
        long startTime = System.currentTimeMillis();
        try {
            // 绑定邮箱....业务
            Thread.sleep(2000);

            // 发布事件，这里偷个懒手机号写死
            applicationEventPublisher.publishEvent(new NoticeEvent(this, email, "13211112222"));
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("方法执行完成返回，耗时：" + (endTime - startTime));
        return "ok";
    }
}

运行结果：

3. 总结

通过@Async、子线程、Future异步任务、Spring自带ApplicationEvent事件监听都可以完成以上描述的需求。

到此这篇关于Spring 异步接口返回结果的四种方式的文章就介绍到这了,更多相关Spring 异步接口内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java多线程 CompletionService

    Java多线程 CompletionService

    这篇文章主要介绍了Java多线程 CompletionService，CompletionService用于提交一组Callable任务，其take方法返回已完成的一个Callable任务对应的Future对象,需要的朋友可以参考一下文章详细内容
    2021-10-10
  • 基于序列化存取实现java对象深度克隆的方法详解

    基于序列化存取实现java对象深度克隆的方法详解

    本篇文章是对序列化存取实现java对象深度克隆的方法进行了详细的分析介绍，需要的朋友参考下
    2013-05-05
  • 使用Java实现动态生成MySQL数据库

    使用Java实现动态生成MySQL数据库

    这篇文章主要为大家详细介绍了如何使用Java实现动态生成MySQL数据库,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-02-02
  • 深入解析Java编程中的StringBuffer与StringBuider

    深入解析Java编程中的StringBuffer与StringBuider

    这篇文章主要介绍了Java编程中的StringBuffer与StringBuider,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-09-09
  • SpringMVC中ModelAndView的使用及说明

    SpringMVC中ModelAndView的使用及说明

    这篇文章主要介绍了SpringMVC中ModelAndView的使用及说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2022-11-11
  • SpringBoot集成Jasypt敏感信息加密的操作方法

    SpringBoot集成Jasypt敏感信息加密的操作方法

    这篇文章主要介绍了SpringBoot集成Jasypt加密敏感信息,包括敏感信息加密的作用，项目集成Jasypt方式详解，本文给大家介绍的非常详细，需要的朋友可以参考下
    2022-05-05
  • Java实现链表数据结构的方法

    Java实现链表数据结构的方法

    这篇文章主要介绍了Java实现链表数据结构的相关资料,每一个链表都包含多个节点，节点又包含两个部分，一个是数据域（储存节点含有的信息），一个是引用域（储存下一个节点或者上一个节点的地址），需要的朋友可以参考下
    2022-01-01
  • Spring AOP底层源码详解

    Spring AOP底层源码详解

    这篇文章主要介绍了Spring AOP底层源码详解，帮助大家更好的理解和学习使用Spring AOP，感兴趣的朋友可以了解下
    2021-03-03
  • SpringBoot文件上传控制及Java 获取和判断文件头信息

    SpringBoot文件上传控制及Java 获取和判断文件头信息

    这篇文章主要介绍了SpringBoot文件上传控制的相关资料，非常不错，具有参考借鉴价值,需要的朋友可以参考下
    2017-12-12
  • 五分钟带你学会用java解析json字符串

    五分钟带你学会用java解析json字符串

    这篇文章主要给大家介绍了关于用java解析json字符串的相关资料,JSON是一种轻量级的、基于文本的、与语言无关的数据交换格式,易于人和机器读写,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-07-07

最新评论