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

效果圖

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

註冊流程

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

功能實現(逆向分析)

1、先看看郵件發送的實現 cn.ictgu.tools.mail.MailService

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

}/<code>

說明:發送郵件需要傳入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

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

說明:UUID.randomUUID().toString()是javaJDK提供的一個自動生成主鍵的方法。UUID(Universally Unique Identifier)全局唯一標識符,是指在一臺機器上生成的數字,它保證對在同一時空中的所有機器都是唯一的,是由一個十六位的數字組成,表現出來的形式。由以下幾部分的組合:當前日期和時間(UUID的第一個部分與時間有關,如果你在生成一個UUID之後,過幾秒又生成一個UUID,則第一個部分不同,其餘相同),時鐘序列,全局唯一的IEEE機器識別號(如果有網卡,從網卡獲得,沒有網卡以其他方式獲得),UUID的唯一缺陷在於生成的結果串會比較長。

3、token有了,就需要在service層關聯user和token發送郵件啦,看看 cn.ictgu.dao.service.UserService

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

說明:發送郵件耗時較長,使用異步來做,提高用戶體驗

4、user就簡單了

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

}/<code>

說明:這一層主要做了用戶註冊參數的校驗

回顧

從下往上看,從用戶註冊到郵件發送就實現了,大部分代碼都是做的參數校驗,因為用戶行為是不可信的,要構建安全的後臺系統,就要無死角的校驗校驗。。。。

Github地址

地址: github.com/ChinaSilenc…


作者:泥瓦匠
鏈接:https://juejin.im/post/5e6306fee51d4526ed66bfd9


分享到:


相關文章: