10分钟实现SpringBoot发送短信功能
#哪些是SMTP?
SMTP全称为Mail(简单电邮传输合同),它是一组用于从源地址到目的地址传输短信的规范,通过它来控制短信的中转形式。SMTP认证要求必须提供帐号和密码就能登入服务器,其设计目的在于防止用户遭到垃圾电邮的袭扰。
#哪些是imap?
IMAP全称为(互联网电邮访问合同),IMAP容许从电邮服务器上获取短信的信息、下载短信等。IMAP与POP类似,都是一种电邮获取合同。
#哪些是POP3?
POP3全称为Post3(邮局合同),POP3支持顾客端远程管理服务器端的电邮。POP3常用于“离线”邮件处理,即容许顾客端下载服务器电邮,之后服务器上的电邮将会被删掉。目前好多POP3的短信服务器只提供下载短信功能,服务器本身并不删掉电邮,这些属于改进版的POP3合同。
#IMAP和POP3合同有哪些不同呢?
二者最大的区别在于,IMAP容许单向通讯,即在顾客端的操作会反馈到服务器上,比如在顾客端缴纳电邮、标记已读等操作,服务器会跟随同步这种操作。而对于POP合同似乎也容许顾客端下载服务器电邮,并且在顾客端的操作并不会同步到服务器里面的,比如在顾客端缴纳或标记已读电邮,服务器不会同步这种操作。
#哪些是和?
和是官方提供的集成短信服务的插口和实现类,以简单高效的设计闻名,目前是Java前端发送短信和集成电邮服务的主流工具。
#怎样通过发送短信?
十分简单,直接在业务类注入并调用send方式发送短信。其中简单电邮可以通过来发送短信,而复杂的短信(比如添加附件)可以利用来建立发送短信。诸如:
@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);
}
复制
复制
#为何还能开箱即用?
所谓开箱即用虽然就是基于官方外置的手动配置,翻看源码可知晓电邮手动配置类()为上下文提供了电邮服务实例()。具体源码如下:
@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;
}
复制
复制
其中是关于短信服务器的配置信息,具体源码如下:
@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 properties = new HashMap<>();
}
复制
#开启电邮服务
登录网易邮箱163,在设置中打开并勾选POP3/SMTP/IMAP服务,之后会得到一个授权码,这个邮箱和授权码将用作登录认证。
#配置电邮服务
首先俺们通过创建工程-send-mail,如图所示:
之后在pom.xml引入web、和-boot--mail等相关依赖。诸如:
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-thymeleaf
org.springframework.boot
spring-boot-starter-mail
org.webjars
webjars-locator-core
org.webjars
jquery
3.3.1
org.webjars
bootstrap
3.3.7
org.springframework.boot
spring-boot-devtools
runtime
org.springframework.boot
spring-boot-starter-test
test
复制
按照上面提及的配置项()填写相关配置信息,其中.mail.表示联接短信服务器时认证的登录帐号,可以是普通的手机号或则登入帐号,并非一定是邮箱,为了解决这个问题,推荐你们在.mail..from填写短信发信人即真实邮箱。
之后在.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 #限制请求总量
复制
透过上面的进阶知识,我们晓得在发送短信前,须要先建立或电邮信息类来填写电邮标题、邮件内容等信息,最后递交给发送短信,这样看上去没哪些问题,也能实现既定目标,但在实际使用中会出现大量零散和重复的代码,还不易于保存电邮到数据库。
这么典雅的发送短信应当是怎样的呢?应当屏蔽掉那些建立信息和发送短信的细节,不管是简单还是复杂电邮,都可以通过统一的API来发送短信。诸如:.send()。
比如通过短信信息类()来保存发送短信时的电邮主题、邮件内容等信息:
package com.hehe.vo;
public class MailVo {
private String 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;
}
复制
#发送短信和附件
===========接出来即将介绍发送短信的最核心逻辑前方高能=============
不仅发送短信之外,还包括测量电邮和保存电邮等操作,比如:
本案例电邮业务类的具体源码如下:
package com.hehe.service;
@Service
public class MailService {
private Logger logger = LoggerFactory.getLogger(getClass());
@Autowired
private JavaMailSenderImpl mailSender;
public MailVo sendMail(MailVo mailVo) {
try {
checkMail(mailVo);
sendMimeMail(mailVo);
return saveMail(mailVo);
} 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);
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");
}
}
复制
搞定了发送短信最核心的业务逻辑,接出来俺们写一个简单页面拿来发送短信。
首先写好跟页面交互的控制器,具体源码如下:
@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);
}
}
复制
之后在//views/mail目录新建.html,具体源码如下:
0
复制
复制
#测试发送短信
假如是初学者,建议你们先下载源码,更改配置后运行工程,成功后再自己重新写一遍代码,这样有助于加深记忆。
启动工程并访问::8080之后可以看见发送短信的主界面如下:
之后填写你的大号邮箱,点击发送短信,若成功则可以登录大号邮箱查看电邮和刚刚上传的附件。
至此发送短信代码全部完成,欢迎你们下载并关注源码。
假如企业定做了短信服务器,自然会记录电邮日志,按照错误编码储存日志有利于日常维护。
比如那些由网易邮箱提供的错误编码标示:
#源码下载
-send-mail: