在Java应用中,绝大多数情况下都是通过同步的方式来实现交互处理的;但是在处理与第三方系统交互的时候,容易造成响应迟缓的情况,之前大部分都是使用多线程来完成此类任务,在
spring 3.x
之后,就已经内置了@Async
来解决这个问题。
同一个类中,一个方法调用另外一个有@Async的方法,该注解是不会生效的。注解本质使用的是动态代理,因为调用方法的是对象本身而不是代理对象,因为没有经过Spring容器,所以也就不会生效。
- 何为异步调用?
在解释异步调用之前,我们先来看同步调用的定义;同步就是整个处理过程顺序执行,当各个过程都执行完毕,并返回结果。 异步调用则是只是发送了调用的指令,调用者无需等待被调用的方法完全执行完毕;而是继续执行下面的流程。
例如, 在某个调用中,需要顺序调用 A, B, C三个过程方法;如他们都是同步调用,则需要将他们都顺序执行完毕之后,方算作过程执行完毕; 如B为一个异步的调用方法,则在执行完A之后,调用B,并不等待B完成,而是执行开始调用C,待C执行完毕之后,就意味着这个过程执行完毕了。
- . 常规的异步调用处理方式
多线程,这是很多人第一眼想到的关键词,没错,多线程就是一种实现异步调用的方式。
在非spring目项目中我们要实现异步调用的就是使用多线程方式,可以自己实现Runable接口或者集成Thread类,或者使用jdk1.5以上提供了的Executors线程池。
也就是基于创建独立的线程去完成相应的异步调用逻辑,通过主线程和不同的线程之间的执行流程,从而在启动独立的线程之后,主线程继续执行而不会产生停滞等待的情况。
- @Async介绍
在Spring中,基于@Async
标注的方法,称之为异步方法;这些方法将在执行的时候,将会在独立的线程中被执行,调用者无需等待它的完成,即可继续其他的操作。
SpringBoot使用@Async步骤
- 启动类添加
@EnableAsync
注解主要是为了扫描范围包下的所有@Async
注解。
@SpringBootApplication
@EnableCaching // 开启缓存
@EnableAsync //Enables Spring's asynchronous method execution capability
- 发送邮件采用异步,在
MailService
的sendMail
方法上面加@Async
注解
package com.pay.common.service;
import com.pay.common.util.StringUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.messaging.MessagingException;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
import javax.mail.internet.MimeMessage;
/**
* @ClassName: MailService
* @Description:邮件发送service
* @author: 郭秀志 jbcode@126.com
* @date: 2020年1月18日 下午1:37:09
* @Copyright:
*/
@Service
@Slf4j
public class MailService {
@Autowired
private JavaMailSender mailSender;
@Value("${spring.mail.username}")
private String from;
@Value("${spring.mail.toUser}")
private String toUser;
@Value("${spring.mail.ccUsers}")
private String ccUsers;
@Value("${spring.mail.bccUsers}")
private String bccUsers;
@Async
public void sendMail(String subject, String text) throws MessagingException, javax.mail.MessagingException {
log.info("开始发送邮件通知,邮件内容为:[{}]", text);
MimeMessage message = mailSender.createMimeMessage();
MimeMessageHelper mMessageHelper = new MimeMessageHelper(message, true, "UTF-8");
// 发件人邮箱
mMessageHelper.setFrom(from);
// 收件人邮箱
mMessageHelper.setTo(toUser);
// 邮件的主题也就是邮件的标题
mMessageHelper.setSubject(subject);
mMessageHelper.setText(text, true);
if (StringUtils.isNotEmpty(ccUsers)) {
mMessageHelper.setCc(ccUsers.split(","));
}
if (StringUtils.isNotEmpty(bccUsers)) {
mMessageHelper.setBcc(bccUsers.split(","));
}
mailSender.send(message);
log.info("发送邮件通知成功,邮件内容为:[{}]", text);
}
}
-
Controller
调用发送邮件的异步方法。
package com.pay.payee.controller;
import com.pay.common.message.JsonResult;
import com.pay.common.service.MailService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.MessagingException;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @ClassName: RestTemplateController
* @Description:mail邮件发送。
* @author: 郭秀志 jbcode@126.com
* @date: 2020年1月18日 下午12:44:08
* @Copyright:
*/
@RestController
@Slf4j
@RequestMapping(value = "/mail")
public class MailController {
@Autowired
private MailService mailService;
@RequestMapping(value = "/send")
public JsonResult<String> sendMail() throws MessagingException, javax.mail.MessagingException {
mailService.sendMail("邮件发送by springboot ", "邮件正文,通过spring-boot-starter-mail");
log.info("发送邮件完成");
System.out.println();
return JsonResult.of("发送邮件完成", true, "成功调用");
}
}
- 访问url,测试异步发送邮件。
由于是异步进行发送邮件,接口立即返回了发送完成的消息,{"data":"发送邮件完成","flag":true,"code":0,"msg":"成功调用"}
。
随后控制台打印信息显示,使用了新的线程[task-1]
,真正开始发送邮件。
2020-05-08 16:10:37 [restartedMain] INFO org.apache.coyote.http11.Http11NioProtocol -Starting ProtocolHandler ["http-nio-8555"]
2020-05-08 16:11:43 [http-nio-8555-exec-1] INFO o.s.scheduling.concurrent.ThreadPoolTaskExecutor -Initializing ExecutorService 'applicationTaskExecutor'
2020-05-08 16:11:43 [http-nio-8555-exec-1] INFO com.pay.payee.controller.MailController -发送邮件完成
2020-05-08 16:11:43 [task-1] INFO com.pay.common.service.MailService -开始发送邮件通知,邮件内容为:[邮件正文,通过spring-boot-starter-mail]
......
- 判断异步任务状态
异步注解代理的方法可以有一个返回值Future<T>,可以用isCancelled判断异步任务是否取消,isDone判断任务是否执行结束,get获取返回结果。