1 分钟教会你用 Spring Boot 发邮件

最新推荐文章于 2023-12-10 12:09:41 发布

zl1zl2zl3

最新推荐文章于 2023-12-10 12:09:41 发布

阅读量669

点赞数

分类专栏： SpringBoot mail 文章标签： springboot mail

SpringBoot 同时被 2 个专栏收录

165 篇文章 5 订阅

订阅专栏

mail

1 篇文章 0 订阅

订阅专栏

Spring Boot 提供了一个发送邮件的简单抽象，使用的是下面这个接口。

org.springframework.mail.javamail.JavaMailSender

Spring Boot 提供了一个 starter，并能自动配置，下面来做个小例子，顺便解析它做了什么工作。

0、你所需具备的基础

1、添加依赖

在 Maven pom.xml 配置文件中加入 spring-boot-starter-mail 依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

2、添加配置参数

然后在 application.properties 文件中加入以下配置。

spring.mail.host=smtp.exmail.qq.com
spring.mail.username=admin@javastack.cn
spring.mail.password=123456

# 启动SSL时的配置
spring.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
spring.mail.smtp.socketFactory.fallback=false
spring.mail.smtp.socketFactory.port=465

3、一个简单的发送邮件例子

写一个控制器，写一个简单的发送邮件的小例子，发送成功返回 true，发送失败返回 false。

@Autowired
private JavaMailSender javaMailSender;

@RequestMapping("/sendEmail")
@ResponseBody
public boolean sendEmail() {
    SimpleMailMessage msg = new SimpleMailMessage();
    msg.setFrom("admin@javastack.cn");
    msg.setBcc();
    msg.setTo("admin@javastack.cn");
    msg.setSubject("Java技术栈投稿");
    msg.setText("技术分享");
    try {
        javaMailSender.send(msg);
    } catch (MailException ex) {
        System.err.println(ex.getMessage());
        return false;
    }
    return true;
}

4、自动配置都做了什么？

Spring Boot 发现类路径下有这个 spring-boot-starter-mail 包和 spring.mail.host 参数就会自动配置 JavaMailSenderImpl。

上面那些 spring.mail.xx 参数用来装配 MailProperties 这个类。

org.springframework.boot.autoconfigure.mail.MailProperties

自动配置类：

org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration

@Configuration
@ConditionalOnClass({ MimeMessage.class, MimeType.class, MailSender.class })
@ConditionalOnMissingBean(MailSender.class)
@Conditional(MailSenderCondition.class)
@EnableConfigurationProperties(MailProperties.class)
@Import({ MailSenderJndiConfiguration.class, MailSenderPropertiesConfiguration.class })
public class MailSenderAutoConfiguration {

	/**
	 * Condition to trigger the creation of a {@link MailSender}. This kicks in if either
	 * the host or jndi name property is set.
	 */
	static class MailSenderCondition extends AnyNestedCondition {

		MailSenderCondition() {
			super(ConfigurationPhase.PARSE_CONFIGURATION);
		}

		@ConditionalOnProperty(prefix = "spring.mail", name = "host")
		static class HostProperty {

		}

		@ConditionalOnProperty(prefix = "spring.mail", name = "jndi-name")
		static class JndiNameProperty {

		}

	}

}

org.springframework.boot.autoconfigure.mail.MailSenderPropertiesConfiguration

@Configuration
@ConditionalOnProperty(prefix = "spring.mail", name = "host")
class MailSenderPropertiesConfiguration {

	private final MailProperties properties;

	MailSenderPropertiesConfiguration(MailProperties properties) {
		this.properties = properties;
	}

	@Bean
	@ConditionalOnMissingBean
	public JavaMailSenderImpl mailSender() {
		JavaMailSenderImpl sender = new JavaMailSenderImpl();
		applyProperties(sender);
		return sender;
	}

	private void applyProperties(JavaMailSenderImpl sender) {
		sender.setHost(this.properties.getHost());
		if (this.properties.getPort() != null) {
			sender.setPort(this.properties.getPort());
		}
		sender.setUsername(this.properties.getUsername());
		sender.setPassword(this.properties.getPassword());
		sender.setProtocol(this.properties.getProtocol());
		if (this.properties.getDefaultEncoding() != null) {
			sender.setDefaultEncoding(this.properties.getDefaultEncoding().name());
		}
		if (!this.properties.getProperties().isEmpty()) {
			sender.setJavaMailProperties(asProperties(this.properties.getProperties()));
		}
	}

	private Properties asProperties(Map<String, String> source) {
		Properties properties = new Properties();
		properties.putAll(source);
		return properties;
	}

}

其实就是用了上面装配的参数注册了一个 JavaMailSenderImpl 实例而已，然后你就可以注入使用了。