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

Springboot发送邮箱验证码(QQ,163)_springboot邮箱验证码

作者：花生_TL007 | 2024-06-07 17:22:29

赞

踩

springboot邮箱验证码
--下面以QQ邮箱为列，163与自建邮箱同理，后附有异步发送优化
实现思路
1.使用Freemaker生成邮箱模版
2.发送邮箱为异步发送，使用SpringBoot的线程池
  1. 邮箱开启smtp服务

  • 点击开启

  • 根据要求发送短信

  • 发送完毕点击我已发送，会生成授权码，！！！记住授权码

  1. 引入SpringBoot-mail和Freemaker的依赖
  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-mail</artifactId>
  4. </dependency>
  5. <dependency>
  6.     <groupId>org.springframework.boot</groupId>
  7.     <artifactId>spring-boot-starter-freemarker</artifactId>
  8.     <version>2.4.2</version>
  9. </dependency>
！！！Freemaker用于生成邮箱模版
  1. 设置模版

  • 在resources目录下创建模版文件register_email.ftl

  • register_email.ftl内容

${email}和${verifyCode}为需要替换的参数 
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>注册验证码</title>
  6. </head>
  7. <body>
  8.     <div>
  9.         <div>${email},你好！</div>
  10.         <br/>
  11.             <div>&emsp;&emsp;您好，您的验证码为:&nbsp;<span style="color:blue;font-size: 20px;font-weight: 700;">${verifyCode}</span>
  12.             &nbsp;验证码10分钟内有效，请在时限内完成注册。
  13.             期待您的加入!</div>
  14.         <br/>
  15.         <div>XXX有限公司</div>
  16.         <br/>
  17.         <div>谢谢!</div>
  18.     </div>
  19. </body>
  20. </html>
  1. 在application.yml文件中配置邮箱参数
  1. spring:
  2.   mail:
  3.     # 配置 SMTP 服务器地址
  4.     host: mail.qq.net
  5.     # 发送者邮箱
  6.     username: xxxxx@qq.com
  7.     # 配置密码，注意不是真正的密码，而是刚刚申请到的授权码
  8.     password: xxxxxxxxxxxxx
  9.     # 端口号465或587
  10.     port: 465
  11.     #默认的邮件编码为UTF-8
  12.     default-encoding: UTF-8
  13.     protocol: smtps

  • 创建EmailUtils.java文件

  1. package com.lnsk.common.utils;
  2.  
  3. import com.lnsk.common.constant.Constants;
  4. import freemarker.cache.ClassTemplateLoader;
  5. import freemarker.template.Configuration;
  6. import freemarker.template.Template;
  7. import freemarker.template.TemplateException;
  8. import lombok.extern.slf4j.Slf4j;
  9. import org.springframework.beans.factory.annotation.Value;
  10. import org.springframework.mail.javamail.JavaMailSenderImpl;
  11. import org.springframework.mail.javamail.MimeMessageHelper;
  12. import org.springframework.scheduling.annotation.Async;
  13. import org.springframework.stereotype.Component;
  14.  
  15. import javax.mail.MessagingException;
  16. import javax.mail.internet.MimeMessage;
  17. import java.io.IOException;
  18. import java.io.StringWriter;
  19. import java.nio.charset.Charset;
  20. import java.util.Date;
  21. import java.util.Map;
  22. import java.util.Properties;
  23.  
  24. /**
  25.  * 邮箱工具类
  26.  * @author haiven
  27.  *
  28.  */
  29. @Slf4j
  30. @Component
  31. public class EmailUtils {
  32.     
  33.     //发件人邮箱
  34.     @Value("${spring.mail.username}")
  35.     private String username;
  36.     
  37.     //发件人密码
  38.     @Value("${spring.mail.password}")
  39.     private String password;
  40.     
  41.     //发件人host
  42.     @Value("${spring.mail.host}")
  43.     private String host;
  44.  
  45.     //发件人端口
  46.     @Value("${spring.mail.port}")
  47.     private String port;
  48.     
  49.     //邮件模板名
  50.     private static final String TEMP_FILE_NAME = "register_email.ftl";
  51.  
  52.     /**
  53.      * 发送邮件
  54.      * @param subject 邮件主题
  55.      * @param content 邮内容
  56.      * @param to    邮件接收人
  57.      * @throws MessagingException 
  58.      */
  59.     @Async("verifyThreadPool")
  60.     public void sendEmail(String subject,String content,String to) throws MessagingException {
  61.         JavaMailSenderImpl javaMailSender = new JavaMailSenderImpl();
  62.         javaMailSender.setPort(port);
  63.         javaMailSender.setUsername(username);
  64.         javaMailSender.setPassword(password);
  65.         javaMailSender.setHost(host);
  66.         javaMailSender.setDefaultEncoding(Constants.UTF8);
  67.         Properties properties = new Properties();
  68.         properties.setProperty("mail.smtp.socketFactory.port", port);
  69.         properties.setProperty("mail.smtp.socketFactory.class", "javax.net.ssl.SSLSocketFactory");
  70.         javaMailSender.setJavaMailProperties(properties);
  71.         MimeMessage mailMessage=javaMailSender.createMimeMessage();
  72.         //需要借助Helper类
  73.         MimeMessageHelper helper=new MimeMessageHelper(mailMessage);
  74.         log.debug("Register send email:" + username );
  75.         helper.setFrom(username);
  76.         helper.setTo(to);
  77.         //helper.setBcc("密送人");
  78.         helper.setSubject(subject);
  79.         helper.setSentDate(new Date());//发送时间
  80.         //第一个参数要发送的内容，第二个参数是不是Html格式。
  81.         helper.setText(content,true);
  82.         javaMailSender.send(mailMessage);
  83.     }
  84.  
  85.     /**
  86.      * 加载邮件模板
  87.      * @param email & verifyCode 邮件模板参数
  88.      * @return
  89.      * @throws IOException
  90.      * @throws TemplateException
  91.      */
  92.     public static String loadEmailContent(String email，String verifyCode) throws IOException, TemplateException {
  93.         Map<String,String> dataMap = new HashMap<>();
  94.         dataMap.put("email",email);
  95.         dataMap.put("verifyCode",verifyCode);
  96.         //初始化模板
  97.         Configuration configuration = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS);
  98.         configuration.setDefaultEncoding(Charset.forName("UTF-8").name());
  99.  
  100.         //设置模板文件路径
  101.         configuration.setTemplateLoader(new ClassTemplateLoader(EmailUtils.class,"/templates/"));
  102.  
  103.         //获取模板
  104.         Template template = configuration.getTemplate(TEMP_FILE_NAME);
  105.  
  106.         //输出位置 这里用字符串输出，如果要输出文件自行替换
  107.         StringWriter writer = new StringWriter();
  108.         template.process(dataMap, writer);
  109.         StringBuffer buffer = writer.getBuffer();
  110.         return buffer.toString();
  111.     }
  112.     
  113. }
