SpringBoot集成短信服务竟这么简单,还等哪些,快来学习涨坐姿吧!!
学习目标基础知识
SMTP全称为Simple Mail Transfer Protocol(简单邮件传输协议),它是一组用于从源地址到目的地址传输短信的规范,通过它来控制短信的中转形式。SMTP认证要求必须提供帐号和密码就能登入服务器,其设计目的在于防止用户遭到垃圾邮件的袭扰。
IMAP全称为Internet Message Access Protocol(互联网电邮访问合同),IMAP容许从邮件服务器上获取短信的信息、下载短信等。IMAP与POP类似,都是一种短信获取合同。
POP3全称为Post Office Protocol 3(邮局合同),POP3支持客户端远程管理服务器端的电邮。POP3常用于“离线”邮件处理,即容许客户端下载服务器电邮,然后服务器上的电邮将会被删除。目前好多POP3的邮件服务器只提供下载短信功能,服务器本身并不删掉电邮,这种属于改进版的POP3合同。
两者最大的区别在于,IMAP容许双向通信,即在客户端的操作会反馈到服务器上,例如在客户端缴纳电邮、标记已读等操作,服务器会跟随同步这种操作。而对于POP合同似乎也容许客户端下载服务器电邮,但是在客户端的操作并不会同步到服务器里面的,例如在客户端缴纳或标记已读电邮,服务器不会同步这种操作。
进阶知识
JavaMailSender和JavaMailSenderImpl是Spring官方提供的集成电邮服务的插口和实现类,以简单高效的设计闻名,目前是Java前端发送短信和集成电邮服务的主流工具。
非常简单,直接在业务类注入JavaMailSenderImpl并调用send方式发送短信。其中简单电邮可以通过SimpleMailMessage来发送短信,而复杂的电邮(例如添加附件)可以利用MimeMessageHelper来建立MimeMessage发送短信。例如:
@Autowired
private JavaMailSenderImpl mailSender;
public void sendMail() throws MessagingException {
//简单邮件
SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
simpleMailMessage.setFrom("admin@163.com");
simpleMailMessage.setTo("socks@qq.com");
simpleMailMessage.setSubject("Happy New Year");
simpleMailMessage.setText("新年快乐!");
mailSender.send(simpleMailMessage);
//复杂邮件
MimeMessage mimeMessage = mailSender.createMimeMessage();
MimeMessageHelper messageHelper = new MimeMessageHelper(mimeMessage);
messageHelper.setFrom("admin@163.com");
messageHelper.setTo("socks@qq.com");
messageHelper.setSubject("Happy New Year");
messageHelper.setText("新年快乐!");
messageHelper.addInline("doge.gif", new File("xx/xx/doge.gif"));
messageHelper.addAttachment("work.docx", new File("xx/xx/work.docx"));
mailSender.send(mimeMessage);
}
所谓开箱即用虽然就是基于官方外置的手动配置,翻看源码可知晓电邮手动配置类(MailSenderPropertiesConfiguration) 为上下文提供了电邮服务实例(JavaMailSenderImpl)。具体源码如下:
@Configuration
@ConditionalOnProperty(prefix = "spring.mail", name = "host")
class MailSenderPropertiesConfiguration {
private final MailProperties properties;
MailSenderPropertiesConfiguration(MailProperties properties) {
this.properties = properties;
}
@Bean
@ConditionalOnMissingBean
public JavaMailSenderImpl mailSender() {
JavaMailSenderImpl sender = new JavaMailSenderImpl();
applyProperties(sender);
return sender;
}
其中MailProperties是关于邮件服务器的配置信息,具体源码如下:
@ConfigurationProperties(prefix = "spring.mail")
public class MailProperties {
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
private String host;
private Integer port;
private String username;
private String password;
private String protocol = "smtp";
private Charset defaultEncoding = DEFAULT_CHARSET;
private Map<String, String> properties = new HashMap<>();
}
使用教程一、开启电邮服务
登陆网易邮箱163,在设置中打开并勾选POP3/SMTP/IMAP服务,然后会得到一个授权码,这个邮箱和授权码将用作登录认证。
二、配置短信服务
首先俺们通过 Spring Initializr 创建工程springboot-send-mail,如图所示:
然后在pom.xml 引入web、thymeleaf 和spring-boot-starter-mail等相关依赖。例如:
<dependencies>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-thymeleafartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-mailartifactId>
dependency>
<dependency>
<groupId>org.webjarsgroupId>
<artifactId>webjars-locator-coreartifactId>
dependency>
<dependency>
<groupId>org.webjarsgroupId>
<artifactId>jqueryartifactId>
<version>3.3.1version>
dependency>
<dependency>
<groupId>org.webjarsgroupId>
<artifactId>bootstrapartifactId>
<version>3.3.7version>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-devtoolsartifactId>
<scope>runtimescope>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
根据上面提及的配置项(MailProperties)填写相关配置信息,其中spring.mail.username 表示联接邮件服务器时认证的登录帐号,可以是普通的手机号或则登入帐号,并非一定是邮箱,为了解决这个问题,推荐你们在spring.mail. properties.from填写短信发信人即真实邮箱。
然后在application.yml添加如下配置:
spring:
mail:
host: smtp.163.com #SMTP服务器地址
username: socks #登陆账号
password: 123456 #登陆密码(或授权码)
properties:
from: socks@163.com #邮件发信人(即真实邮箱)
thymeleaf:
cache: false
prefix: classpath:/views/
servlet:
multipart:
max-file-size: 10MB #限制单个文件大小
max-request-size: 50MB #限制请求总量
透过上面的进阶知识,我们晓得在发送短信前,需要先建立 SimpleMailMessage或 MimeMessage 邮件信息类来填写电邮标题、邮件内容等信息,最后递交给JavaMailSenderImpl发送短信,这样看起来没哪些问题,也能实现既定目标,但在实际使用中会出现大量零散和重复的代码,还不易于保存电邮到数据库。
那么高贵的发送短信应当是怎样的呢?应该屏蔽掉那些建立信息和发送短信的细节,不管是简单还是复杂电邮,都可以通过统一的API来发送短信。例如: mailService.send(mailVo) 。
例如通过短信信息类(MailVo) 来保存发送短信时的电邮主题、邮件内容等信息 :
package com.hehe.vo;
public class MailVo {
private String id;//邮件id
private String from;//邮件发送人
private String to;//邮件接收人(多个邮箱则用逗号","隔开)
private String subject;//邮件主题
private String text;//邮件内容
private Date sentDate;//发送时间
private String cc;//抄送(多个邮箱则用逗号","隔开)
private String bcc;//密送(多个邮箱则用逗号","隔开)
private String status;//状态
private String error;//报错信息
@JsonIgnore
private MultipartFile[] multipartFiles;//邮件附件
//省略GET&SET方法
}
三、发送短信和附件
=========== 接下来即将介绍发送短信的最核心逻辑 前方高能 =============
除了发送短信之外,还包括测量电邮和保存电邮等操作,例如:
本案例电邮业务类 MailService 的具体源码如下:
package com.hehe.service;
/**
* 邮件业务类 MailService
*/
@Service
public class MailService {
private Logger logger = LoggerFactory.getLogger(getClass());//提供日志类
@Autowired
private JavaMailSenderImpl mailSender;//注入邮件工具类
/**
* 发送邮件
*/
public MailVo sendMail(MailVo mailVo) {
try {
checkMail(mailVo); //1.检测邮件
sendMimeMail(mailVo); //2.发送邮件
return saveMail(mailVo); //3.保存邮件
} catch (Exception e) {
logger.error("发送邮件失败:", e);//打印错误信息
mailVo.setStatus("fail");
mailVo.setError(e.getMessage());
return mailVo;
}
}
//检测邮件信息类
private void checkMail(MailVo mailVo) {
if (StringUtils.isEmpty(mailVo.getTo())) {
throw new RuntimeException("邮件收信人不能为空");
}
if (StringUtils.isEmpty(mailVo.getSubject())) {
throw new RuntimeException("邮件主题不能为空");
}
if (StringUtils.isEmpty(mailVo.getText())) {
throw new RuntimeException("邮件内容不能为空");
}
}
//构建复杂邮件信息类
private void sendMimeMail(MailVo mailVo) {
try {
MimeMessageHelper messageHelper = new MimeMessageHelper(mailSender.createMimeMessage(), true);//true表示支持复杂类型
mailVo.setFrom(getMailSendFrom());//邮件发信人从配置项读取
messageHelper.setFrom(mailVo.getFrom());//邮件发信人
messageHelper.setTo(mailVo.getTo().split(","));//邮件收信人
messageHelper.setSubject(mailVo.getSubject());//邮件主题
messageHelper.setText(mailVo.getText());//邮件内容
if (!StringUtils.isEmpty(mailVo.getCc())) {//抄送
messageHelper.setCc(mailVo.getCc().split(","));
}
if (!StringUtils.isEmpty(mailVo.getBcc())) {//密送
messageHelper.setCc(mailVo.getBcc().split(","));
}
if (mailVo.getMultipartFiles() != null) {//添加邮件附件
for (MultipartFile multipartFile : mailVo.getMultipartFiles()) {
messageHelper.addAttachment(multipartFile.getOriginalFilename(), multipartFile);
}
}
if (StringUtils.isEmpty(mailVo.getSentDate())) {//发送时间
mailVo.setSentDate(new Date());
messageHelper.setSentDate(mailVo.getSentDate());
}
mailSender.send(messageHelper.getMimeMessage());//正式发送邮件
mailVo.setStatus("ok");
logger.info("发送邮件成功:{}->{}", mailVo.getFrom(), mailVo.getTo());
} catch (Exception e) {
throw new RuntimeException(e);//发送失败
}
}
//保存邮件
private MailVo saveMail(MailVo mailVo) {
//将邮件保存到数据库..
return mailVo;
}
//获取邮件发信人
public String getMailSendFrom() {
return mailSender.getJavaMailProperties().getProperty("from");
}
}
搞定了发送短信最核心的业务逻辑,接下来俺们写一个简单页面拿来发送短信。
首先写好跟页面交互的控制器 MailController,具体源码如下:
@RestController
public class MailController {
@Autowired
private MailService mailService;
/**
* 发送邮件的主界面
*/
@GetMapping("/")
public ModelAndView index() {
ModelAndView mv = new ModelAndView("mail/sendMail");//打开发送邮件的页面
mv.addObject("from", mailService.getMailSendFrom());//邮件发信人
return mv;
}
/**
* 发送邮件
*/
@PostMapping("/mail/send")
public MailVo sendMail(MailVo mailVo, MultipartFile[] files) {
mailVo.setMultipartFiles(files);
return mailService.sendMail(mailVo);//发送邮件和附件
}
}
然后在/resources/views/mail目录新建sendMail.html,具体源码如下:
DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8"/>
<title>发送邮件title>
<link th:href="@{/webjars/bootstrap/css/bootstrap.min.css}" rel="stylesheet" type="text/css"/>
<script th:src="@{/webjars/jquery/jquery.min.js}">script>
<script th:href="@{/webjars/bootstrap/js/bootstrap.min.js}">script>
head>
<body>
<div class="col-md-6" style="margin:20px;padding:20px;border: #E0E0E0 1px solid;">
<marquee behavior="alternate" onfinish="alert(12)" id="mq"
onMouseOut="this.start();$('#egg').text('嗯 真听话!');"
onMouseOver="this.stop();$('#egg').text('有本事放开我呀!');">
<h5 id="egg">祝大家新年快乐!h5><img id="doge" src="http://pics.sc.chinaz.com/Files/pic/faces/3709/7.gif" alt="">
marquee>
<form class="form-horizontal" id="mailForm">
<div class="form-group">
<label class="col-md-2 control-label">邮件发信人:label>
<div class="col-md-6">
<input class="form-control" id="from" name="from" th:value="${from}" readonly="readonly">
div>
div>
<div class="form-group">
<label class="col-md-2 control-label">邮件收信人:label>
<div class="col-md-6">
<input class="form-control" id="to" name="to" title="多个邮箱使用,隔开">
div>
div>
<div class="form-group">
<label class="col-md-2 control-label">邮件主题:label>
<div class="col-md-6">
<input class="form-control" id="subject" name="subject">
div>
div>
<div class="form-group">
<label class="col-md-2 control-label">邮件内容:label>
<div class="col-md-6">
<textarea class="form-control" id="text" name="text" rows="5">textarea>
div>
div>
<div class="form-group">
<label class="col-md-2 control-label">邮件附件:label>
<div class="col-md-6">
<input class="form-control" id="files" name="files" type="file" multiple="multiple">
div>
div>
<div class="form-group">
<label class="col-md-2 control-label">邮件操作:label>
<div class="col-md-3">
<a class="form-control btn btn-primary" onclick="sendMail()">发送邮件a>
div>
<div class="col-md-3">
<a class="form-control btn btn-default" onclick="clearForm()">清空a>
div>
div>
form>
<script th:inline="javascript">
var appCtx = [[${#request.getContextPath()}]];
function sendMail() {
var formData = new FormData($('#mailForm')[0]);
$.ajax({
url: appCtx + '/mail/send',
type: "POST",
data: formData,
contentType: false,
processData: false,
success: function (result) {
alert(result.status === 'ok' ? "发送成功!" : "你被Doge嘲讽了:" + result.error);
},
error: function () {
alert("发送失败!");
}
});
}
function clearForm() {
$('#mailForm')[0].reset();
}
setInterval(function () {
var total = $('#mq').width();
var width = $('#doge').width();
var left = $('#doge').offset().left;
if (left <= width / 2 + 20) {
$('#doge').css('transform', 'rotateY(180deg)')
}
if (left >= total - width / 2 - 40) {
$('#doge').css('transform', 'rotateY(-360deg)')
}
});
script>
div>
body>
html>
四、测试发送短信
如果是初学者,建议你们先下载源码,修改配置后运行工程,成功后再自己重新写一遍代码,这样有助于加深记忆。
启动工程并访问::8080 之后可以看见发送短信的主界面如下:
然后填写你的大号邮箱,点击发送短信,若成功则可以登录大号邮箱查看电邮和刚刚上传的附件。
至此发送短信代码全部完成,欢迎你们下载并关注Github 源码。
五、常见失败编码假如企业定做了邮件服务器,自然会记录电邮日志,根据错误编码储存日志有利于日常维护。
例如那些由网易邮箱提供的错误编码标示:
421 HL:REP 该IP发送行为异常,存在接收者大量不存在情况,被临时严禁联接。请复查是否有用户发送病毒或则垃圾邮件,并核实发送列表有效性;
421 HL:ICC 该IP同时并发连接数过大,超过了网易的限制,被临时严禁联接。请复查是否有用户发送病毒或则垃圾邮件,并增加IP并发联接数目;
421 HL:IFC 该IP短期内发送了大量信函,超过了网易的限制,被临时严禁联接。请复查是否有用户发送病毒或则垃圾邮件,并增加发送频度;
421 HL:MEP 该IP发送行为异常,存在大量伪造发送域域名行为,被临时严禁联接。请复查是否有用户发送病毒或则垃圾邮件,并使用真实有效的域名发送;
-553
553 Requested action not taken: NULL sender is not allowed 不容许发件人为空,请使用真实发件人发送;
553 Requested action not taken: Local user only SMTP类型的机器只容许发信人是本站用户;
553 Requested action not taken: no smtp MX only MX类型的机器不容许发信人是本站用户;
553 authentication is required SMTP须要身分验证,请复查客户端设置;
-554
554 DT:SPM 发送的电邮内容包含了未被许可的信息,或被系统辨识为垃圾邮件。请复查是否有用户发送病毒或则垃圾邮件;
554 DT:SUM 信封发件人和信毛发件人不匹配;
554 IP is rejected, smtp auth error limit exceed 该IP验证失败次数过多,被临时严禁联接。请复查验证信息设置;
554 HL:IHU 发信IP因发送垃圾邮件或存在异常的联接行为,被暂时挂起。请检查发信IP在历史上的发信情况和发信程序是否存在异常;
554 HL:IPB 该IP不在网易容许的发送地址列表里;
554 MI:STC 发件人当日内累计电邮数目超过限制,当天不再接受该发件人的投信。请增加发信频度;
554 MI:SPB 此用户不在网易容许的发信用户列表里;
554 IP in blacklist 该IP不在网易容许的发送地址列表里。