功能分析
因为我们要实现注册功能,而注册功能主要的一个判断逻辑就是每个人的邮件账号是否存在,以及激活账号所用,所以实现发送邮件功能也是一个必须的过程。
而实现该功能必须要有专门的邮件服务器。邮件服务器类似于现实生活中的邮局,它主要负责接收用户投递过来的邮件,并把邮件投递到邮件接收者的电子邮箱中。
首先我们要了解一下邮件传输协议 SMTP 和 POP3 协议。我们通常把处理用户 SMTP 请求(邮件发送请求)的服务器称之为 SMTP 服务器(邮件发送服务器);把处理用户 POP3 请求(邮件接收请求)的服务器称之为 POP3 服务器(邮件接收服务器)。
收发过程看下图:
开发步骤
开启SMTP
以网易 163 为例,点击设置里的 POP3/SMTP/IMAP
开启对应的 POP3/SMTP 服务,这里需要授权码自己设置一下就好
依赖引入
在 SpringBoot 中集成了 Spring Email 功能,提供了非常好用的 JavaMailSender 接口实现邮件发送。在 SpringBoot 的 Starter 模块中也为此提供了自动化配置,引入对应依赖。
compile group: 'org.springframework.boot', name: 'spring-boot-starter-mail', version: '2.2.7.RELEASE'
properties文件配置
同理也需要在配置文件中配置邮箱的参数,如使用了哪家的邮箱,端口,用户名和密码等等。
# MailProperties
spring.mail.host=smtp.163.com
spring.mail.port=465
spring.mail.username=***
spring.mail.password=***
spring.mail.protocol=smtps
spring.mail.properties.smtp.auth=true
spring.mail.properties.mail.smtp.ssl.enable=true
代码开发
我们将发送邮件的逻辑进行封装,以便我们进行复用。我们知道它是通过 JavaMailSender 接口发送邮件,所以我们要注入JavaMailSender 实例,邮件内容呢有两种一个是 SimpleMailMessage(简单文本格式),一个是 MimeMessage(HTML 格式),我们这里呢使用后一种,并且邮件的主体内容,通过 MimeMessageHelper 帮助类构造,构造好之后可以直接获取发送。
MailClient 类:
package com.spring.community2.util;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.stereotype.Component;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
/**
* @ClassName MailClient
* @Author ruizhou
* @Date 2020/5/15 20:44
**/
@Component
public class MailClient {
private static final Logger logger = LoggerFactory.getLogger(MailClient.class);
@Autowired
private JavaMailSender mailSender;
@Value("${spring.mail.username}")
private String from;
public void sendMail(String to, String subject, String content) {
try {
// 构建邮件主体,利用MimeMessageHelper帮助类
MimeMessage message = mailSender.createMimeMessage();
MimeMessageHelper helper = new MimeMessageHelper(message);
// 设置发送者,需要和配置文件中的username一致,否则会报错
helper.setFrom(from);
// 设置邮件的接受者
helper.setTo(to);
// 设置邮件的标题
helper.setSubject(subject);
// 第二个参数要true值,表示需要使用HTML样式
helper.setText(content, true);
mailSender.send(helper.getMimeMessage());
} catch (MessagingException e) {
logger.error("发送邮件失败:" + e.getMessage());
}
}
}
发送邮件的客户端写好了,写段测试代码测试一下。
因为我们发送的是 HTML 格式的邮件,所以我们发送的 content 是需要主动的去调用 Thymeleaf 引擎调用模板。
package com.spring.community2;
import com.spring.community2.util.MailClient;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;
/**
* @ClassName MailTest
* @Author ruizhou
* @Date 2020/5/15 20:57
**/
@SpringBootTest
public class MailTest {
@Autowired
private MailClient mailClient;
@Autowired
private TemplateEngine templateEngine;
@Test
public void testTextMail() {
mailClient.sendMail("***@qq.com","test","Welcome");
}
@Test
public void testHtmlMail() {
Context context = new Context();
context.setVariable("username","***@qq.com");
String content = templateEngine.process("/mail/demo",context);
System.out.println(content);
mailClient.sendMail("***@qq.com","激活账号",content);
}
}