Java笔记-SpringMVC中利用Velocity渲染HTML发送邮件

Velocity：基于Java的模板引擎，可以用Java代码渲染的简单而又强大的模板语言。开发Web时，可以将Web页面和Java代码分离，类似JSP和PHP。详细介绍：参见官网：Apache Velocity Project

本篇文章以发送邮件为例子，介绍一下Velocity简单的实际用法

步骤：pom.xml引入包 => xml文件添加配置 => 配置视图 => Java代码

步骤一：maven添加依赖包

pom.xml文件里引入下面的配置代码

  org.apache.velocity
  velocity
  1.7


  org.apache.velocity
  velocity-tools
  2.0

步骤二：xml里面添加Velocity配置

在配置文件applicationContext.xml中加入配置，这里可以有两种方式

• 配置文件方式，即Velocity的属性通过配置文件方式来设置

resources下面新建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  

• 直接设置属性方式，即Velocity的属性通过标签直接设置，也就是将第一种方式合为一步，省去单独设置配置文件的麻烦

        
            
            
            loopCounter    
            0   
            text/html;charset=UTF-8 
            UTF-8 
            UTF-8
            
      

步骤三：配置视图

在WEB-INF路径下新建velocity文件夹，文件夹里新建后缀为vm的模板文件，这里说的文件路径对应步骤二中的模板存放路径

下面是一个简单的邮件模板，模板内容是一个表格，也就是发送一个内容为一个表格的邮件。其中，表格的body是通过二层for循环动态设定的数据，具体的velocity语法，自行百度

    
    
    


数据日期:${date}

        #foreach($rowData in $data)
        
            #foreach($columnData in $rowData)
                
            #end
        
        #end
    

    

    

        
数据A
        
数据B
        
数据C
        
数据D
    
    
    
$columnData

步骤四：Java代码初始化数据

这里不介绍具体的发送邮件的Api，类似JavaMail的库网上很多。步骤三中写好了模板文件，现在需要利用Java代码将数据填充到模板文件里面，这里用Map数据结构存放需要渲染的原始数据

private void sendMail() throws JobExecutionException {
        String[] to = { "收件人" };
        String subject = "主题";
        String[] cc = {};
        Map model = new HashMap<>();
        model.put("date", "2017-09-17");
        List data = new ArrayList<>();
        List row1 = new ArrayList();
        list.add("A data");
        list.add("B data");
        list.add("C data");
        list.add("D data");
        List row2 = new ArrayList();
        list.add("A data");
        list.add("B data");
        list.add("C data");
        list.add("D data");
        data.add(row1);
        data.add(row2);
        model.put("data", list);
        String body = VelocityEngineUtils.mergeTemplateIntoString(velocityEngine, "DataValidator.vm", "UTF-8", model);
        try {
            EmailUtil.send(to, subject, body, cc);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

注意，velocityEngine需要注入一下这个实例，例如在serviceImpl中通过@Autowired注入

@Autowired
private VelocityEngine velocityEngine;