SpringBoot 邮件找回密码功能实现

avatar 2018年02月26日23:25:13 8 6352 views
博主分享免费Java教学视频，B站账号：Java刘哥 ，长期提供技术问题解决、项目定制：本站商品点此
之前写了一篇文章 SpringBoot 发送邮件，本文介绍 SpringBoot 找回密码功能。


一、效果图


1、找回密码页面

http://localhost:8080/login?action=lostpass



可以输入用户名或电子邮箱，两者在都是 unique 的字段

2、显示信息

http://localhost:8080/lostpass

如果用户名或邮箱不存在





如果用户名或邮箱存在





3、用户存在，接受邮件

打开qq邮箱，可以看到有一封邮件



如果没收到，可以垃圾箱里有没有



打开邮件，可以看如下





4、显示重置密码页面

http://localhost:8080/resetpass?sid=fea52cfa44c7c11d75e1194986c290fd&account=saysky





具体代码如下

二、邮件发送基本功能实现


这里主要是介绍邮箱找回密码的功能实现，所以只贴出一些比较关键的代码

1、pom.xml
  1. <!--邮件-->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-mail</artifactId>
  5. </dependency>



2、application.properties
  1. #qq企业邮箱
  2. spring.mail.host=smtp.exmail.qq.com
  3. spring.mail.username=master@liuyanzhao.com
  4. spring.mail.password=密码
  6. spring.mail.properties.smtp.auth=true
  7. spring.mail.properties.smtp.starttls.enable=true
  8. spring.mail.properties.smtp.starttls.required=true
  9. spring.mail.properties.mail.smtp.ssl.enable=true



3、MailService.java 邮件发送
  1. package com.liuyanzhao.chuyun.service;
  3. import ch.qos.logback.classic.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.beans.factory.annotation.Value;
  7. import org.springframework.core.io.FileSystemResource;
  8. import org.springframework.mail.SimpleMailMessage;
  9. import org.springframework.mail.javamail.JavaMailSender;
  10. import org.springframework.mail.javamail.MimeMessageHelper;
  11. import org.springframework.stereotype.Service;
  13. import javax.mail.MessagingException;
  14. import javax.mail.internet.MimeMessage;
  15. import java.io.File;
  17. /**
  18.  * @author 言曌
  19.  * @date 2018/2/6 下午8:25
  20.  */
  22. @Service
  23. public class MailService {
  25.     private final Logger logger = (Logger) LoggerFactory.getLogger(this.getClass());
  27.     @Autowired
  28.     private JavaMailSender sender;
  30.     @Value("${spring.mail.username}")
  31.     private String from;
  33.     /**
  34.      * 发送纯文本的简单邮件
  35.      * @param to
  36.      * @param subject
  37.      * @param content
  38.      */
  39.     public void sendSimpleMail(String to, String subject, String content){
  40.         SimpleMailMessage message = new SimpleMailMessage();
  41.         message.setFrom(from);
  42.         message.setTo(to);
  43.         message.setSubject(subject);
  44.         message.setText(content);
  46.         try {
  47.             sender.send(message);
  48.             logger.info("简单邮件已经发送。");
  49.         } catch (Exception e) {
  50.             logger.error("发送简单邮件时发生异常！", e);
  51.         }
  52.     }
  54.     /**
  55.      * 发送html格式的邮件
  56.      * @param to
  57.      * @param subject
  58.      * @param content
  59.      */
  60.     public void sendHtmlMail(String to, String subject, String content){
  61.         MimeMessage message = sender.createMimeMessage();
  63.         try {
  64.             //true表示需要创建一个multipart message
  65.             MimeMessageHelper helper = new MimeMessageHelper(message, true);
  66.             helper.setFrom(from);
  67.             helper.setTo(to);
  68.             helper.setSubject(subject);
  69.             helper.setText(content, true);
  71.             sender.send(message);
  72.             logger.info("html邮件已经发送。");
  73.         } catch (MessagingException e) {
  74.             logger.error("发送html邮件时发生异常！", e);
  75.         }
  76.     }
  78.     /**
  79.      * 发送带附件的邮件
  80.      * @param to
  81.      * @param subject
  82.      * @param content
  83.      * @param filePath
  84.      */
  85.     public void sendAttachmentsMail(String to, String subject, String content, String filePath){
  86.         MimeMessage message = sender.createMimeMessage();
  88.         try {
  89.             //true表示需要创建一个multipart message
  90.             MimeMessageHelper helper = new MimeMessageHelper(message, true);
  91.             helper.setFrom(from);
  92.             helper.setTo(to);
  93.             helper.setSubject(subject);
  94.             helper.setText(content, true);
  96.             FileSystemResource file = new FileSystemResource(new File(filePath));
  97.             String fileName = filePath.substring(filePath.lastIndexOf(File.separator));
  98.             helper.addAttachment(fileName, file);
  100.             sender.send(message);
  101.             logger.info("带附件的邮件已经发送。");
  102.         } catch (MessagingException e) {
  103.             logger.error("发送带附件的邮件时发生异常！", e);
  104.         }
  105.     }
  107.     /**
  108.      * 发送嵌入静态资源（一般是图片）的邮件
  109.      * @param to
  110.      * @param subject
  111.      * @param content 邮件内容，需要包括一个静态资源的id，比如：<img src=\"cid:rscId01\" >
  112.      * @param rscPath 静态资源路径和文件名
  113.      * @param rscId 静态资源id
  114.      */
  115.     public void sendInlineResourceMail(String to, String subject, String content, String rscPath, String rscId){
  116.         MimeMessage message = sender.createMimeMessage();
  118.         try {
  119.             //true表示需要创建一个multipart message
  120.             MimeMessageHelper helper = new MimeMessageHelper(message, true);
  121.             helper.setFrom(from);
  122.             helper.setTo(to);
  123.             helper.setSubject(subject);
  124.             helper.setText(content, true);
  126.             FileSystemResource res = new FileSystemResource(new File(rscPath));
  127.             helper.addInline(rscId, res);
  129.             sender.send(message);
  130.             logger.info("嵌入静态资源的邮件已经发送。");
  131.         } catch (MessagingException e) {
  132.             logger.error("发送嵌入静态资源的邮件时发生异常！", e);
  133.         }
  134.     }
  137. }


