在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);
}
实际代码-前置条件:

然而,在实际项目中,我们不可能在每个业务代码里都重复编写这一套底层逻辑。因此,下一步就是封装与抽象。
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注册好的MailBean,并注入进来。 - 调用
mail.send(邮箱,标题,正文),本质上就是执行工具类中封装好的邮件发送代码。
如此一来,整个邮件发送的链路便清晰明了:业务层只管发送消息,消息队列负责解耦,邮件工具类专注于发送,各司其职,非常干净。
