devbox
小蓝xlanll
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

基于SpringBoot实现邮箱验证码注册_springboot邮箱注册

作者：小蓝xlanll | 2024-06-07 17:27:05

赞

踩

springboot邮箱注册

目录

一、简介

二、代码实现

1. 添加pom依赖

2. 创建邮件发送信息传输类、授权信息类

3. 创建邮箱服务接口和实现类

4. 修改配置文件application.yml，添加相关配置信息

5. 创建邮件模板

6. 创建功能服务接口与实现类

7. 编写Controller层API接口

三、结果演示

1. 发送邮箱验证码接口

2. 注册账号接口

3. 验证码邮件示例​编辑

一、简介

        用户注册系统时，一般会以邮箱进行关联注册，需要用户输入邮箱地址以获取随机验证码，然后在注册页面输入该验证码并完善其他相关注册信息点击注册，完成注册。

        基于SpringBoot的后端开发项目实现的逻辑分为两步：

  1. 向邮箱发送随机验证码；
  2. 收到用户输入验证码进行校验完成注册；

二、代码实现

1. 添加pom依赖

  1.     <!-- spring data redis 依赖 -->
  2.     <dependency>
  3.       <groupId>org.springframework.boot</groupId>
  4.       <artifactId>spring-boot-starter-data-redis</artifactId>
  5.     </dependency>
  6.     <!-- hutool工具包依赖-->
  7.     <dependency>
  8.       <groupId>cn.hutool</groupId>
  9.       <artifactId>hutool-all</artifactId>
  10.       <version>5.5.7</version>
  11.     </dependency>
  12.     <!--  mail依赖-->
  13.     <dependency>
  14.       <groupId>javax.mail</groupId>
  15.       <artifactId>mail</artifactId>
  16.       <version>1.4.7</version>
  17.     </dependency>
  18.     <!--  模板引擎依赖-->
  19.     <dependency>
  20.       <groupId>org.springframework.boot</groupId>
  21.       <artifactId>spring-boot-starter-freemarker</artifactId>
  22.     </dependency>

2. 创建邮件发送信息传输类、授权信息类

  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. public class EmailDto {
  5.  
  6.     /**
  7.      * 发送邮箱列表
  8.      */
  9.     private List<String> tos;
  10.  
  11.     /**
  12.      * 主题
  13.      */
  14.     private String subject;
  15.  
  16.     /**
  17.      * 内容
  18.      */
  19.     private String content;
  20.  
  21. }
  1. @ApiModel(value = "授权用户信息")
  2. @Data
  3. @AllArgsConstructor
  4. @NoArgsConstructor
  5. public class AuthUserDto {
  6.  
  7.  
  8.     @ApiModelProperty(value = "用户名")
  9.     private String username;
  10.  
  11.     @ApiModelProperty(value = "密码")
  12.     private String password;
  13.  
  14.     @ApiModelProperty(value = "临时登录凭证")
  15.     private String code;
  16.  
  17.     @ApiModelProperty(value = "邮箱")
  18.     private String email ;
  19.  
  20. }

3. 创建邮箱服务接口和实现类

  1. public interface EmailService {
  2.  
  3.     /**
  4.      * 发送邮件
  5.      *
  6.      * @param emailDto 邮箱列表
  7.      */
  8.     void send(EmailDto emailDto);
  9. }
  1. @Service
  2. @RequiredArgsConstructor
  3. public class EmailServiceImpl implements EmailService {
  4.  
  5.     @Value("${spring.mail.email}")
  6.     private String email;
  7.     @Value("${spring.mail.host}")
  8.     private String host;
  9.     @Value("${spring.mail.port}")
  10.     private String port;
  11.     @Value("${spring.mail.username}")
  12.     private String username;
  13.     @Value("${spring.mail.password}")
  14.     private String password;
  15.  
  16.     @Override
  17.     public void send(EmailDto emailDto) {
  18.  
  19.         // 读取邮箱配置
  20.         if (email == null || host == null || port == null || username == null || password == null) {
  21.             throw new RuntimeException("邮箱配置异常");
  22.         }
  23.  
  24.         // 设置
  25.         MailAccount account = new MailAccount();
  26.         account.setHost(host);
  27.         account.setPort(Integer.parseInt(port));
  28.         // 设置发送人邮箱
  29.         account.setFrom(username + "<" + email + ">");
  30.         // 设置发送人名称
  31.         account.setUser(username);
  32.         // 设置发送授权码
  33.         account.setPass(password);
  34.         account.setAuth(true);
  35.         // ssl方式发送
  36.         account.setSslEnable(true);
  37.         // 使用安全连接
  38.         account.setStarttlsEnable(true);
  39.  
  40.         // 发送邮件
  41.         try {
  42.             int size = emailDto.getTos().size();
  43.             Mail.create(account)
  44.                     .setTos(emailDto.getTos().toArray(new String[size]))
  45.                     .setTitle(emailDto.getSubject())
  46.                     .setContent(emailDto.getContent())
  47.                     .setHtml(true)
  48.                     //关闭session
  49.                     .setUseGlobalSession(false)
  50.                     .send();
  51.         } catch (Exception e) {
  52.             throw new RuntimeException(e.getMessage());
  53.         }
  54.  
  55.     }
  56. }