三、找回密码核心实现


1、MailRetrieve
  1. package com.liuyanzhao.chuyun.entity;
  3. import javax.persistence.*;
  5. /**
  6.  * @author 言曌
  7.  * @date 2018/2/23 上午10:24
  8.  */
  10. @Entity
  11. @Table(name = "mail_retrieve")
  12. public class MailRetrieve{
  13.     private static final long serialVersionUID = -1L;
  14.     @Id
  15.     @GeneratedValue(strategy = GenerationType.AUTO)
  16.     private long id;
  18.     @Column(name = "account", nullable = true, length = 100)
  19.     private String account;
  21.     @Column(name = "sid", nullable = true, length = 255)
  22.     private String sid;
  24.     @Column(name = "out_time", nullable = true, length = 100)
  25.     private long outTime;
  27.     public MailRetrieve() {
  28.     }
  30.     public MailRetrieve(String account, String sid, long outTime) {
  31.         this.account = account;
  32.         this.sid = sid;
  33.         this.outTime = outTime;
  34.     }
  36.     public static long getSerialVersionUID() {
  37.         return serialVersionUID;
  38.     }
  40.     public long getId() {
  41.         return id;
  42.     }
  44.     public void setId(long id) {
  45.         this.id = id;
  46.     }
  49.     public MailRetrieve(String account) {
  50.         this.account = account;
  51.     }
  53.     public String getSid() {
  54.         return sid;
  55.     }
  57.     public void setSid(String sid) {
  58.         this.sid = sid;
  59.     }
  61.     public long getOutTime() {
  62.         return outTime;
  63.     }
  65.     public void setOutTime(long outTime) {
  66.         this.outTime = outTime;
  67.     }
  68. }



