一个Maven实现的邮件模块

最新推荐文章于 2024-06-30 08:15:00 发布

Zachary1994

最新推荐文章于 2024-06-30 08:15:00 发布

阅读量4k

点赞数

分类专栏： Maven

本文链接：https://blog.csdn.net/zhang_zp2014/article/details/46958541

版权

Maven 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

下面是一个负责发送账户激活的邮件模块，基于Spring Framework。

1.首先是模块的POM

//pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.juvenxu.mvnbook.account</groupId>
  <artifactId>account-email</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <name>Account Email</name>
  
  <dependencies>
  	<dependency>
  		<groupId>org.springframework</groupId>
  		<artifactId>spring-core</artifactId>
  		<version>4.1.7.RELEASE</version>
  	</dependency>
  	<dependency>
  		<groupId>org.springframework</groupId>
  		<artifactId>spring-beans</artifactId>
  		<version>4.1.7.RELEASE</version>
  	</dependency>
  	<dependency>
  		<groupId>org.springframework</groupId>
  		<artifactId>spring-context</artifactId>
  		<version>4.1.7.RELEASE</version>
  	</dependency>
  	<dependency>
  		<groupId>org.springframework</groupId>
  		<artifactId>spring-context-support</artifactId>
  		<version>4.1.7.RELEASE</version>
  	</dependency>
  	<dependency>
  		<groupId>javax.mail</groupId>
  		<artifactId>mail</artifactId>
  		<version>1.4</version>
  	</dependency>
  	<dependency>
  		<groupId>junit</groupId>
  		<artifactId>junit</artifactId>
  		<version>4.12</version>
  		<scope>test</scope>
  	</dependency>
  	<dependency>
  		<groupId>com.icegreen</groupId>
  		<artifactId>greenmail</artifactId>
  		<version>1.4.1</version>
  		<scope>test</scope>
  	</dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.7</source>
          <target>1.7</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

这里简单说一下依赖部分。Spring之后是一个依赖为javax.mail:mail:1.4，这是实现发送邮件的类库。然后是junit:junit:4.12，Junit是Java社区事实上的单元测试标准，这里的scope元素为test，表示该依赖只被加入到测试代码的classpath中。随后的一来是com.icegreen:greenmail:1.4.1，其依赖范围同样为test，它是开源的邮件服务测试套件。

2.主代码部分

account-email只有一个简单的接口
//AccountEmailService.java

package com.juvenxu.mvnbook.account.email;

public interface AccountEmailService
{
	//根据接收地址，邮件主题，邮件内容发送html格式的邮件
    void sendMail( String to, String subject, String htmlText )
        throws AccountEmailException;
}

这里的sendMail()方法用来发送html格式的邮件，to为接收地址，subject为邮件主题，htmlText为邮件内容。如果出错则抛出AccountEmailException异常。该异常定义如下

//AccountEmailException.java

package com.juvenxu.mvnbook.account.email;

public class AccountEmailException
    extends Exception
{
    private static final long serialVersionUID = -4817386460334501672L;

    public AccountEmailException( String message )
    {
        super( message );
    }

    public AccountEmailException( String message, Throwable throwable )
    {
        super( message, throwable );
    }
}

然后是AccountEmailService的实现：

//AccountEmailServiceImpl.java

package com.juvenxu.mvnbook.account.email;

import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;

import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;

public class AccountEmailServiceImpl
    implements AccountEmailService
{
    private JavaMailSender javaMailSender;

    private String systemEmail;

    public void sendMail( String to, String subject, String htmlText )
        throws AccountEmailException
    {
        try
        {
            MimeMessage msg = javaMailSender.createMimeMessage();
            MimeMessageHelper msgHelper = new MimeMessageHelper( msg );

            msgHelper.setFrom( systemEmail );		//设置发送地址
            msgHelper.setTo( to );			//设置收件地址
            msgHelper.setSubject( subject );		//设置主题
            msgHelper.setText( htmlText, true );	//设置邮件内容为html格式

            javaMailSender.send( msg );			//使用JavaMailSender发送邮件
        }
        catch ( MessagingException e )
        {
            throw new AccountEmailException( "Faild to send mail.", e );
        }
    }

    public JavaMailSender getJavaMailSender()
    {
        return javaMailSender;
    }

    public void setJavaMailSender( JavaMailSender javaMailSender )
    {
        this.javaMailSender = javaMailSender;
    }

    public String getSystemEmail()
    {
        return systemEmail;
    }

    public void setSystemEmail( String systemEmail )
    {
        this.systemEmail = systemEmail;
    }
}

