使用spring发送Mail + Velocity 模板 - 中文乱码解决

最新推荐文章于 2021-08-09 09:26:53 发布

原创最新推荐文章于 2021-08-09 09:26:53 发布 · 2.4k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#velocity #spring #string #encoding #file #null

Spring + Hibernate 专栏收录该内容

1 篇文章

订阅专栏

本文档详细介绍了在使用Spring和Velocity发送带有中文内容的邮件时遇到的乱码问题及其解决方案。主要涉及两个方面：1. 模板中的静态中文信息显示乱码，通过设置`MimeMessageHelper`的字符集为`UTF-8`来解决。2. 附件文件名显示乱码，使用`MimeUtility.encodeWord()`方法进行编码转换。同时提供了pom.xml中所需的依赖，以及配置邮件发送的相关XML和具体代码实现。

1- 出现model中的中文信息显示正常，而模板中的静态中文信息显示乱码

我的模板是用html进行编写的，而且html模板是UTF-8的,使用如下代码会出现乱码。

String text = VelocityEngineUtils.mergeTemplateIntoString(

velocityEngine, template, model);

改成如下代码即可：

     ---- > MimeMessageHelper help = new MimeMessageHelper(message, true, "UTF-8");

             String text = VelocityEngineUtils.mergeTemplateIntoString(
                    velocityEngine, template, "UTF-8", model);
             这样就不会出现乱码了。

2- 附件文件名显示乱码

我是直接使用得到文件名称，使用如下代码会出现乱码。

messageHelper.addAttachment(file.getName(), file);

改成如下代码即可：这样就不会出现乱码了。

---- >

messageHelper.addAttachment(MimeUtility.encodeWord(file.getName(),"UTF-8",null), file);

附上代码：

1.pom.xml 追加   （使用的包：org.apache.velocity 和 javax.mail )

    <dependency>
      <groupId>org.apache.velocity</groupId>
      <artifactId>velocity</artifactId>
      <version>1.5</version>
    </dependency>

    <dependency>
      <groupId>javax.mail</groupId>
      <artifactId>mail</artifactId>
      <version>1.4</version>
    </dependency>

2. mail ( SMTP设置)

mail.properties
mail.default.from=xxxx@163.com mail.host=xxx.xxx.xxx.xxx mail.port=25 mail.username=test mail.password=1234 mail.smtp.auth=false mail.smtp.timeout=25000 mail.templatePath=mail/ templatePaht 是指定了模板文件在class路径下。

a3. spring 必要Xml追加
applicationContext.xml ： (MailSupportContext.xml)

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"> <beans>  <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"> <property name="locations"> <list> <value>classpath:mail.properties</value> </list> </property> </bean> <bean id="mailSender" class="org.springframework.mail.javamail.JavaMailSenderImpl"> <property name="host"> <value>${mail.host}</value> </property> <property name="port"> <value>${mail.port}</value> </property> <property name="username"> <value>${mail.username}</value> </property> <property name="password"> <value>${mail.password}</value> </property> <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>  <bean id="velocityEngine" class="org.springframework.ui.velocity.VelocityEngineFactoryBean"> <property name="velocityProperties"> <props> <prop key="resource.loader">class</prop> <prop key="class.resource.loader.class"> org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader </prop> <prop key="velocimacro.library"></prop> <prop key="input.encoding">UTF-8</prop> <prop key="output.encoding">UTF-8</prop> <prop key="default.contentType">text/html; charset=UTF-8</prop> </props> </property> </bean>  <bean id="mailMessage" class="org.springframework.mail.SimpleMailMessage" singleton="false" > <property name="from"> <value>${mail.default.from}</value> </property> </bean> <bean id="SendMail" class="commons.web.mail.impl.SendMailImpl"> <property name="mailSender" ref="mailSender" /> <property name="message" ref="mailMessage" /> <property name="velocityEngine" ref="velocityEngine" /> <property name="templatePath"> <value>${mail.templatePath}</value> </property> </bean>  <bean id="SendMimeMail" class="commons.web.mail.impl.SendMailImpl"> <property name="mailSender" ref="mailSender" /> <property name="velocityEngine" ref="velocityEngine" /> <property name="templatePath"> <value>${mail.templatePath}</value> </property> </bean> </beans>