2、MailRetrieveRepository
  1. package com.liuyanzhao.chuyun.repository;
  3. import com.liuyanzhao.chuyun.entity.MailRetrieve;
  4. import org.springframework.data.jpa.repository.JpaRepository;
  6. /**
  7.  * @author 言曌
  8.  * @date 2018/2/23 上午10:40
  9.  */
  11. public interface MailRetrieveRepository extends JpaRepository<MailRetrieve, Long> {
  13.     /**
  14.      * 根据账号查找用户
  15.      *
  16.      * @param account
  17.      * @return
  18.      */
  19.     MailRetrieve findByAccount(String account);
  20. }



3、MailRetrieveService
  1. package com.liuyanzhao.chuyun.service;
  3. import com.liuyanzhao.chuyun.vo.ResultVO;
  5. /**
  6.  * 邮件找回密码Service
  7.  *
  8.  * @author 言曌
  9.  * @date 2018/2/23 上午10:27
  10.  */
  12. public interface MailRetrieveService {
  14.     /**
  15.      * 找回密码
  16.      *
  17.      * @param basePath
  18.      * @param account
  19.      * @return
  20.      */
  21.     public ResultVO generateMailUrl(String basePath, String account);
  23.     /**
  24.      * 邮件找回密码URL校验
  25.      * @param sid
  26.      * @param account
  27.      * @return
  28.      */
  29.     public ResultVO verifyMailUrl(String sid, String account);
  30. }



4、MailRetrieveServiceImpl
  1. package com.liuyanzhao.chuyun.service.impl;
  3. import com.liuyanzhao.chuyun.entity.MailRetrieve;
  4. import com.liuyanzhao.chuyun.entity.User;
  5. import com.liuyanzhao.chuyun.repository.MailRetrieveRepository;
  6. import com.liuyanzhao.chuyun.repository.UserRepository;
  7. import com.liuyanzhao.chuyun.service.MailRetrieveService;
  8. import com.liuyanzhao.chuyun.util.MD5Util;
  9. import com.liuyanzhao.chuyun.util.RandomUtil;
  10. import com.liuyanzhao.chuyun.vo.ResultVO;
  11. import com.sun.jmx.snmp.Timestamp;
  12. import org.springframework.beans.factory.annotation.Autowired;
  13. import org.springframework.stereotype.Service;
  16. /**
  17.  * @author 言曌
  18.  * @date 2018/2/23 上午10:30
  19.  */
  21. @Service
  22. public class MailRetrieveServiceImpl implements MailRetrieveService {
  24.     @Autowired
  25.     private UserRepository userRepository;
  27.     @Autowired
  28.     private MailRetrieveRepository mailRetrieveRepository;
  30.     /**
  31.      * 生成链接
  32.      * @param basePath
  33.      * @param account
  34.      * @return
  35.      */
  36.     @Override
  37.     public ResultVO generateMailUrl(String basePath, String account) {
  38.         User user = userRepository.findByUsername(account);
  39.         ResultVO resultVO = new ResultVO();
  40.         //用户名不存在
  41.         if (user == null) {
  42.             resultVO.setCode("001");
  43.             resultVO.setMsg("用户不存在");
  44.         } else {
  45.             //生成邮件URL唯一地址
  46.             String key = RandomUtil.getRandom(6) + "";
  47.             Timestamp outDate = new Timestamp(System.currentTimeMillis() + (long) (30 * 60 * 1000));//30分钟后过期
  48.             long outtimes = outDate.getSysUpTime();
  49.             String sid = account + "&" + key + "&" + outtimes;
  50.             MailRetrieve mailRetrieve = new MailRetrieve(account, MD5Util.encode(sid), outtimes);
  51.             MailRetrieve findMailRetrieve = mailRetrieveRepository.findByAccount(account);
  52.             if (findMailRetrieve != null) {
  53.                 mailRetrieveRepository.delete(findMailRetrieve);
  54.             }
  55.             mailRetrieveRepository.save(mailRetrieve);
  56.             resultVO.setCode("005");
  57.             resultVO.setMsg("邮件重置密码");
  58.             resultVO.setData(basePath + "resetpass?sid=" + MD5Util.encode(sid) + "&username=" + account);
  59.         }
  61.         return resultVO;
  62.     }
  64.     /**
  65.      * 验证链接
  66.      * @param sid
  67.      * @param username
  68.      * @return
  69.      */
  70.     @Override
  71.     public ResultVO verifyMailUrl(String sid, String username) {
  72.         ResultVO resultVO = new ResultVO();
  73.         MailRetrieve mailRetrieve = mailRetrieveRepository.findByAccount(username);
  74.         if(mailRetrieve != null) {
  75.             long outTime = mailRetrieve.getOutTime();
  76.             Timestamp outDate = new Timestamp(System.currentTimeMillis());
  77.             long nowTime = outDate.getSysUpTime();
  78.             System.out.println("nowTime:" + nowTime);
  79.             if (outTime <= nowTime) {
  80.                 resultVO.setCode("006");
  81.                 resultVO.setMsg("邮件已经过期！");
  82.             } else if ("".equals(sid)) {
  83.                 resultVO.setCode("007");
  84.                 resultVO.setMsg("sid不完整！");
  85.             } else if (!sid.equals(mailRetrieve.getSid())) {
  86.                 resultVO.setCode("008");
  87.                 resultVO.setMsg("sid错误！");
  88.             } else {
  89.                 resultVO.setCode("000");
  90.                 resultVO.setMsg("验证成功！");
  91.             }
  92.         } else {
  93.             //account 对应的用户不存在
  94.             resultVO.setCode("002");
  95.             resultVO.setMsg("链接无效！");
  97.         }
  98.         return resultVO;
  99.     }
  100. }



