前后端分离项目中实现注册业务中的邮箱验证码功能（详细）

一，前言

信息化的当前，信息安全性对于网站开发标准而言是不言而喻的。特别是用户进行登录注册时，防止恶意注册也成为网站开发的一项重点业务。由于现在有工具可以自动填入信息，在很短的时间内会注册大量的用户，这样会给网站服务器造成巨大压力，为了防止这种事情，所以发明了这种验证码，机器是不能识别的，只能是人才行。因此，今天带来一个在前后端分离的环境下，实现一个注册模块中，通过邮箱验证码实现用户注册的功能。起初是想通过短信验证码sms来实现的，但是现在好多短信业务要收费了，因此一切从简，以类似的方式，用邮箱验证码来代替实现效果。

验证码的作用：
　　1、为了防止机器冒充人类做暴力破解
　　2、防止大规模在线注册滥用服务
　　3、防止滥用在线批量操
　　4、防止自动发布
　　5、防止信息被大量采集聚合

二，实现效果

先来看看基础的实现效果：

用户输入基础的注册信息后，需要填写自己的邮箱号，并在前端进行基本的邮箱格式校验，如果邮箱号没毛病，则通过邮箱号去向邮箱发送验证短信，并得到邮箱验证码信息。后端将用户得到并输入的验证码信息与Redis缓存验证码信息做对比，并校验用户注册信息与数据库是否吻合，才能得到成功的注册结果。

三，准备条件

3.1，邮箱发送服务准备

想要实现邮箱验证码发送功能务必要先开启与之对应的邮箱服务。

这里以网易邮箱为例，我们需要用自己的邮箱作为发送邮箱，就需要开启POP3/SMTP/IMAP。登录邮箱–设置–账户–开启POP3/SMTP/IMAP，开启时可能会有短信验证，开启后显示验证码之类的一串英文，复制保存起来，后面要用

qq邮箱在设置-》账户 下即可开启相关的服务。

二者都行，其他也可。如果你想用那种就开启对应服务，并在SpringBoot项目中的Yml文件中配置对应的服务信息即可。

因为笔者是前后端分离项目，因此在这还要准备一下基础的项目搭建过程。

3.2，后端环境搭建说明

SpringBoot项目搭建及用户数据库不做详情描述，这里只说一下主要需要的项目依赖。在SpringBoot项目中已经有了集成邮件发送功能的依赖包了，因此当我们想要使用邮箱发送功能时，创建基础项目模块后要导入其依赖。

        
            org.springframework.boot
            spring-boot-starter-mail
        

除此以外，还需要在项目的yml文件中配置邮箱服务地址，以及作为发送邮箱的对象信息。这里以配置QQ邮箱为例。基础配置如下：

spring:
  mail:
    # 发送者邮箱
    username: *********
    #申请到的授权码
    password: *********
    # 配置 SMTP 服务器地址
    host: smtp.qq.com
    # 端口号465或587
    port: 465
    protocol: smtps
    # 默认的邮件编码为UTF-8
    default-encoding: UTF-8
    # 配置SSL 加密工厂
    properties:
      mail:
        smtp:
          socketFactoryClass: javax.net.ssl.SSLSocketFactory
          #表示开启 DEBUG 模式，这样，邮件发送过程的日志会在控制台打印出来，方便排查错误
          debug: true
          ssl: true

这样后端邮箱服务配置准备就算完成了。

3.3，前端环境搭建说明

前端项目主要通过Vue框架搭建，配合ElementPlus即可构建出简单的注册界面，这里不做详述。主要业务逻辑在于:

当用户输入邮箱后，才能点击"获取邮箱验证码"按钮去获取邮箱验证码，并且第一次点击后按钮变为不可选，同时进入一分钟倒计时（与后端的邮箱验证码缓存时间一致）。只有当邮箱获取时间过后（此时后端的缓存消失），才能再次获取。这样就有效避免了恶意注册。

四，实现过程步骤

4.1，编写发送邮件业务

这里我们导入了SpringBoot集成邮箱功能的依赖后可以通过注入JavaMailSenderImpl对象来调用createMimeMessage()方法来生成MimeMessage类的对象，MimeMessage类是一个功能相当强大的邮件类，用来对邮件进行编码并发送。

package com.yy.util.mailUtil;


import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.mail.javamail.JavaMailSenderImpl;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import java.time.Duration;

/**
 * @author young
 * @date 2022/12/7 18:41
 * @description: 发送邮箱业务
 */
@Component
public class MailMsg {

    @Resource
    private JavaMailSenderImpl mailSender;
    @Autowired
    private RedisTemplate redisTemplate;

    public boolean mail(String email) throws MessagingException {

        MimeMessage mimeMessage = mailSender.createMimeMessage();
        //生成随机验证码
        String code = CodeGeneratorUtil.generateCode(6);
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);
        //设置一个html邮件信息
        helper.setText("
三秦锅，你在搞什么飞机！你的验证码为：" + code + "(有效期为一分钟)
", true);
        //设置邮件主题名
        helper.setSubject("FlowerPotNet验证码----验证码");
        //发给谁-》邮箱地址
        helper.setTo(email);
        //谁发的-》发送人邮箱
        helper.setFrom("[email protected]");
        //将邮箱验证码以邮件地址为key存入redis,1分钟过期
        redisTemplate.opsForValue().set(email, code, Duration.ofMinutes(1));
        mailSender.send(mimeMessage);
        return true;
    }
}

这里需要注意的是，发送人setFrom虽然可填的是字符串，但是必须要和yml配置文件中发送者邮箱一致，我们也可以用@Value("${spring.mail.username}")将配置信息读取过来，但是不能瞎填，不然邮件发送就会失败。

这里笔者自定义了一个随机验证码生成工具。

/**
 * @author young
 * @date 2022/10/18 16:30
 * @description: 生成验证码
 */
public class CodeGeneratorUtil {
    /**
     * 生成指定长度的验证码
     * @param length 长度
     * @return
     */
    public static String generateCode(int length){
       return UUID.randomUUID().toString().substring(0, length);
    }

    /**
     * 雪花算法生成用户注册的id
     */
    public static long snowflake(){
        return IdUtil.getSnowflakeNextId();
    }
}

业务逻辑也很简单，当controller层调用该业务时，就通过该方法生成6位数的随机验证码，然后将验证码放进邮箱构建类工具中去生成邮件，并将验证码信息以输入的邮箱地址为key，验证码为value存入redis缓存。时间与前端“获取邮箱验证码一致”，为一分钟。

接下来构建controller即可。

4.2，构建后端业务接口

@Api(tags = "登录操作相关接口")
@RestController
@Slf4j
public class LoginController {
    @Autowired
    private MailMsg mailMsg;

    @ApiOperation(value = "发送邮箱验证码")
    @GetMapping(value = "sendEmail/{email}")
    @CostTime //aop自定义注解，监控接口执行时间
    public Result