4. 修改配置文件application.yml，添加相关配置信息

  1. mail:
  2.     # 负责发送验证码的邮箱
  3.     email: XXXX@126.com
  4.     host: smtp.126.com
  5.     port: 465
  6.     username: XXXX
  7.     # 授权码是用于登录第三方邮件客户端的专用密码。
  8.     password: XXXXXXXXX
  9.  
  10.  
  11.  
  12. #邮箱验证码有效时间/秒
  13. code:
  14.   expiration: 300

此处授权密码需要在邮箱中申请配置，如下获取一个授权密码：【登录邮箱】-【设置】，springboot即可通过邮箱+授权码自动发送验证码邮件：

5. 创建邮件模板

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4.     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  5.     <style>
  6.         @page {
  7.             margin: 0;
  8.         }
  9.     </style>
  10. </head>
  11. <body>
  12. <div class="header">
  13.     <div style="padding: 10px;padding-bottom: 0px;">
  14.         <p style="margin-bottom: 10px;padding-bottom: 0px;">尊敬的用户，您好：</p>
  15.         <p style="text-indent: 2em; margin-bottom: 10px;">您正在注册【XXX平台】账号，您的验证码为：</p>
  16.         <p class="code-text">${code}</p>
  17.         <div class="footer">
  18.         </div>
  19.     </div>
  20. </div>
  21. </body>
  22. </html>
  23.  
  24. <style lang="css">
  25.     body {
  26.         margin: 0px;
  27.         padding: 0px;
  28.         font: 100% SimSun, Microsoft YaHei, Times New Roman, Verdana, Arial, Helvetica, sans-serif;
  29.         color: #000;
  30.     }
  31.  
  32.     .header {
  33.         height: auto;
  34.         width: 820px;
  35.         min-width: 820px;
  36.         margin: 0 auto;
  37.         margin-top: 20px;
  38.         border: 1px solid #eee;
  39.     }
  40.  
  41.     .code-text {
  42.         text-align: center;
  43.         font-family: Times New Roman;
  44.         font-size: 22px;
  45.         color: #C60024;
  46.         padding: 20px 0px;
  47.         margin-bottom: 10px;
  48.         font-weight: bold;
  49.         background: #ebebeb;
  50.     }
  51.  
  52.     .footer {
  53.         margin: 0 auto;
  54.         z-index: 111;
  55.         width: 800px;
  56.         margin-top: 30px;
  57.         border-top: 1px solid #DA251D;
  58.     }
  59. </style>