loadEmailContent方法为加载邮箱内容方法，参数为register_email.ftl中的email和verifyCode两个参数

  • 创建测试类，测试发送邮箱

  1. package com.lnsk.order.controller;
  2.  
  3. import com.lnsk.common.utils.EmailUtils;
  4. import freemarker.template.TemplateException;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.web.bind.annotation.GetMapping;
  7. import org.springframework.web.bind.annotation.RequestParam;
  8. import org.springframework.web.bind.annotation.RestController;
  9.  
  10. import javax.mail.MessagingException;
  11. import java.io.IOException;
  12.  
  13. @RestController
  14. public class TestUtils {
  15.  
  16.     @Autowired
  17.     EmailUtils emailUtils;
  18.  
  19.     //邮件主题
  20.     private static final String SUBJECT = "测试邮箱";
  21.  
  22.     @GetMapping("/getVerifyCode")
  23.     public String getVerifyCode(@RequestParam String email) throws TemplateException, IOException, MessagingException {
  24.         String content = EmailUtils.loadEmailContent(email, getCode());
  25.         emailUtils.sendEmail(SUBJECT,content,email);
  26.         return "OK";
  27.     }
  28.  
  29.     /**
  30.      * 获取邮箱验证码
  31.      * @return
  32.      */
  33.     public String getCode(){
  34.         return String.valueOf((int)((Math.random() * 9 + 1) * Math.pow(10,5)));
  35.     }
  36.  
  37. }

  • 调用接口

  • 查看邮箱，看是否发送成功

5. 代码优化
将邮箱改为异步发送，使用Spring的线程池

定义线程池配置类LnskThreadPoolConfig.java

  1. package com.lnsk.common.config;
  2.  
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.scheduling.annotation.EnableAsync;
  6. import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
  7.  
  8. import java.util.concurrent.ThreadPoolExecutor;
  9.  
  10. @Configuration
  11. @EnableAsync
  12. public class LnskThreadPoolConfig {
  13.  
  14.     /**
  15.      * 核心线程数
  16.      */
  17.     private static final int CORE_POOL_SIZE = 10;
  18.  
  19.     /**
  20.      * 最大线程数
  21.      */
  22.     private static final int MAX_POOL_SIZE = 20;
  23.  
  24.     /**
  25.      * 允许线程空闲时间 默认为秒
  26.      */
  27.     private static final int KEEP_ALIVE_SECONDS = 60;
  28.  
  29.     /**
  30.      * 缓冲队列
  31.      */
  32.     private static final int QUEUE_SIZE = 40;
  33.  
  34.     /**
  35.      * 线程命名
  36.      */
  37.     private static final String THREAD_NAME_PRE = "Verify thread-";
  38.  
  39.     //线程池名称verifyThreadPool
  40.     @Bean("verifyThreadPool")
  41.     public ThreadPoolTaskExecutor getVerifyThreadPool(){
  42.         ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
  43.         executor.setCorePoolSize(CORE_POOL_SIZE);
  44.         executor.setMaxPoolSize(MAX_POOL_SIZE);
  45.         executor.setQueueCapacity(QUEUE_SIZE);
  46.         executor.setKeepAliveSeconds(KEEP_ALIVE_SECONDS);
  47.         executor.setThreadNamePrefix(THREAD_NAME_PRE);
  48.  
  49.         // 线程池对拒绝任务的处理策略(抛出异常)
  50.         executor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
  51.         // 初始化
  52.         executor.initialize();
  53.         return executor;
  54.     }
  55.  
  56. }

  • 在发送验证码的方法上加入@Async("verifyThreadPool")注解，并交给Spring容器管理

！！！该注解方法不能修饰静态方法

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

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

  

闽ICP备14008679号