结合Spring发送邮件的四种正确姿式，你知道几种？

时间  2019-11-16
标签 结合 spring 发送 邮件 四种 正确 知道 几种 栏目 Spring 繁體版
原文   原文链接

一 前言

测试所使用的环境

测试使用的环境是企业主流的SSM 框架即 SpringMVC+Spring+Mybatis。为了节省时间，我直接使用的是我上次的“SSM项目中整合Echarts开发”该项目已经搭建完成的SSM环境。php

标题说的四种姿式指的是哪四种姿式？

  1. 发送text格式的邮件
  2. 发送HTML格式的邮件
  3. 基于FreeMarker模板引擎发送邮件
  4. 基于Velocity模板引擎发送邮件

如何获取以及运行个人Demo

Github地址：github.com/Snailclimb/…。html

你能够选择直接下载或者直接在DOS窗口运行：git clone https://github.com/Snailclimb/J2ee-Advanced.git命令，这样项目就被拷贝到你的电脑了。 java

而后选择导入Maven项目便可（不懂Maven的能够自行百度学习）.git

二 准备工做

既然要发送邮件，那么你首先要提供一个能在第三方软件上发送邮件功能的帐号。在这里，我选择的网易邮箱帐号。github

我拿网易邮箱帐号举例子，那么咱们如何才能让你的邮箱帐号能够利用第三方发送邮件（这里的第三方就是咱们即将编写的程序）。面试

你们应该清楚:客户端和后台交互数据的时候用到了Http协议，那么相应的，邮箱传输也有本身的一套协议，如SMTP，POP3，IMAP。spring

开启POP3/SMTP/IMAP服务

因此，咱们第一步首先要去开启这些服务，以下图所示：apache

开启服务

若是你未开启该服务的话，运行程序会报以下错误（配置文件中配置的密码是你的受权码而不是你登陆邮箱的密码，受权码是你第三方登陆的凭证）：后端

HTTP Status 500 - Request processing failed; nested exception is org.springframework.mail.MailAuthenticationException: Authentication failed; nested exception is javax.mail.AuthenticationFailedException: 550 User has no permission
复制代码

JavaMail介绍

咱们须要用到的发邮件的核心jar包，因此这里好好介绍一下。bash

JavaMail是由Sun定义的一套收发电子邮件的API，不一样的厂商能够提供本身的实现类。但它并无包含在JDK中，而是做为JavaEE的一部分。厂商所提供的JavaMail服务程序能够有选择地实现某些邮件协议，常见的邮件协议包括：

  • SMTP：简单邮件传输协议，用于发送电子邮件的传输协议；
  • POP3：用于接收电子邮件的标准协议；
  • IMAP：互联网消息协议，是POP3的替代协议。

这三种协议都有对应SSL加密传输的协议，分别是SMTPS，POP3S和IMAPS。

咱们若是要使用JavaMail的话，须要本身引用相应的jar包，以下图所示：

<dependency>
			<groupId>javax.mail</groupId>
			<artifactId>mail</artifactId>
			<version>1.4.7</version>
		</dependency>
复制代码

相关配置文件

下图是除了pom.xml以外用到的其余全部配置文件

配置文件

pom.xml

须要用到的jar包。

<!--spring支持-->
        <dependency>
              <groupId>org.springframework</groupId>
              <artifactId>spring-context-support</artifactId>
              <version>5.0.0.RELEASE</version>
        </dependency>
		<!-- 发送邮件 -->
		<dependency>
			<groupId>javax.mail</groupId>
			<artifactId>mail</artifactId>
			<version>1.4.7</version>
		</dependency>
		<!-- Freemarker -->
		<dependency>
			<groupId>org.freemarker</groupId>
			<artifactId>freemarker</artifactId>
			<version>2.3.23</version>
		</dependency>
		<!-- velocity模板引擎 -->
		<dependency>
			<groupId>org.apache.velocity</groupId>
			<artifactId>velocity</artifactId>
			<version>1.7</version>
		</dependency>
		<dependency>
			<groupId>org.apache.velocity</groupId>
			<artifactId>velocity-tools</artifactId>
			<version>2.0</version>
		</dependency>
复制代码

mail.properties

#服务器主机名
mail.smtp.host=smtp.163.com
#你的邮箱地址
mail.smtp.username=koushuangbwcx@163.com
#你的受权码
mail.smtp.password=cSdN153963000
#编码格式
mail.smtp.defaultEncoding=utf-8
#是否进行用户名密码校验
mail.smtp.auth=true
#设置超时时间
mail.smtp.timeout=20000
复制代码