6. 创建功能服务接口与实现类

  1. public interface AuthService {
  2.  
  3.     /**
  4.      * 向指定邮箱发送验证码
  5.      *
  6.      * @param email 邮箱号
  7.      * @return 结果
  8.      */
  9.     RespBean sendMailCode(String email);
  10.  
  11.     /**
  12.      * 注册
  13.      *
  14.      * @param authUserDto 认证用户请求信息
  15.      * @return 是否成功
  16.      */
  17.     RespBean register(AuthUserDto authUserDto);
  18. }

 主要实现两个功能

  1. 向邮箱发送随机验证码；sendMailCode
  2. 收到用户输入验证码进行校验完成注册；register
  1. @Service
  2. @RequiredArgsConstructor
  3. @Transactional(propagation = Propagation.SUPPORTS, readOnly = true, rollbackFor = Exception.class)
  4. public class AuthServiceImpl implements AuthService {
  5.  
  6.     @Value("${code.expiration}")
  7.     private Long expiration;
  8.  
  9. //    private final IAdminService adminService;
  10. //    private final RedisUtils redisUtils;
  11.     private final EmailService emailService;
  12.     private final PasswordEncoder passwordEncoder;
  13.  
  14.     @Autowired
  15.     private RedisTemplate<String,Object> redisTemplate;
  16.     @Autowired
  17.     private AdminServiceImpl adminService;
  18.  
  19.     @Override
  20.     @Transactional(rollbackFor = Exception.class)
  21.     public RespBean register(AuthUserDto authUserDto) {
  22.         ValueOperations<String, Object> valueOperations = redisTemplate.opsForValue();
  23.         // 通过email获取redis中的code
  24.         Object value = valueOperations.get(authUserDto.getEmail());
  25.         if (value == null || !value.toString().equals(authUserDto.getCode())) {
  26.             return RespBean.error("无效验证码！");
  27.         }
  28.  
  29.         // 如果前端没有传入用户名，则以邮箱号作为用户名进行注册
  30.         String userName = StringUtils.isEmpty(authUserDto.getUsername()) ? authUserDto.getEmail() : authUserDto.getUsername();
  31.  
  32.         if (adminService.getAdminByUserName(userName) != null) {
  33.             return RespBean.error("用户名已存在！");
  34.         }
  35.  
  36.         // 创建用户
  37.         Admin admin = new Admin();
  38.         admin.setUsername(userName);
  39.         try {
  40.             admin.setPassword(passwordEncoder.encode(authUserDto.getPassword()));
  41.         } catch (Exception e) {
  42.             return RespBean.error("注册密码异常！");
  43.         }
  44.         admin.setEmail(authUserDto.getEmail());
  45.         if(adminService.create(admin) == null){
  46.             return RespBean.error("用户注册失败！");
  47.         };
  48.         redisTemplate.delete(authUserDto.getEmail());
  49.         return RespBean.success("用户注册成功！");
  50.     }
  51.  
  52.  
  53.  
  54.     @Override
  55.     public RespBean sendMailCode(String email) {
  56.  
  57.         ValueOperations<String, Object> valueOperations = redisTemplate.opsForValue();
  58.  
  59.         // 查看注册邮箱是否存在
  60.         if (adminService.registerEmailExist(email)) {
  61.             return RespBean.error("邮箱已被注册！");
  62.         }
  63.  
  64.         // 获取发送邮箱验证码的HTML模板
  65.         TemplateEngine engine = TemplateUtil.createEngine(new TemplateConfig("templates", TemplateConfig.ResourceMode.CLASSPATH));
  66.         Template template = engine.getTemplate("email-code.ftl");
  67.  
  68.         // 从redis缓存中尝试获取验证码
  69.         Object code = valueOperations.get(email);
  70.         if (code == null) {
  71.             // 如果在缓存中未获取到验证码，则产生6位随机数，放入缓存中
  72.             code = RandomUtil.randomNumbers(6);
  73.             try {
  74.                 valueOperations.set(email, code, expiration, TimeUnit.SECONDS);
  75.             } catch (Exception e) {
  76.                 return RespBean.error("后台缓存服务异常");
  77.             }
  78.         }
  79.         // 发送验证码
  80.         emailService.send(new EmailDto(Collections.singletonList(email),
  81.                 "邮箱验证码", template.render(Dict.create().set("code", code))));
  82.         return RespBean.success("验证码发送成功");
  83.  
  84.     }
  85. }

7. 编写Controller层API接口

  1. @Api(tags = "admin-controller")
  2. @RestController
  3. @RequestMapping("/user")
  4. public class AdminController {
  5.  
  6.     @Autowired
  7.     AuthServiceImpl authService;
  8.  
  9.     @ApiOperation(value = "发送邮箱验证码")
  10.     @PostMapping("/getemailcode")
  11.     public RespBean getEmailCode(@RequestParam String email) {
  12.         return authService.sendMailCode(email);
  13.     }
  14.  
  15.     @ApiOperation(value = "注册")
  16.     @PostMapping("/register")
  17.     public RespBean register(@RequestBody AuthUserDto authUserDto) {
  18.         return authService.register(authUserDto);
  19.     }
  20.  
  21. }

根据原项目完善用户服务类（adminService）相关的方法实现，即可实现邮箱验证码注册功能。

三、结果演示

1. 发送邮箱验证码接口

  • 请求方式：post

  • 请求地址：/user/getemailcode

  • 参数：

    1. { 
    2.     "email": "XXXX@foxmail.com"
    3. }

2. 注册账号接口

  • 请求方式：post

  • 请求地址：/user/register

  • 参数:

    1. {
    2. 	 "code": "214941",
    3. 	 "email": "XXXXXXX@foxmail.com",
    4. 	 "password": "123",
    5. 	 "username": "myself"
    6. }

3. 验证码邮件示例

 参考：手把手教你通过SpringBoot实现邮箱注册码验证_智慧zhuhuix的博客-CSDN博客_springboot实现邮箱注册icon-default.png?t=M4ADhttps://blog.csdn.net/jpgzhu/article/details/119533833

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/小蓝xlanll/article/detail/686368
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号