Spring Boot郵箱鏈接注冊驗證

簡單介紹

注冊流程
【1】前端提交注冊信息
【2】后端接受數據
【3】后端生成一個UUID做為token,將token作為redis的key值，用戶數據作為redis的value值，並設置key的時長
【4】后端根據用戶信息中的郵箱地址信息，檢驗用戶是否已經注冊，如果沒有，生成注冊鏈接發送到用戶郵箱，如果已經注冊，提示用戶該郵箱地址已被注冊
【5】用戶點擊郵件中的注冊鏈接
【6】后端判斷redis中token是否過期，沒有將用戶信息保存到數據庫，提示用戶注冊成功
項目源碼：https://gitee.com/residual-temperature/email-link-demo.git
郵箱效果圖
郵箱鏈接

實現過程

1、pom文件要加入的jar包

 	   <!-- 郵件相關 -->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-mail</artifactId>
       </dependency>

       <!-- redis相關 -->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-data-redis</artifactId>
       </dependency>

2、application.yml文件中要加入的配置

spring:        
  redis:
    host:     # redis地址
    port: 6379   # redis端口號（默認6379）
    password:     # redis密碼
  mail:
    host: smtp.qq.com    # 郵箱協議
    username: 地址          # 發送的郵箱地址
    password:  授權碼      # 郵箱的授權碼

3、定義實體類


@Repository
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
  private long id;
  private String account;
  private String password;
  private String username;
  
}

注意

此處沒有get(),set()方法是因為導入了lombok包

4、redis的config配置
對象的保存需要序列化，所以需要自定義RedisTemplete


@Configuration
public class RedisConfig {
    //編寫自己的配置類
    @Bean
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        //為了開發方便一般使用<String,Object>
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        //JSON序列化的配置
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        //String的序列化
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        //key采用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);

        //hash采用String的序列方式
        template.setHashKeySerializer(stringRedisSerializer);

        //value序列化采用jackson
        template.setValueSerializer(jackson2JsonRedisSerializer);

        //hash的Value序列化采用jackson
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }
}

5、驗證鏈接生成和郵箱發送的工具類CodeUtils的配置

@Component
public class CodeUtils {

    @Resource
    JavaMailSender mailSender;

    @Resource
    RedisTemplate<String, User> redisTemplate;

    // 生成鏈接,並給接收的郵箱發送郵件
    public boolean sendCode(User user){
        MimeMessage message = mailSender.createMimeMessage();
        try{
            MimeMessageHelper messageHelper = new MimeMessageHelper(message);
            String token = UUID.randomUUID().toString(); // 生成UUID
            redisTemplate.opsForValue().set(token,user);
            redisTemplate.expire(token,300, TimeUnit.SECONDS);
            messageHelper.setFrom("發送方的郵箱地址"); //發送方的郵箱地址，而不是接收方的郵箱地址
            messageHelper.setTo(user.getAddress()); // 接收方的郵箱地址
            messageHelper.setSubject("注冊");  // 郵箱標題
            String html = "<html>\n" +
                    "<body>\n" +
                    "<p>請點擊下方鏈接注冊</p>\n" +
                    "<a href=\"http://localhost:8081/lookCode/"+token+"\">http://localhost:8081/lookCode/"+token+"</a>" +
                    "</body>\n" +
                    "</html>";
            messageHelper.setText(html,true); // 郵箱內容
            mailSender.send(message);  // 發送郵箱
            System.out.println("發送成功");
            return true;
        }catch (Exception e){
            System.out.println("發送失敗");
            return false;
        }
    }

    // 判斷token是否過期
    public boolean eqToken(String token){
        return redisTemplate.hasKey(token);
    }

    // 根據token查詢用戶的信息
    public User findUser(String token){
        return redisTemplate.opsForValue().get(token);
    }

}

6、UserMapper的配置

@Mapper
@Repository
public interface UserMapper {

    // 添加用戶 注解開發sql語句
    @Insert("insert into user(account,password,username) values (#{account},#{password},#{username})")
    public int addUser(User user);

}

7、UserService的配置

public interface UserService {

    // 添加用戶
    public boolean adduser(User user);

    // 根據用戶注冊信息進行注冊鏈接的的生成和發送
    public boolean sendCode(User user);

    // 用戶點擊注冊鏈接判斷token是否過期
    public boolean eqToken(String token);

}

8、UserService的實現類UserServiceImpl的配置

@Service
public class UserServiceImpl implements UserService {

    @Resource
    UserMapper userMapper;

    @Resource
    CodeUtils codeUtils;

    /**
     * 添加注冊的用戶信息
     * @param user 注冊的用戶信息
     * @return 是否添加成功
     */
    @Override
    public boolean adduser(User user) {
        return userMapper.addUser(user) > 0;
    }

    /**
     * 生成鏈接和發送鏈接
     * @param address 接收的郵箱地址
     * @param user 注冊的用戶信息
     */
    @Override
    public boolean sendCode(User user) {
       if ( codeUtils.sendCode(user)) // 調用驗證鏈接生成工具類中的生成鏈接和發送郵件函數
           return true;
       else
           return false;
    }

    /**
     * 判斷token是否過期
     * @param token 用戶注冊所接收的token
     * @return 注冊成功與否
     */
    @Override
    public boolean eqToken(String token) {
        boolean flag = codeUtils.eqToken(token);

        if (flag){
            User user = codeUtils.findUser(token);
            adduser(user);
            return true;
        }else {
            return false;
        }
    }
}

9、UserController的配置

@RestController
public class UserController {

    @Resource
    UserService userService;

    // 根據用戶注冊信息進行注冊鏈接的的生成和發送
    @PostMapping("/sendCode")
    public Map<String,String> sendCode(@RequestBody User user){
        boolean flag = userService.sendCode(user);
        Map<String,String> map = new HashMap<>();
        if (flag){
            map.put("msg","郵件發送成功，請前往您的郵箱進行注冊驗證");
            return map;
        }else {
            map.put("msg","郵件發送失敗");
            return map;
        }
    }

    // 判斷是否注冊成功
    @GetMapping("/lookCode/{token}")
    public Map<String,String> lookCode(@PathVariable("token")String token){
        boolean flag = userService.eqToken(token);
        Map<String,String> map = new HashMap<>();
        if (flag){
            map.put("msg","注冊成功");
            /* 后續的操作 ... ...*/
            return map;
        }else {
            map.put("msg","注冊碼過期，請重新注冊");
            return map;
        }
    }
}