1. 背景介绍
最近的一个项目需求中,需要将接口变更内容发送到业务负责人及相关的开发者。由于负责人可能有多个,采用的是批量发送的方式来进行邮件发送。使用的是jar包是javamail,maven依赖如下所示。在提测过程中发现,如果待发送的邮件地址列表中存在一个无效的地址【该地址是一个合法的邮件地址,但是是无效地址,如:duanduan@163.com,它是一个合法的邮件地址,但却是无效的地址】,则会导致所有邮件发送失败。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
2. 过程分析
首先来看一下是怎么调用的,代码如下:
public boolean sendMessageMail(Object params, String title, String templateName, String mailFrom, Set<String> mailSends) {
List<InternetAddress> addressList = new ArrayList<>();
try {
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
helper.setFrom(mailFrom);
mailSends.forEach(v -> {
if (!StringUtils.isEmpty(v)) {
try {
InternetAddress address = new InternetAddress(v);
addressList.add(address);
} catch (Exception e) {
log.error("sendMessageMail", "", "sendMessageMail", "邮箱地址转换失败,邮箱地址是:" + v);
}
}
});
InternetAddress[] addresses = new InternetAddress[addressList.size()];
addressList.toArray(addresses);
mimeMessage.addRecipients(Message.RecipientType.BCC, addresses);
helper.setSubject(title);//邮件标题
Map<String, Object> model = new HashMap<>();
model.put("params", params);
Template template = configurer.getConfiguration().getTemplate(templateName);
String text = FreeMarkerTemplateUtils.processTemplateIntoString(template, model);
helper.setText(text, true);
mailSender.send(mimeMessage);
return true;
} catch (TemplateException | IOException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
return false;
}
为了批量发送过程中泄露其他收件人的邮箱地址,采用了密文发送的方式(BCC),关于BCC的解释可见https://blog.csdn.net/lxgwm2008/article/details/46333427?fps=1&locationNum=4博文中介绍,浅显易懂。mailSender.send(mimeMessage)中调用了doSend方法,如下所示:
在JavaMailSenderImpl的doSend方法中调用了SMTPTransport的SendMessage方法,如上图红框中所示。SMTPTransport的sendMessage方法是Transport类中抽象方法的实现,具体代码展示如下:
在上述方法中,主要是看rcptTo()方法,为什么会把捕获的异常和抛出异常框出来呢?且往下看。
在rcptTo()方法中,关键代码如下:
如果sendFailed为true的话,这里最终会抛出一个SendFailedException异常,而在SMTPTransport的sendMessage方法中并没有捕获处理该异常,而是直接抛出,因此导致程序中有异常出现。接下来我们再看,什么时候sendFailed会被置为true呢?
剩下的如果感兴趣的话可以自己去跟踪一下,看一下代码实现,这里就不继续赘述了。
3. 解决办法
既然这样,一个邮件地址无效就会导致所有的邮件都发送不成功,怎么解决呢?问题的关键还是要熟悉Transport代码,设置监听器,代码如下:
public boolean sendMessageMail(Object params, String title, String templateName, String mailFrom, Set<String> mailSends) {
List<InternetAddress> addressList = new ArrayList<>();
try {
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
helper.setFrom(mailFrom);
mailSends.forEach(v -> {
if (!StringUtils.isEmpty(v)) {
try {
InternetAddress address = new InternetAddress(v);
addressList.add(address);
} catch (Exception e) {
log.error("sendMessageMail", "", "sendMessageMail", "邮箱地址转换失败,邮箱地址是:" + v);
}
}
});
InternetAddress[] addresses = new InternetAddress[addressList.size()];
addressList.toArray(addresses);
mimeMessage.addRecipients(Message.RecipientType.BCC, addresses);
helper.setSubject(title);//邮件标题
Map<String, Object> model = new HashMap<>();
model.put("params", params);
Template template = configurer.getConfiguration().getTemplate(templateName);
String text = FreeMarkerTemplateUtils.processTemplateIntoString(template, model);
helper.setText(text, true);
// 发送信件
Transport transport = mimeMessage.getSession().getTransport();
transport.addTransportListener(new CustomTransportListener(transport));
transport.connect(host, username, password);
transport.sendMessage(mimeMessage, addresses);
transport.close();
return true;
} catch (TemplateException | IOException e) {
log.error("sendMessageMail", "", "batchSendMessageMail","发送邮件操作,加载邮件Template失败!", e);
} catch (SendFailedException e) {
Address[] invalidAddresses = e.getInvalidAddresses();
StringBuilder sb = new StringBuilder();
int length = invalidAddresses.length;
for (int i = 0;i < length- 1; i++) {
sb.append(invalidAddresses[i]).append(", ");
}
sb.append(invalidAddresses[length - 1]);
log.error("sendMessageMail", "", "batchSendMessageMail", "批量发送邮件失败,无效的邮件地址如下:" + sb.toString());
} catch (Exception e) {
log.error("sendMessageMail", "", "batchSendMessageMail", "发送邮件失败!topic:" + title, e);
}
return false;
}
class CustomTransportListener extends TransportAdapter {
Transport transport;
CustomTransportListener(Transport transport) {
this.transport = transport;
}
@Override
public void messageNotDelivered(TransportEvent transportEvent) {
Address[] addresses = transportEvent.getValidUnsentAddresses();
Message message = transportEvent.getMessage();
try {
transport.sendMessage(message, addresses);
} catch (Exception e) {
e.printStackTrace();
}
}
}