4. SendMail詳細コード
commons.mail.MailData.java

package commons.web.mail; import java.io.File; import java.util.Date; import java.util.HashMap; import java.util.Map; import org.springframework.util.StringUtils; public class MailData { private String encoding = "utf-8"; private Date sentDate; private String from; private String to; private String[] toList; private String cc; private String[] ccList; private String bcc; private String[] bccList; private String subject; private String templateFile; private Map sendData = new HashMap(); private File attachedFile ; private File[] attachedFileList ; /** * @return the bcc */ public String getBcc() { return bcc; } /** * Set to bcc * @param bcc */ public void setBcc(String bcc) { this.bcc = bcc; } /** * @return the bccList */ public String[] getBccList() { return bccList; } /** * Set to bccList * @param bccList */ public void setBccList(String[] bccList) { this.bccList = bccList; } /** * @return the cc */ public String getCc() { return cc; } /** * Set to cc * @param cc */ public void setCc(String cc) { this.cc = cc; } /** * @return the ccList */ public String[] getCcList() { return ccList; } /** * Set to ccList * @param ccList */ public void setCcList(String[] ccList) { this.ccList = ccList; } /** * @return the encoding */ public String getEncoding() { return encoding; } /** * Set to encoding * @param encoding */ public void setEncoding(String encoding) { this.encoding = encoding; } /** * @return the from */ public String getFrom() { return from; } /** * Set to from * @param from */ public void setFrom(String from) { this.from = from; } /** * @return the subject */ public String getSubject() { return subject; } /** * Set to subject * @param subject */ public void setSubject(String subject) { this.subject = subject; } /** * @return the templateFile */ public String getTemplateFile() { return templateFile; } /** * Set to templateFile * @param templateFile */ public void setTemplateFile(String templateFile) { this.templateFile = templateFile; } /** * @return the to */ public String getTo() { return to; } /** * Set to to * @param to */ public void setTo(String to) { this.to = to; } /** * @return the toList */ public String[] getToList() { return toList; } /** * Set to toList * @param toList */ public void setToList(String[] toList) { this.toList = toList; } /** * @return the sendData */ public Map getSendData() { return sendData; } /** * Set to sendData * @param sendData */ public void setSendData(Map sendData) { this.sendData = sendData; } /** * @return the attachedFile */ public File getAttachedFile() { return attachedFile; } /** * Set to attachedFile * @param attachedFile */ public void setAttachedFile(File attachedFile) { this.attachedFile = attachedFile; } /** * @return the attachedFileList */ public File[] getAttachedFileList() { return attachedFileList; } /** * Set to attachedFileList * @param attachedFileList */ public void setAttachedFileList(File[] attachedFileList) { this.attachedFileList = attachedFileList; } /** * @return the sentDate */ public Date getSentDate() { return sentDate; } /** * Set to sentDate * @param sentDate */ public void setSentDate(Date sentDate) { this.sentDate = sentDate; } public String toString() { StringBuffer sb = new StringBuffer("SimpleMailMessage: "); sb.append("from=").append(this.from).append("; "); sb.append("to=").append((this.to)).append("; "); sb.append("cc=").append((this.cc)).append("; "); sb.append("bcc=").append((this.bcc)).append("; "); sb.append("sentDate=").append(this.sentDate).append("; "); sb.append("subject=").append(this.subject).append("; "); sb.append("text=").append(sendData.toString()); return sb.toString(); } }

commons.mail.SendMail.java
commons.mail.Impl.SendMailImpl.java

