Spring Boot实现邮件注册功能示例代码

程序员文章站 2024-02-24 16:22:46

注册流程 1.[前端] 用户在注册页面提交注册信息； 2.[后端] 校验用户提交的参数，有误直接返回错误信息，无误向下执行； 3.[后端] 随机生成一个id，...

注册流程

1.[前端] 用户在注册页面提交注册信息；

2.[后端] 校验用户提交的参数，有误直接返回错误信息，无误向下执行；

3.[后端] 随机生成一个id，将id作为key，用户信息作为value，存入redis，设置时长；

4.[后端] 生成激活链接，通过邮件系统发送邮件到用户邮箱

5.[前端] 用户点击上图的“确认注册”；

6.[后端] 校验value是否过期，校验邮箱是否已经注册，没有则保存用户信息到数据库，提示用户已经注册成功；

功能实现（逆向分析）

1、先看看邮件发送的实现 cn.ictgu.tools.mail.mailservice

package cn.ictgu.tools.mail;

import cn.ictgu.dao.model.user;
import com.alibaba.fastjson.jsonobject;
import lombok.extern.log4j.log4j;
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.service;

import javax.mail.messagingexception;
import javax.mail.internet.mimemessage;

/**
 * 邮件服务
 * created by silence on 2017/3/11.
 */
@service
@log4j
public class mailservice {

 @autowired
 private javamailsender mailsender;

 @value("${spring.mail.username}")
 private string from;

 private static final string title_sign_up = "[邮件标题]";

 private static final string content = "[邮件内容]";

 public void uservalidate(user user, string token){
 mimemessage mailmessage = mailsender.createmimemessage();
 try {
  mimemessagehelper helper = new mimemessagehelper(mailmessage, true, "gbk");
  helper.setfrom(from);
  helper.setto(user.getemail());
  helper.setsubject(title_sign_up);
  string link = "http://www.ictgu.cn/validate/" + token;
  string message = string.format(content, user.getnickname(), link, link, user.getemail());
  helper.settext(message, true);
  mailsender.send(mailmessage);
 } catch (messagingexception e) {
  log.error("发送邮件失败：user:" + jsonobject.tojsonstring(user) + ", token: " + token);
 }

 }

说明：发送邮件需要传入2个参数 user 和 token，user即为用户注册信息，token是一个随机的uuid，redis中有与之对应的key，其value是user的json字符串。（key的规则是配置文件redis.prefix.signup + uuid）

邮件模板问题：

邮件内容的本质是一段字符串，样式由html+css控制，开发时，在邮箱设计好模板，变量用%s代替，然后将整段字符串存放在一个合适的地方，发送邮件时，使用string.format()方法将%s替换为实际值，就生成了最终用户看到邮件。所以没有必要使用第三方模板，添加jar包会增加系统的复杂度，同样的功能，能简化的尽量简化。

2、如何生成token呢？请看 cn.ictgu.redis.redistokenmanager

 public string gettokenofsignup(user user){
 string token = uuid.randomuuid().tostring();
 string value = jsonobject.tojsonstring(user);
 stringredistemplate.opsforvalue().set(signupprefix + token, value);
 stringredistemplate.expire(signupprefix + token, 12, timeunit.hours);
 return token;
 }

说明：uuid.randomuuid().tostring()是javajdk提供的一个自动生成主键的方法。uuid(universally unique identifier)全局唯一标识符,是指在一台机器上生成的数字，它保证对在同一时空中的所有机器都是唯一的，是由一个十六位的数字组成,表现出来的形式。由以下几部分的组合：当前日期和时间(uuid的第一个部分与时间有关，如果你在生成一个uuid之后，过几秒又生成一个uuid，则第一个部分不同，其余相同)，时钟序列，全局唯一的ieee机器识别号（如果有网卡，从网卡获得，没有网卡以其他方式获得），uuid的唯一缺陷在于生成的结果串会比较长。

3、token有了，就需要在service层关联user和token发送邮件啦，看看 cn.ictgu.dao.service.userservice

 public boolean signup(user user){
 string email = user.getemail();
 if (existemail(email)){
  log.error("用户注册，邮箱已注册:" + email);
  return false;
 }
 sendvalidateemail(user);
 return true;
 }

 @async
 private void sendvalidateemail(user user){
 string token = tokenmanager.gettokenofsignup(user);
 log.error("用户注册，准备发送邮件：user:" + jsonobject.tojsonstring(user) + ", token: " + token);
 mailservice.uservalidate(user, token);
 }

 private boolean existemail(string email){
 return mapper.selectbyemail(email) != null;
 }

说明：发送邮件耗时较长，使用异步来做，提高用户体验

4、user就简单了

@restcontroller
public class userapi {

 @autowired
 private userservice userservice;

 @requestmapping(value = "/sign-up", method = requestmethod.post)
 public simpleresponse signup(httpservletrequest request){
 user user = createuser(request);
 simpleresponse response = checksignuprequest(user);
 if (response.getcode() == 100){
  if (!userservice.signup(user)){
  response.setcode(200);
  response.setmessage("此邮箱已注册，请勿重复注册！");
  return response;
  }else {
  response.setmessage("注册激活邮件已发送至您邮箱，请在12小时内激活完成注册！");
  return response;
  }
 }
 return response;
 }

 private simpleresponse checksignuprequest(user user){
 simpleresponse response = new simpleresponse();
 string email = user.getemail();
 if (!checkutils.checkemail(email)){
  response.setcode(200);
  response.setmessage("邮箱格式不合法");
  return response;
 }
 string password = user.getpassword();
 if (!checkutils.checkpassword(password)){
  response.setcode(200);
  response.setmessage("密码长度必须为8-16位，且必须包含数字和字母");
  return response;
 }
 string nickname = user.getnickname();
 if (!checkutils.checknickname(nickname)){
  response.setcode(200);
  response.setmessage("昵称长度不合法");
  return response;
 }
 response.setcode(100);
 return response;
 }

}

说明：这一层主要做了用户注册参数的校验

效果图

Spring Boot实现邮件注册功能示例代码