若是你的受权码填写错误的话，会报以下错误：

TTP Status 500 - Request processing failed; nested exception is org.springframework.mail.MailAuthenticationException: Authentication failed; nested exception is javax.mail.AuthenticationFailedException: 535 Error: authentication failed
复制代码

velocity.properties

input.encoding=UTF-8  
output.encoding=UTF-8  
contentType=ext/html;charset=UTF-8
directive.foreach.counter.name=loopCounter  
directive.foreach.counter.initial.value=0
复制代码

applicationContext-email.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.2.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd">

	<!--邮件配置 -->
	<context:property-placeholder location="classpath:mail.properties" ignore-unresolvable="true" />

	<!--配置邮件接口 -->
	<bean id="javaMailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
		<property name="host" value="${mail.smtp.host}" />
		<property name="username" value="${mail.smtp.username}" />
		<property name="password" value="${mail.smtp.password}" />
		<property name="defaultEncoding" value="${mail.smtp.defaultEncoding}" />
		<property name="javaMailProperties">
			<props>
				<prop key="mail.smtp.auth">${mail.smtp.auth}</prop>
				<prop key="mail.smtp.timeout">${mail.smtp.timeout}</prop>
			</props>
		</property>
	</bean>
	<!-- freemarker -->
	<bean id="configuration" class="org.springframework.ui.freemarker.FreeMarkerConfigurationFactoryBean">
		<property name="templateLoaderPath" value="/WEB-INF/freemarker/" />
		<!-- 设置FreeMarker环境变量 -->
		<property name="freemarkerSettings">
			<props>
				<prop key="default_encoding">UTF-8</prop>
			</props>
		</property>
	</bean>


	<!-- velocity -->
	<bean id="velocityEngine" class="org.springframework.ui.velocity.VelocityEngineFactoryBean">
		<property name="resourceLoaderPath" value="/WEB-INF/velocity/" /><!-- 模板存放的路径 -->
		<property name="configLocation" value="classpath:velocity.properties" /><!-- Velocity的配置文件 -->
	</bean>

</beans>
复制代码

三 开始编写工具类

我这里说是工具类，其实只是我本身作了简单的封装，实际项目使用的话，可能会须要根据须要简单修改一下。

全部用到的类以下图所示：

全部用到的类

发送Text或者HTML格式的邮件的方法