5、LoginController
  1. package com.liuyanzhao.chuyun.controller;
  3. import com.liuyanzhao.chuyun.entity.Authority;
  4. import com.liuyanzhao.chuyun.entity.User;
  5. import com.liuyanzhao.chuyun.repository.MailRetrieveRepository;
  6. import com.liuyanzhao.chuyun.repository.UserRepository;
  7. import com.liuyanzhao.chuyun.service.AuthorityService;
  8. import com.liuyanzhao.chuyun.service.MailRetrieveService;
  9. import com.liuyanzhao.chuyun.service.MailService;
  10. import com.liuyanzhao.chuyun.service.UserService;
  11. import com.liuyanzhao.chuyun.util.BCryptUtil;
  12. import com.liuyanzhao.chuyun.util.QQUtil;
  13. import com.liuyanzhao.chuyun.util.RegexUtil;
  14. import com.liuyanzhao.chuyun.vo.ResultVO;
  15. import org.springframework.beans.factory.annotation.Autowired;
  17. import org.springframework.stereotype.Controller;
  18. import org.springframework.web.bind.annotation.GetMapping;
  19. import org.springframework.web.bind.annotation.PostMapping;
  20. import org.springframework.web.bind.annotation.RequestParam;
  21. import org.springframework.web.servlet.ModelAndView;
  23. import javax.servlet.http.HttpServletRequest;
  25. /**
  26.  * @author 言曌
  27.  * @date 2018/2/23 下午5:31
  28.  */
  30. @Controller
  31. public class LoginController {
  36.     @Autowired
  37.     private UserRepository userRepository;
  39.     @Autowired
  40.     private UserService userService;
  42.     @Autowired
  43.     private MailRetrieveService mailRetrieveService;
  45.     @Autowired
  46.     private MailService mailService;
  49.     /**
  50.      * 登录页面显示
  51.      *
  52.      * @return
  53.      */
  54.     @GetMapping("/login")
  55.     public String login(@RequestParam(value = "action", required = false) String action) {
  56.         //登录
  57.         if (action == null) {
  58.             return "login";
  59.         }
  60.         //注册
  61.         else if ("register".equals(action)) {
  62.             return "forward:/register";
  63.         }
  64.         //忘记密码
  65.         else if ("lostpass".equals(action)) {
  66.             return "forward:/lostpass";
  67.         }
  68.         //设置密码
  69.         else if ("resetpass".equals(action)) {
  70.             return "forward:/resetpass";
  71.         }
  72.         //退出登录
  73.         else if ("logout".equals(action)) {
  74.             return "forward:/logout";
  75.         }
  76.         //其他
  77.         else {
  78.             return "login";
  79.         }
  80.     }
  83.     /**
  84.      * 忘记密码页面显示
  85.      *
  86.      * @return
  87.      */
  88.     @GetMapping(value = "/lostpass")
  89.     public ModelAndView forget() {
  90.         ModelAndView modelAndView = new ModelAndView("login");
  91.         modelAndView.addObject("action", "lostpass");
  92.         modelAndView.addObject("message", "请输入您的用户名或电子邮箱地址。您会收到一封包含创建新密码链接的电子邮件。");
  93.         return modelAndView;
  94.     }
  97.     /**
  98.      * 忘记密码提交,然后跳转登录页面
  99.      *
  100.      * @param request
  101.      * @param account
  102.      * @return
  103.      */
  104.     @PostMapping(value = "/lostpass")
  105.     public ModelAndView forgetUser(HttpServletRequest request, String account) {
  106.         ModelAndView modelAndView = new ModelAndView("login");
  107.         String username = "";
  108.         //1、获取用户名 username
  109.         if (RegexUtil.isEmail(account)) {
  110.             User user = userRepository.findByEmail(account);
  111.             if (user != null) {
  112.                 username = user.getUsername();
  113.             }
  114.         } else {
  115.             //account 是用户名
  116.             username = account;
  117.         }
  118.         User user = userRepository.findByUsername(username);
  119.         //2、判断用户是否存在
  120.         if(user != null) {
  121.             //用户存在
  122.             //2.1、生成链接
  123.             String path = request.getContextPath();
  124.             String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + path + "/";
  125.             ResultVO resultVO = mailRetrieveService.generateMailUrl(basePath, username);
  126.             String mailUrl = resultVO.getData().toString();
  127.             //2.2、发送邮件
  128.             String receiver = user.getEmail();//接收者
  129.             String subject = "[Spring Blog]密码重置";//邮件主题(标题)
  130.             StringBuilder content = new StringBuilder();
  131.             content.append("有人为以下账号请求了密码重置：<br/><br/>");
  132.             content.append("<a href=" + basePath + " target=\"_blank\">" + basePath + "</a><br/><br/>");
  133.             content.append("用户名：" + username + "<br/><br/>");
  134.             content.append("若这不是您本人要求的，请忽略本邮件，一切如常。<br/><br/>");
  135.             content.append("要重置您的密码，请打开下面的链接(如果邮箱对链接拦截，请复制链接在地址栏中打开，30分钟内有效)：<br/><br/>");
  136.             content.append("<a href=" + mailUrl + " target=\"_blank\">" + mailUrl + "</a><br/><br/>");
  137.             mailService.sendHtmlMail(receiver, subject, content.toString());
  138.             //2.3、显示登录页面和提示信息
  139.             modelAndView.addObject("checkmail", "请在您的电子邮箱中检查确认链接。");
  140.         } else {
  141.             //用户不存在
  142.             //2.1、 显示找回密码页面，和错误信息
  143.             modelAndView.addObject("error","用户名或邮箱不存在！");
  144.             modelAndView.addObject("action","lostpass");
  145.         }
  146.         return modelAndView;
  147.     }
  149.     /**
  150.      * 重置密码验证
  151.      * 验证通过，显示修改密码页面
  152.      *
  153.      * @param sid
  154.      * @param username
  155.      * @return
  156.      */
  157.     @GetMapping(value = "/resetpass")
  158.     public ModelAndView verifyMail(String sid, String username) {
  159.         ModelAndView modelAndView = new ModelAndView("login");
  161.         ResultVO resultVO = mailRetrieveService.verifyMailUrl(sid, username);
  162.         //验证通过,显示设置密码页面
  163.         if ("000".equals(resultVO.getCode())) {
  164.             modelAndView.addObject("action", "resetpass");
  165.             modelAndView.addObject("username", username);
  166.             modelAndView.addObject("sid", sid);
  167.         } else {
  168.             //链接无效，显示找回密码页面
  169.             modelAndView.addObject("action", "lostpass");
  170.             //显示错误信息
  171.             modelAndView.addObject("error", resultVO.getMsg());
  172.         }
  173.         return modelAndView;
  174.     }
  176.     /**
  177.      * 重置密码提交
  178.      *
  179.      * @param sid      根据用户sid来查询用户名
  180.      * @param password
  181.      * @return
  182.      */
  183.     @PostMapping(value = "/resetpass")
  184.     public ModelAndView resetPass(String sid, String username, String password) {
  185.         ModelAndView modelAndView = new ModelAndView("login");
  186.         ResultVO resultVO = mailRetrieveService.verifyMailUrl(sid, username);
  187.         //如果验证通过(防止用户自定义表单，再次验证)
  188.         if ("000".equals(resultVO.getCode())) {
  189.             //修改密码
  190.             User user = userService.getUserByUsername(username);
  191.             user.setPassword(BCryptUtil.encode(password));
  192.             userService.updateUser(user);
  193.         }
  194.         //验证失败
  195.         else {
  196.             //显示找回密码页面
  197.             modelAndView.addObject("action", "lostpass");
  198.             //显示错误信息
  199.             modelAndView.addObject("error", "用户名或sid不正确");
  201.         }
  202.         return modelAndView;
  203.     }
  205. }