该实现类有一个私有字段javaMailSender，该字段的类型JavaMailSender来自于Spring的工具类库。在sendMail()的方法视线中，首先使用javaMailSender创建一个MimeMessage，它对应了将要发送的邮件。接着使用MimeMessageHelper帮助设置该邮件的发送地址、收件地址、主题及内容。

该代码中没有邮件服务器配置信息，这是因为有Spring Framework的依赖注入，这些配置都通过外部的配置注入到了javamailSender中。相关配置信息都在account-email.xml中，放在src/main/resources/目录下

//account-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"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.1.xsd">

	<bean id="propertyConfigurer"
		class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
		<property name="location" value="classpath:service.properties" />
	</bean>

	<bean id="javaMailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl">
		<property name="protocol" value="${email.protocol}" />
		<property name="host" value="${email.host}" />
		<property name="port" value="${email.port}" />
		<property name="username" value="${email.username}" />
		<property name="password" value="${email.password}" />
		<property name="javaMailProperties">
			<props>
				<prop key="mail.${email.protocol}.auth">${email.auth}</prop>
			</props>
		</property>
	</bean>

	<bean id="accountEmailService"
		class="com.juvenxu.mvnbook.account.email.AccountEmailServiceImpl">
		<property name="javaMailSender" ref="javaMailSender" />
		<property name="systemEmail" value="${email.systemEmail}" />
	</bean>
</beans>

Spring Framework使用该XML配置创建ApplicationContext，以实现依赖注入。该配置文件定义了一些bean，对应了Java程序中多个对象。id为propertyConfigurerer的bean，其实现为PropertyPlaceholderConfigurer，这是Spring中用来帮助载入properties的组件。这里location定义的值表示从classpath的根路径下载入名为email.properties文件。

接着定义id为javaMailSender的bean，其实现为JavaMailSenderImpl，这里需要定义邮件服务器的一些配置，包括协议，主机，端口，用户名，密码等。这段配置还使用了Spring的属性引用，这么做可以将邮件服务器相关配置分离到外部的properties文件中。

最后定义了accountEmailService的bean，对应了之前描述的AccountEmailServiceImpl，配置中将另外一个bean javaMailSender注入，使其成为该类的字段值。

3.测试部分代码

首先根据上面Spring的配置，在src/test/resources/目录下创建邮件服务器的配置文件。

//service.properties

email.protocol=smtp
email.host=localhost
email.port=25
email.username=zachary@mymail.com
email.password=123456
email.auth=true
email.systemEmail=test@mymail.com

然后就是测试代码。这里主要测试sendMail()接口。

package com.juvenxu.mvnbook.account.email;

import static org.junit.Assert.*;

import javax.mail.Message;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.icegreen.greenmail.util.GreenMail;
import com.icegreen.greenmail.util.GreenMailUtil;
import com.icegreen.greenmail.util.ServerSetup;

public class AccountEmailServiceTest {
	private GreenMail greenMail; // 使用GreenMail作为测试服务器

	@Before
	// Before注解表示会先于测试方法@Test执行
	public void startMailServer() throws Exception {
		greenMail = new GreenMail(ServerSetup.SMTP); // 基于SMTP协议初始化GreenMail
		greenMail.setUser("zachary@mymail.com", "123456"); // 创建一个邮件账户
		greenMail.start(); // 启动邮件服务
	}

	@Test
	public void testSendMail() throws Exception {
		// 根据account-email.xml的配置创建ApplicationContext
		ApplicationContext ctx = new ClassPathXmlApplicationContext(
				"account-email.xml");
		// 从ctx中获取要测试的id为accountEmailService的bean，并转换成AccountEmailService接口
		AccountEmailService accountEmailService = (AccountEmailService) ctx
				.getBean("accountEmailService");

		String subject = "Test Subject"; // 设置邮件主题
		String htmlText = "<h3>Test</h3>"; // 设置邮件内容
		accountEmailService.sendMail("test@mymail.com", subject, htmlText); // 发送邮件

		greenMail.waitForIncomingEmail(2000, 1); // 接收一封邮件最多等待2秒

		Message[] msgs = greenMail.getReceivedMessages(); // 读取收到的邮件
		assertEquals(1, msgs.length); // 检查邮件的数目
		// //第一封邮件的主题及内容
		assertEquals(subject, msgs[0].getSubject());
		assertEquals(htmlText, GreenMailUtil.getBody(msgs[0]).trim());
	}

	@After
	public void stopMailServer() throws Exception {
		greenMail.stop();			//停止邮件服务
	}
}

这样一个简单的邮件模块就完成了。

参考：《Maven实战》第5章——徐晓斌著