Spring-Boot-全棧開發：漂亮的郵件註冊

時間 2020-03-08

原文原文鏈接

效果圖

註冊流程

1.[前端] 用戶在註冊頁面提交註冊信息；
2.[後端] 校驗用戶提交的參數，有誤直接返回錯誤信息，無誤向下執行；
3.[後端] 隨機生成一個ID，將ID做爲key，用戶信息做爲value，存入redis，設置時長；
4.[後端] 生成激活連接，經過郵件系統發送郵件到用戶郵箱
5.[前端] 用戶點擊上圖的「確認註冊」；
6.[後端] 校驗value是否過時，校驗郵箱是否已經註冊，沒有則保存用戶信息到數據庫，提示用戶已經註冊成功；css

功能實現（逆向分析）

一、先看看郵件發送的實現 cn.ictgu.tools.mail.MailServicehtml

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包會增長系統的複雜度，一樣的功能，能簡化的儘可能簡化。

二、如何生成Token呢？請看 cn.ictgu.redis.RedisTokenManagerjava

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的惟一缺陷在於生成的結果串會比較長。git

三、token有了，就須要在service層關聯user和token發送郵件啦，看看 cn.ictgu.dao.service.UserServicegithub

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;
  }

說明：發送郵件耗時較長，使用異步來作，提升用戶體驗redis

四、user就簡單了spring

@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;
  }

}

說明：這一層主要作了用戶註冊參數的校驗數據庫