删掉了多余的代码



6、login.html

找回密码
  1. <div id="lostpass-block" th:case="lostpass">
  2.         <p class="message" th:if="${message}" th:text="${message}"></p>
  3.         <div id="login_error" th:if="${error}" >
  4.             <span th:text="${error}"></span>请重新申请。
  5.         </div>
  7.         <form name="forgetForm" th:action="@{/lostpass}" id="forgetForm" method="post">
  8.             <p>
  9.                 <label for="account">用户名或电子邮件地址<br/>
  10.                     <input type="text" name="account" id="account" class="input" value="" size="20"/>
  11.                 </label>
  12.             </p>
  13.             <br>
  14.             <p class="submit">
  15.                 <input type="submit" value="获取新密码"/>
  16.             </p>
  17.         </form>
  19.     </div>



设置密码
  1. <div id="resetpass-block" th:case="resetpass">
  2.         <p class="message reset-pass">请在下方输入您的新密码。</p>
  4.         <div id="login_error" th:if="${message}" th:text="${message}"></div>
  6.         <form name="resetpassform" id="resetpassform" th:action="@{/resetpass}"
  7.               method="post" autocomplete="off">
  9.             <p>
  10.                 <label for="username"><strong>新密码</strong><br/>
  11.                     <input type="text" name="password" id="password" class="input" value="" size="20"/>
  12.                 </label>
  13.             </p>
  14.             <p class="description indicator-hint" style="margin-top: 10px;">正在为用户名为 <strong th:text="${username}"></strong> 的用户重置密码</p>
  15.             <br class="clear">
  16.             <input type="hidden" name="username" th:value="${username}">
  17.             <input type="hidden" name="sid" th:value="${sid}">
  18.             <p class="submit">
  19.                 <input type="submit" value="重置密码">
  20.             </p>
  21.         </form>
  23.     </div>





本文地址：https://liuyanzhao.com/7586.html







历史上的今天
February
26日
  • 微信
  • 交流学习，资料分享
  • weinxin
  • 个人淘宝
  • 店铺名：言曌博客咨询部

  • (部分商品未及时上架淘宝)
avatar

发表评论

avatar 登录者：匿名
匿名评论，评论回复后会有邮件通知

  

已通过评论：1   待审核评论数：0
  1. avatar 1111111111111
    回复 2019年01月09日 21:54:42

    aaaaaaaaaaa啊