当前位置:

首页 > 编程开发 > SpringBoot集成邮件服务的完整实现方案

SpringBoot集成邮件服务的完整实现方案

SpringBoot集成邮件服务需引入starter-mail依赖并配置SMTP服务器及授权码。将发送功能封装为工具类,配合条件注解自动装配。结合RabbitMQ实现异步解耦,注册成功后推送消息至队列,消费者异步发送邮件,提高接口响应速度。

本文目录

    在SpringBoot项目中集成邮件服务,其实套路很固定,但真要把“发送邮件”这个功能玩得顺手,尤其是跟微服务、消息队列这些场景结合起来,还是有不少细节值得捋一捋的。下面这份方案,咱们从底层依赖一步步搭到上层业务,并附带了异步解耦的实战案例。

    1. 引入邮箱依赖

    要在SpringBoot里发邮件,首先得把starter-mail请进来,就这么简单。

    
        org.springframework.boot
        spring-boot-starter-mail
    

    2. 配置邮箱

    有了依赖,接下来就是配置邮件服务器。这里以QQ邮箱为例,需要配置SMTP服务器地址、端口、以及最重要的——授权码。注意,这个password不是你的邮箱登录密码,而是开启SMTP服务后生成的授权码,这个坑不少人踩过。

    spring:
      mail:
        host: smtp.qq.com
        username: 你的QQ邮箱@qq.com
        password: 你的授权码  #需要自己去邮箱内开启SMTP服务
        default-encoding: UTF-8
        port: 465
        protocol: smtp
        properties:
          mail:
            smtp:
              auth: true
              ssl:
                enable: true
              socketFactory:
                class: ja vax.net.ssl.SSLSocketFactory

    3. 测试发送一封简单的邮件

    配置搞定后,最直接的方式就是写个单元测试,看看能不能跑通。这段代码展示了最基础的发件流程:创建消息、设置发件人、收件人、标题和正文,然后发送。注意,这里setText的第二个参数为true,表示正文是HTML格式。

    @Autowired
    Ja vaMailSender ja vaMailSender;
    
    @Test
    public void test() throws Exception {
        // 创建一个邮件消息
        MimeMessage message = ja vaMailSender.createMimeMessage();
        // 创建 MimeMessageHelper
        MimeMessageHelper helper = new MimeMessageHelper(message, false);
        // 发件人邮箱和名称
        helper.setFrom("747692844@qq.com", "springdoc");
        // 收件人邮箱
        helper.setTo("admin@springboot.io");
        // 邮件标题
        helper.setSubject("Hello");
        // 邮件正文,第二个参数表示是否是HTML正文
        helper.setText("Hello  World! ", true);
        // 发送
        ja vaMailSender.send(message);
    }

    实际代码-前置条件:

    SpringBoot集成邮件服务的完整实现方案

    不过,在实际项目中,我们肯定不会在每个业务代码里都重复写这一套底层逻辑。所以,接下来就是封装和抽象。

    1. 将邮件发送功能封装在一个公共类里,方便其他地方调用

    说到封装,最直接的做法就是把它抽成一个公共工具类,放到common模块里。这样做有几个好处:

    • 依赖:工具类在common里,所有子服务都不用重复导mail依赖了。
    • yml配置:需要提醒的是,无论工具类放哪,每个要发邮件的微服务都必须自己配mail配置,因为每个服务的邮箱账号可能不同。
    • 调用:其他服务只需要注入这个MailUtil,直接调用send方法就行,不用再关心创建MimeMessage那些底层代码。
    package com.bite.common.utils;
    
    import jakarta.mail.internet.MimeMessage;
    import org.springframework.boot.autoconfigure.mail.MailProperties;
    import org.springframework.mail.ja vamail.Ja vaMailSender;
    import org.springframework.mail.ja vamail.MimeMessageHelper;
    
    import ja va.util.Optional;
    
    public class Mail {
        private Ja vaMailSender ja vaMailSender;
        private MailProperties mailProperties;
    
        public Mail(Ja vaMailSender ja vaMailSender, MailProperties mailProperties) {
            this.ja vaMailSender = ja vaMailSender;
            this.mailProperties = mailProperties;
        }
    
        public void send(String to, String subject, String content) throws Exception {
            MimeMessage mimeMessage = ja vaMailSender.createMimeMessage();
            MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, false);
            //发件人名称
            String personal = Optional.ofNullable(mailProperties.getProperties().get("personal"))
                    .orElse(mailProperties.getUsername());
            helper.setFrom(mailProperties.getUsername(), personal);
            helper.setTo(to);    //收件人
            helper.setSubject(subject);    //邮件主题
            helper.setText(content, true);
    
            ja vaMailSender.send(mimeMessage);
        }
    }
    

    2. 写Spring邮件配置类,哪个服务需要就写在哪个服务里,也可以提出来写在服务的公共类里

    工具类写好了,怎么让它被Spring管理起来?这就需要写一个配置类,把它注册成一个Bean。这里有个小技巧:用@ConditionalOnProperty注解。它的意思是,只有当你配置了spring.mail.username这个属性,这个Bean才会被创建。这样,那些不需要发邮件的服务(比如博客展示服务)就能避免因为找不到邮箱配置而报错,非常优雅。

    package com.bite.common.config;
    
    import com.bite.common.utils.Mail;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
    import org.springframework.boot.autoconfigure.mail.MailProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.mail.ja vamail.Ja vaMailSender;
    
    
    @Configuration
    public class MailConfig {
        @Bean
        @ConditionalOnProperty(prefix="spring.mail",name="username")
        public Mail mail(Ja vaMailSender ja vaMailSender, MailProperties mailProperties) {
            return new Mail(ja vaMailSender,mailProperties);
        }
    }
    

    例子展示

    光说不练假把式,下面看一个实际业务场景。假设我们有一个用户注册服务,在注册成功后,需要给用户发一封欢迎邮件。但发邮件这个操作可能会比较耗时,如果同步处理,会拖慢用户注册的响应速度。所以,这里引入RabbitMQ来做异步解耦。

    某服务的注册业务(Service)代码:

    @Override
    public Integer register(UserInfoRegisterRequest registerRequest) {
        //校验参数:
        checkUserInfo(registerRequest);
        //校验通过,才是用户注册,插入数据库
        UserInfo userInfo = BeanConvert.convertUserInfoByEncrypt(registerRequest);
        try{
            int result = userInfoMapper.insert(userInfo);
            if(result==1){
                //存储数据到redis中
                redis.set(buildKey(userInfo.getUserName()), JsonUtil.toJson(userInfo),EXPIRE_TIME);
    
                //⭐注册成功主动推送用户数据到 RabbitMQ,交给消费者异步处理发邮件,不阻塞注册接口响应速度
                userInfo.setPassword("");
                rabbitTemplate.convertAndSend(Constants.USER_EXCHANGE_NAME,"",JsonUtil.toJson(userInfo));
    
                return userInfo.getId();
            }else{
                throw new BlogException("用户注册失败");
            }
        }catch (Exception e){
            log.error("用户注册失败,e:",e);
            throw new BlogException("用户注册失败");
        }
    }
    

    看到没有,关键代码就是这一行:rabbitTemplate.convertAndSend(...)。注册成功后,立刻把用户信息丢到消息队列里,然后直接返回。这样,用户注册接口的响应速度非常快,而发邮件的任务则交给消费者去异步处理。

    生产者:注册成功后,主动推送用户数据到RabbitMQ,交给消费者异步处理发邮件,不阻塞注册接口响应速度。

    消费者:消费收到的用户数据,并做出下一步操作,比如发送邮件。

    package com.bite.user.listener;
    
    import com.bite.common.constant.Constants;
    import com.bite.common.utils.JsonUtil;
    import com.bite.common.utils.Mail;
    import com.bite.user.dataobject.UserInfo;
    import com.rabbitmq.client.Channel;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.amqp.core.ExchangeTypes;
    import org.springframework.amqp.core.Message;
    import org.springframework.amqp.rabbit.annotation.Exchange;
    import org.springframework.amqp.rabbit.annotation.Queue;
    import org.springframework.amqp.rabbit.annotation.QueueBinding;
    import org.springframework.amqp.rabbit.annotation.RabbitListener;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    import ja va.io.IOException;
    
    @Slf4j
    @Component
    public class UserQueueListener {
        //⭐
        @Autowired
        private Mail mail;
        
        @RabbitListener(bindings=@QueueBinding(
                value=@Queue(value=Constants.USER_QUEUE_NAME,durable="true"),
                exchange=@Exchange(value=Constants.USER_EXCHANGE_NAME,type= ExchangeTypes.FANOUT)
        ))
        public void handler(Message message, Channel channel) throws IOException {
            long deliveryTag=message.getMessageProperties().getDeliveryTag();
            try{
                String body = new String(message.getBody());
                log.info("收到用户信息,body:{}",body);
                //TODO 发送注册成功邮件
                UserInfo userInfo= JsonUtil.parseJson(body, UserInfo.class);
                //⭐发送邮箱
                mail.send(userInfo.getEmail(),"恭喜加入XM博客社区",buildContent(userInfo.getUserName()));
    
                //确认
                channel.basicAck(deliveryTag,true);
            }catch(Exception e){
                //否定确认
                channel.basicNack(deliveryTag,true,true);
                log.error("邮件发送失败,e:",e);
            }
        }
    
        //发送的邮箱内容
        private String buildContent(String userName){
            StringBuilder builder=new StringBuilder();
            builder.append("尊敬的").append(userName).append(",您好!").append("
    "); builder.append("感谢您注册成为我们博客社区的一员!我们很高兴您加入我们的大家庭!
    "); builder.append("您的注册信息如下:用户名: ").append(userName).append("
    "); builder.append("为了您的账号安全,请妥善保管您的登录信息.如果使用过程中,遇到任何问题,欢迎联系我们的支持团队. XXXX@bXM.com
    "); builder.append("再次感谢您的加入,我们期待看到您的精彩内容!
    ") .append("最好的祝愿
    ") .append("XM博客团队"); return builder.toString(); } }

    发送邮件前置条件:公共类里的

    ① 把Mail工具类创建成Spring Bean,放进容器

    这一步就是前面提到的MailConfig配置类的作用。它把Mail工具类注册成Bean,并自动注入Ja vaMailSender和MailProperties。通过@ConditionalOnProperty,只有配置了邮箱的服务才会创建这个Bean,灵活又安全。

    ② 邮箱发送操作实现逻辑

    这就是Mail类本身做的事情:封装底层发邮件逻辑,创建邮件、设置发件人/收件人/HTML正文、调用发送API。对外暴露一个简洁的send(String to, String subject, String content)方法。

    三者关系

    • 在消费者类里,通过@Autowired注入Mail。
    • Spring会从容器中找到MailConfig注册好的Mail Bean,注入进来。
    • 调用mail.send(邮箱,标题,正文),本质就是执行工具类里封装好的邮件发送代码。

    这样一来,整个邮件发送的链路就清晰了:业务层只管发消息,消息队列负责解耦,邮件工具类负责发送,各司其职,非常干净。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    Qwen Code v0.28.0 默认在哪些场景启用共享 Agent 循环?
    Qwen Code v0.28.0 默认在哪些场景启用共享 Agent 循环?

    Qwen Code v0.28.0 将共享 Agent 循环默认用于无界面会话、Ink 终端和子代理。各入口在没有显式配置时采用自己的默认值。

    n8n 2.49.0 与 3.3.0 预发布版如何保存和隔离工具调用记录?
    n8n 2.49.0 与 3.3.0 预发布版如何保存和隔离工具调用记录?

    n8n 2.49.0 与 3.3.0 预发布版对 AI Agent 作了三处调整。工具调用前的模型文本进入 Agent 历史,每条输入单独保存工具调用历史,一次对话中的每轮工具调用都写入聊天记忆。

    OpenBot v1.1.0-rc.2 的个人版请求需要哪些凭证?
    OpenBot v1.1.0-rc.2 的个人版请求需要哪些凭证?

    OpenBot v1.1.0-rc.2 的个人版请求需要能表明安装身份的凭证。桌面窗口沿用受信任入口建立的会话,程序可携带安装令牌,访问 /api/v2 时还可使用个人 API 密钥。过去直接发出的无凭证请求会被拒绝。

    llama.cpp b12469 的隐式矩阵乘法需要怎样的硬件能力?
    llama.cpp b12469 的隐式矩阵乘法需要怎样的硬件能力?

    llama.cpp b12469 的 Metal CONV_2D 增加隐式 GEMM。能否走新内核取决于设备是否支持 simdgroup 矩阵指令等实际分派条件。

    Google Gerrit Code Review 1.0.0 怎样查看补丁并处理外部审查内容?
    Google Gerrit Code Review 1.0.0 怎样查看补丁并处理外部审查内容?

    Google Gerrit Code Review 1.0.0 安装和只读查询示例,说明主机、工具权限、外部内容及评论投票的确认边界。

    llama.cpp b12466 的 SiLU 兼容范围扩大到哪里?
    llama.cpp b12466 的 SiLU 兼容范围扩大到哪里?

    llama.cpp b12466 调整了 OpenCL 的 SiLU 路径。新增的支持包括 f16,以及元素在内存中不连续的 f32 张量。

    llama.cpp b12468 的 WebGPU 时间步嵌入适用哪些项目?
    llama.cpp b12468 的 WebGPU 时间步嵌入适用哪些项目?

    llama.cpp b12468 的 WebGPU 变化集中在时间步嵌入。项目合并说明将 stable-diffusion.cpp 列作依赖该算子的下游项目示例。

    OpenCode PTY 0.6.0 哪些运行中的终端受协议 9 升级影响?
    OpenCode PTY 0.6.0 哪些运行中的终端受协议 9 升级影响?

    受影响的是旧协议守护进程承载的命令和持久终端。切换时旧实例会关闭,新服务在首次需要时再启动。

    llama.cpp b12465 的 SYCL 快速取模适用哪些路径?
    llama.cpp b12465 的 SYCL 快速取模适用哪些路径?

    llama.cpp b12465。llama.cpp b12465 的快速取模用在 SYCL 广播相关的索引运算。一次内核启动可复用同一组预计算值,前提是除数非零且能放入 32 位。

    Plannotator v0.28.67如何防止附件脚本切换线程和保存失败清空配置
    Plannotator v0.28.67如何防止附件脚本切换线程和保存失败清空配置

    Plannotator v0.28.67 让 HTML 附件脚本失去自行切换 Inbox 线程的能力,并在安全写入失败时保留 config.json 和 state.json。两项保护分别针对附件预览行为和本地配置文件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。