Spring实现邮箱验证码登录

Spring实现邮箱验证码登录

基本说明

SMTP协议

SMTP(Simple Mail Transfer Protocol-简单邮件传输协议)，是用于发送邮件的规则协议。SMTP属于TCP/IP协议簇。
所以SMTP服务器就是符合SMTP协议的发送邮件的服务器，作用就是用来发送邮件。
该协议默认端口号是25

POP3协议

POP3(Post Office Protocol - Version 3 邮局协议版本3)是用于支持使用客户端远程管理服务器上的电子邮件，因此，在收邮件时，需要使用该协议从对应的服务器上获取邮件。

开通邮箱验证码功能

登录QQ邮箱，点击设置

点击账户，找到POP3/SMTP服务，点击开启

获取授权码并保存

SpringBoot开发

build.gradle，依赖

// 邮箱发送服务
// https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-mail
implementation group: 'org.springframework.boot', name: 'spring-boot-starter-mail', version: '2.3.12.RELEASE'

application.properties，配置

com.mail.title="注册验证码"
# 发件人身份（昵称）
com.mail.identity=xxx
# 用户邮箱
# com.mail.from=xxx@qq.com
# com.mail.username=xxx@qq.com
# 企业邮箱
com.mail.from=xxx@xxx.info
com.mail.username=xxx@xxx.info
com.mail.password=xxx
# 用户邮箱
# com.mail.host=smtp.qq.com
# 企业邮箱
com.mail.host=smtp.exmail.qq.com

MailTokenHelper，生成随机验证码

import org.springframework.stereotype.Component;

import java.util.Random;

@Component
public class MailTokenHelper {

    public String createNumber(int digit) {

        String text = "1234567890";
        String result = "";
        Random random = new Random();
        for (int i = 0; i < digit; i++) {
            int index = random.nextInt(text.length());
            char c = text.charAt(index);
            result += c;
        }

        return result;
    }
}

MailHelper，发送邮箱验证码，工具类

import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSenderImpl;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.util.Properties;

@Slf4j
@Component
@Data
@ConfigurationProperties(prefix = "com.mail")
public class MailHelper {

    private String from;
    private String title;
    private String identity;
    private static final int port = 465;
    
    @Autowired 
    JavaMailSenderImpl mailSender;

    @PostConstruct
    public void init() {
        mailSender.setPort(port);
        mailSender.setDefaultEncoding("UTF-8");

        Properties properties = System.getProperties();
        properties.setProperty("mail.smtp.auth", "true"); // 开启认证
        properties.put("mail.smtp.ssl.enable", true);
        properties.setProperty("mail.debug", "true"); // 启用调试
        properties.setProperty("mail.smtp.timeout", "25000"); // 设置链接超时
        properties.setProperty("mail.smtp.port", Integer.toString(port)); // 设置端口
        properties.setProperty("mail.smtp.socketFactory.port", Integer.toString(port)); // 设置ssl端口
        properties.setProperty("mail.smtp.socketFactory.fallback", "false");
        properties.setProperty("mail.smtp.socketFactory.class", "javax.net.ssl.SSLSocketFactory");
        mailSender.setJavaMailProperties(properties);
    }

    public boolean sendMail(String to, String emailServiceCode) {
        try {
            SimpleMailMessage message = new SimpleMailMessage();
            message.setSubject("【" + identity + "】 " + title);
            message.setText("【" + identity + "】 " + " 本次请求的验证码为：" + emailServiceCode);
            message.setFrom(from);
            message.setTo(to);
            mailSender.send(message);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }
}

EmailService，发送邮箱验证码，服务类

@Service
public class EmailService {

    @Autowired 
    private MailHelper mailHelper;
    
    @Autowired 
    private MailTokenHelper mailTokenHelper;

    public ServerResponse sendEmail(String userEmail, String content) {
        if (!mailHelper.sendMail(userEmail, content))
            return ServerResponse.getInstance().responseEnum(ResponseEnum.INTERNAL_ERROR).failed();
        return ServerResponse.getInstance().ok().responseEnum(ResponseEnum.SUCCESS).message("邮箱可用");
    }
}

VerifyService，邮箱验证码认证，发送+认证

@Service
public class VerifyService {

    @Autowired 
    private EmailService emailService;
    
    @Autowired 
    private MailTokenHelper mailTokenHelper;
    
    // 执行发送邮箱验证码到用户
    public ServerResponse checkEmail(String userEmail) {
        String emailServiceCode = mailTokenHelper.createNumber(4);
        /**
        * Redis缓存邮箱号和验证码
        * 用于后续身份验证
        * */ 
        return emailService.sendEmail(userEmail, emailServiceCode);
    }
    
    // 验证用户身份
    public ServerResponse verifyEmail(String userEmail, String mailContent) {

        /**
        * 从Redis获取邮箱号和验证码信息
        * 对比用户前端提交的数据
        * 验证用户注册或登录或验证是否成功
        * */
	
    }
    
}