/** * * Text或者HTML格式邮件的方法 * * @param text * 要发送的内容 * @param subject * 邮件的主题也就是邮件的标题 * @param location * 文件的地址 * @param emailAdress * 目的地 * @param javaMailSender * 发送邮件的核心类（在xml文件中已经配置好了） * @param type * 若是为true则表明发送HTML格式的文本 * @return * @throws TemplateException */
	public String sendMail(String text, String subject, String location, String emailAdress, JavaMailSender javaMailSender, Boolean type) {
		MimeMessage mMessage = javaMailSender.createMimeMessage();// 建立邮件对象
		MimeMessageHelper mMessageHelper;
		Properties prop = new Properties();
		try {
			// 从配置文件中拿到发件人邮箱地址
			prop.load(this.getClass().getResourceAsStream("/mail.properties"));
			String from = prop.get("mail.smtp.username") + "";
			mMessageHelper = new MimeMessageHelper(mMessage, true, "UTF-8");
			// 发件人邮箱
			mMessageHelper.setFrom(from);
			// 收件人邮箱
			mMessageHelper.setTo(emailAdress);
			// 邮件的主题也就是邮件的标题
			mMessageHelper.setSubject(subject);
			// 邮件的文本内容，true表示文本以html格式打开
			if (type) {
				mMessageHelper.setText(text, true);
			} else {
				mMessageHelper.setText(text, false);
			}

			// 经过文件路径获取文件名字
			String filename = StringUtils.getFileName(location);
			// 定义要发送的资源位置
			File file = new File(location);
			FileSystemResource resource = new FileSystemResource(file);
			FileSystemResource resource2 = new FileSystemResource("D:/email.txt");
			mMessageHelper.addAttachment(filename, resource);// 在邮件中添加一个附件
			mMessageHelper.addAttachment("JavaApiRename.txt", resource2);//
			// 在邮件中添加一个附件
			javaMailSender.send(mMessage);// 发送邮件
		} catch (MessagingException e) {
			e.printStackTrace();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return "发送成功";
	}
复制代码

我在sendMail()方法中添加了一个boolean类型的变量type做为标志，若是为ture就表示发送html格式的邮件不然直接发送text格式的邮件。实现起来很简单，咱们经过下面的判断语句就能够实现了

if (type) {
		        //表示文本以html格式打开
				mMessageHelper.setText(text, true);
			} else {
				mMessageHelper.setText(text, false);
			}
复制代码

效果:

基于FreeMarker模板引擎发送邮件

下图是咱们用到的FreeMarker模板文件以及Velocity模板文件的位置。

/** * FreeMarker模板格式的邮件的方法 * * @param subject * 邮件的主题也就是邮件的标题 * @param location * 文件的地址 * @param emailAdress * 目的地 * @param javaMailSender * 发送邮件的核心类（在xml文件中已经配置好了） * @param freeMarkerConfiguration * freemarker配置管理类 * @return * @throws TemplateException */
	public String sendMailFreeMarker(String subject, String location, String emailAdress, JavaMailSender javaMailSender, Configuration freeMarkerConfiguration) {
		MimeMessage mMessage = javaMailSender.createMimeMessage();// 建立邮件对象
		MimeMessageHelper mMessageHelper;
		Properties prop = new Properties();
		try {
			// 从配置文件中拿到发件人邮箱地址
			prop.load(this.getClass().getResourceAsStream("/mail.properties"));
			String from = prop.get("mail.smtp.username") + "";
			mMessageHelper = new MimeMessageHelper(mMessage, true);
			// 发件人邮箱
			mMessageHelper.setFrom(from);
			// 收件人邮箱
			mMessageHelper.setTo(emailAdress);
			// 邮件的主题也就是邮件的标题
			mMessageHelper.setSubject(subject);
			// 解析模板文件
			mMessageHelper.setText(getText(freeMarkerConfiguration), true);
			// 经过文件路径获取文件名字
			String filename = StringUtils.getFileName(location);
			// 定义要发送的资源位置
			File file = new File(location);
			FileSystemResource resource = new FileSystemResource(file);
			mMessageHelper.addAttachment(filename, resource);// 在邮件中添加一个附件
			javaMailSender.send(mMessage);// 发送邮件
		} catch (MessagingException e) {
			e.printStackTrace();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return "发送成功";
	}
	
  	/** * 读取freemarker模板的方法 */
	private String getText(Configuration freeMarkerConfiguration) {
		String txt = "";
		try {
			Template template = freeMarkerConfiguration.getTemplate("email.ftl");
			// 经过map传递动态数据
			Map<String, Object> map = new HashMap<String, Object>();
			map.put("user", "Snailclimb");
			// 解析模板文件
			txt = FreeMarkerTemplateUtils.processTemplateIntoString(template, map);
			System.out.println("getText()->>>>>>>>>");// 输出的是HTML格式的文档
			System.out.println(txt);
		} catch (IOException e) {
			// TODO 异常执行块！
			e.printStackTrace();
		} catch (TemplateException e) {
			// TODO 异常执行块！
			e.printStackTrace();
		}

		return txt;
	}
复制代码

咱们经过getText(Configuration freeMarkerConfiguration)方法读取freemarker模板，返回的格式以下图所示：

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>测试</title>
</head>

<body>
<h1>你好Snailclimb</h1>
</body>
</html>
复制代码

其实就是HTML，而后咱们就能够像前面发送HTML格式邮件的方式发送这端消息了。

email.ftl

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>测试</title>
</head>

<body>
<h1>你好${user}</h1>
</body>
</html>
复制代码

效果：

不知道为啥，腾讯每次把我使用模板引擎发的邮件直接放到垃圾箱。你们若是遇到接收不到邮件，可是又没报错的状况，能够看看是否是到了本身邮箱的垃圾箱。

基于Velocity模板引擎发送邮件

/** * * @param subject * 邮件主题 * @param location * 收件人地址 * @param emailAdress * 目的地 * @param javaMailSender * 发送邮件的核心类（在xml文件中已经配置好了） * @param velocityEngine * Velocity模板引擎 * @return */
	public String sendMailVelocity(String subject, String location, String emailAdress, JavaMailSender javaMailSender, VelocityEngine velocityEngine) {
		MimeMessage mMessage = javaMailSender.createMimeMessage();// 建立邮件对象
		MimeMessageHelper mMessageHelper;
		Properties prop = new Properties();
		try {
			// 从配置文件中拿到发件人邮箱地址
			prop.load(this.getClass().getResourceAsStream("/mail.properties"));
			System.out.println(this.getClass().getResourceAsStream("/mail.properties"));
			String from = prop.get("mail.smtp.username") + "";
			mMessageHelper = new MimeMessageHelper(mMessage, true, "UTF-8");
			// 发件人邮箱
			mMessageHelper.setFrom(from);
			// 收件人邮箱
			mMessageHelper.setTo(emailAdress);
			// 邮件的主题也就是邮件的标题
			mMessageHelper.setSubject(subject);
			Map<String, Object> map = new HashMap<>();
			// 获取日期并格式化
			Date date = new Date();
			DateFormat bf = new SimpleDateFormat("yyyy-MM-dd E a HH:mm:ss");
			String str = bf.format(date);
			map.put("date", str);
			String content = VelocityEngineUtils.mergeTemplateIntoString(velocityEngine, "email.vm", "UTF-8", map);
			mMessageHelper.setText(content, true);
			// 经过文件路径获取文件名字
			String filename = StringUtils.getFileName(location);
			// 定义要发送的资源位置
			File file = new File(location);
			FileSystemResource resource = new FileSystemResource(file);
			mMessageHelper.addAttachment(filename, resource);// 在邮件中添加一个附件
			// mMessageHelper.addAttachment("JavaApiRename.txt", resource2);//
			// 在邮件中添加一个附件
			javaMailSender.send(mMessage);// 发送邮件
		} catch (MessagingException e) {
			e.printStackTrace();
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		return "发送成功";
	}
复制代码

email.vm

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
 
<body>
<h3>今天的日期是:${date}</h3>

</body>
</html>
复制代码

效果：

controller层

/** * 测试邮件发送controller * @author Snailclimb */
@RestController
@RequestMapping("mail")
public class SendMailController {
	@Autowired
	private JavaMailSender javaMailSender;// 在spring中配置的邮件发送的bean
	@Autowired
	private Configuration configuration;
	@Autowired
	private VelocityEngine velocityEngine;

	// text
	@RequestMapping("send")
	public String sendEmail() {
		EmailUtils emailUtils = new EmailUtils();
		return emailUtils.sendMail("大傻子大傻子大傻子，你好！！！", "发送给我家大傻子的~", "D:/picture/meizi.jpg", "1361583339@qq.com",
				javaMailSender, false);
	}

	// html
	@RequestMapping("send2")
	public String sendEmail2() {
		EmailUtils emailUtils = new EmailUtils();
		return emailUtils.sendMail(
				"<p>大傻子大傻子大傻子，你好！！！</p><br/>" + "<a href='https://github.com/Snailclimb'>点击打开个人Github!</a><br/>",
				"发送给我家大傻子的~", "D:/picture/meizi.jpg", "1361583339@qq.com", javaMailSender, true);
	}

	// freemarker
	@RequestMapping("send3")
	public String sendEmail3() {
		EmailUtils emailUtils = new EmailUtils();
		return emailUtils.sendMailFreeMarker("发送给我家大傻子的~", "D:/picture/meizi.jpg", "1361583339@qq.com", javaMailSender,
				configuration);

	}

	// velocity
	@RequestMapping("send4")
	public String sendEmail4() {
		EmailUtils emailUtils = new EmailUtils();
		return emailUtils.sendMailVelocity("发送给我家大傻子的~", "D:/picture/meizi.jpg", "1361583339@qq.com", javaMailSender,
				velocityEngine);

	}
}

复制代码

四 总结

上面咱们总结了Spring发送邮件的四种正确姿式，而且将核心代码提供给了你们。代码中有我很详细的注释，因此我对于代码以及相关类的讲解不多，感兴趣的同窗能够自行学习。最后，本项目Github地址：github.com/Snailclimb/…。

五 推荐一个本身的开源的后端文档

Java-Guide： Java面试通关手册（Java学习指南）。（star:1.4k）

Github地址：github.com/Snailclimb/…

文档定位：一个专门为Java后端工程师准备的开源文档，相信不论你是Java新手仍是已经成为一名Java工程师都能从这份文档中收获到一些东西。

你若怒放，清风自来。 欢迎关注个人微信公众号：“Java面试通关手册”，一个有温度的微信公众号。公众号有大量资料，回复关键字“1”你可能看到想要的东西哦！

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程