import java.io.File; import java.io.UnsupportedEncodingException; import java.util.Date; import java.util.Map; import javax.mail.MessagingException; import javax.mail.internet.MimeMessage; import javax.mail.internet.MimeUtility; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.velocity.app.VelocityEngine; import org.apache.velocity.exception.VelocityException; import org.springframework.mail.SimpleMailMessage; import org.springframework.mail.javamail.JavaMailSender; import org.springframework.mail.javamail.MimeMessageHelper; import org.springframework.ui.velocity.VelocityEngineUtils; import org.springframework.util.Assert; public class SendMailImpl implements SendMail{ protected static final Log log = LogFactory.getLog(SendMailImpl.class); private String templatePath; private JavaMailSender mailSender; private VelocityEngine velocityEngine; private SimpleMailMessage message; public void setTemplatePath(String templatePath) { this.templatePath = templatePath; } public void setMessage(SimpleMailMessage message) { this.message = message; } public void setVelocityEngine(VelocityEngine velocityEngine) { this.velocityEngine = velocityEngine; } public void setMailSender(JavaMailSender mailSender) { this.mailSender = mailSender; } /** * send Simple mail * @param modelData * @throws MessagingException */ public void sendEmail(MailData modelData) throws MessagingException{ log.info("Begin: " + "send mail: " + this.getClass().getSimpleName() ); log.info("send mail: " + this.getClass().getSimpleName() + " : " + modelData.toString()); String encodeing = modelData.getEncoding(); Date sentDate = modelData.getSentDate(); Map sendMailData = modelData.getSendData(); String from = modelData.getFrom(); String to = modelData.getTo(); String[] toList = modelData.getToList(); String cc = modelData.getCc(); String[] ccList = modelData.getCcList(); String bcc = modelData.getBcc(); String[] bccList = modelData.getBccList(); String subject = modelData.getSubject(); String templateFile = modelData.getTemplateFile(); if (StringUtil.isNotBlank(from)){ message.setFrom(from); } if (StringUtil.isNotBlank(to)){ message.setTo(to); } if ( toList != null && toList.length > 0){ message.setTo(toList); } if (StringUtil.isNotBlank(cc)){ message.setCc(cc); } if (ccList != null && ccList.length > 0){ message.setCc(ccList); } if (StringUtil.isNotBlank(bcc)){ message.setBcc(bcc); } if (bccList != null && bccList.length > 0){ message.setBcc(bccList); } if (StringUtil.isNotBlank(subject)){ message.setSubject(subject); }else{ message.setSubject(" "); } if (sentDate != null){ message.setSentDate(sentDate); } String result = null; try { result = VelocityEngineUtils.mergeTemplateIntoString( velocityEngine, templatePath + templateFile, encodeing, sendMailData); } catch (VelocityException e) { log.info("send mail error (emplate file): " + templateFile ); e.printStackTrace(); } message.setText(result); mailSender.send(message); log.info("End: " + "send mail: " + this.getClass().getSimpleName() ); } /** * send mime mail * @param modelData * @throws MessagingException */ public void sendMimeEmail(MailData modelData) throws MessagingException { log.info("Begin: " + "send mime mail: " + this.getClass().getSimpleName() ); log.info("send mime mail: " + this.getClass().getSimpleName() + " : " + modelData.toString()); String encodeing = modelData.getEncoding(); Date sentDate = modelData.getSentDate(); Map sendMailData = modelData.getSendData(); String from = modelData.getFrom(); String to = modelData.getTo(); String[] toList = modelData.getToList(); String cc = modelData.getCc(); String[] ccList = modelData.getCcList(); String bcc = modelData.getBcc(); String[] bccList = modelData.getBccList(); String subject = modelData.getSubject(); String templateFile = modelData.getTemplateFile(); MimeMessage message = mailSender.createMimeMessage(); MimeMessageHelper messageHelper = new MimeMessageHelper(message, true, encodeing); if (StringUtil.isNotBlank(from)){ messageHelper.setFrom(from); } if (StringUtil.isNotBlank(to)){ messageHelper.addTo(to); } if (toList != null && toList.length > 0){ for (String toS : toList ){ messageHelper.addTo(toS); } } if (StringUtil.isNotBlank(cc)){ messageHelper.addCc(cc); } if (ccList != null && ccList.length > 0){ for (String ccS : ccList ){ messageHelper.addCc(ccS); } } if (StringUtil.isNotBlank(bcc)){ messageHelper.addBcc(bcc); } if (bccList != null && bccList.length > 0){ for (String bccS : bccList ){ messageHelper.addBcc(bccS); } } if (StringUtil.isNotBlank(subject)){ messageHelper.setSubject(subject); }else{ messageHelper.setSubject(" "); } if (sentDate != null){ messageHelper.setSentDate(sentDate); } String result = null; try { Assert.notNull(templateFile, "templateFile must not be null"); result = VelocityEngineUtils.mergeTemplateIntoString( velocityEngine, templatePath + templateFile, encodeing, sendMailData); } catch (VelocityException e) { log.info("send mime mail error(mergeTemplateIntoString) : template file: " + templateFile); e.printStackTrace(); } messageHelper.setText(result,true); //ClassPathResource file = new ClassPathResource("/mail/test.txt"); File attachedFile = modelData.getAttachedFile(); if (attachedFile.isFile()){ try { messageHelper.addAttachment(MimeUtility.encodeWord(attachedFile.getName(), encodeing, null), attachedFile); } catch (UnsupportedEncodingException e) { log.info("send mime mail error (encodeWord attachment filename): " + attachedFile.getName()); e.printStackTrace(); } } File attachedFileList[] = modelData.getAttachedFileList(); if ( attachedFileList !=null ){ for (File attachedFileS : attachedFileList ){ if (attachedFileS.isFile()){ try { messageHelper.addAttachment(MimeUtility.encodeWord(attachedFileS.getName(),encodeing,null), attachedFileS); } catch (UnsupportedEncodingException e1) { log.info("send mime mail error (encodeWord attachment filename):each : " + attachedFileS.getName()); e1.printStackTrace(); } } } } mailSender.send(message); log.info("End: " + "send mime mail: " + this.getClass().getSimpleName() ); } }

5.test code
common.mail.SendmailTest.java

package commons.mail; import java.io.File; import java.util.HashMap; import java.util.Map; import javax.mail.MessagingException; import commons.web.mail.MailData; import commons.web.mail.impl.SendMailImpl; import junit.framework.TestCase; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class SendMailTest extends TestCase { String[] paths = { "MailSupportContext.xml" }; ApplicationContext ctx = new ClassPathXmlApplicationContext(paths); SendMailImpl s = (SendMailImpl) ctx.getBean("SendMail"); SendMailImpl s1 = (SendMailImpl) ctx.getBean("SendMimeMail"); protected void setUp() throws Exception { super.setUp(); } protected void tearDown() throws Exception { super.tearDown(); } /* * Test method for 'net.pms.email.SendMail.sendEmail(Map)' */ public void testSendEmail() throws MessagingException { Map model = new HashMap(); model.put("message", "msg本来你有"); model.put("username", "jack测试 "); model.put("Password", "666666"); model.put("applicationURL", "www.163.com.cn"); MailData maildata = new MailData(); maildata.setSendData(model); maildata.setTo("zzzzz@163.com.cn"); String toList[] = new String[]{"zzzzzzz@163.com.cn","xxxxx@163.com.cn"}; maildata.setToList(toList); maildata.setFrom("abc@spring.test.cn"); maildata.setSubject("test --- "); maildata.setTemplateFile("accountCreatedHtml.vm"); s.sendEmail(maildata); } public void testSendMimeEmail() throws MessagingException { Map model = new HashMap(); model.put("message", "msg本来你有"); model.put("username", "jack测试 --　 "); model.put("Password", "666666"); model.put("applicationURL", "www.163.com.cn"); MailData maildata = new MailData(); maildata.setSendData(model); maildata.setEncoding("UTF-8"); maildata.setTo("xxxx@163.com.cn"); String toList[] = new String[]{"xxxsss@163.com.cn","rfrrrr@163.com.cn"}; maildata.setToList(toList); maildata.setFrom("mime@spring.test.cn"); maildata.setSubject("---- test 测试介绍"); maildata.setTemplateFile("accountCreatedHtml.vm"); File file = new File("c:/ZSX.txt"); maildata.setAttachedFile(file); s1.sendMimeEmail(maildata); } }