Velocity练习：使用vm模板生成最简单的html页面

这几天要用到Velocity模板引擎去做一些页面，所以学习了下这个工具。我的jdk版本为 1.8.0_25

需要做的准备工作有：

1、建立一个Java工程，需要引用Velocity相关的jar包，这些jar包可从apache.org下载到最新版本。下载地址在：http://velocity.apache.org/download.cgi 。我下载的文件是velocity-tools-2.0.zip，将这些文件导入到项目中，就可以使用Velocity进行编码了。

2、安装Eclipse上的Velocity插件Veloedit。因为googlecode被gfw墙掉了，没有条件的朋友们可以安装网上下载到的离线安装版。这里还有一个需要注意，我的Eclipse版本为 Luna Service Release 1 (4.4.1)，这个版本必须要先利用Eclipse自带的update功能，下载“Elipse Tests, Examples, and Extras”。

我要用Velocity绘制一个通讯录的联系人资料页面，使用Balsamiq工具绘制的页面原型如下：

建立一个JavaProject，取名VelocityTool，里面新建两个java文件。

其中，VelocityHelper.java包含一个Velocity模板转换工具类，代码如下：

import java.io.File;
import java.io.FileWriter;

import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.app.VelocityEngine;

/**
 * 
 * @文件名称 VelocityHelper.java
 * @文件作者 Tsybius2014
 * @创建时间 2016年5月10日 下午2:14:01
 */
public class VelocityHelper {
    /**
     * 根据给定的vm模板和上下文生成html页面
     * @param inputVmFilePath vm模板
     * @param outputHtmlFilePath 输出html页面
     * @param context 上下文
     * @throws Exception
     */
    public static void generateHtml(String inputVmFilePath, String outputHtmlFilePath,
        VelocityContext context) throws Exception {
        try {
            Velocity.init();
            VelocityEngine engine = new VelocityEngine();
            Template template = engine.getTemplate(inputVmFilePath, "gbk");
            File outputFile = new File(outputHtmlFilePath); 
            FileWriter writer = new FileWriter(outputFile);
            template.merge(context, writer);
            writer.close();
        } catch (Exception ex) {
            throw ex;
        }
    }
}

VelocityTool.java中有main函数，代码如下：

import java.util.HashMap;
import java.util.Vector;

import org.apache.velocity.VelocityContext;

/**
 * 
 * @文件名称 VelocityTool.java
 * @文件作者 Tsybius2014
 * @创建时间 2016年5月10日 上午10:03:59
 */
public class VelocityTool {
    public static void main(String[] args) {
        try {
            VelocityContext context= new VelocityContext();
            context.put("name", "Kim Jung-un");
            context.put("gender", "Male");
            context.put("email", "XXX@XXX.gov");
            context.put("job", "Chairman of the WPK");
            context.put("company", "Workers' Party Of Korea (WPK)");
            context.put("address", "XXXXXXXXX, Pyongyang, North Korea");
            context.put("portraitPath", "file:///C:/Users/Tsybius/Desktop/kju.jpg");
            HashMap<String, String> hashMapContact = new HashMap<String, String>();
            hashMapContact.put("Tel", "XXX-XXXXXXXX");
            hashMapContact.put("Fax", "XXX-XXXXXXXX");
            hashMapContact.put("Mobile", "XXX-XXXX-XXXX");
            context.put("contactItems", hashMapContact);
            Vector<String> vectorRemark = new Vector<String>();
            vectorRemark.add("Kim Jong-un is the Chairman of the Workers' Party of Korea and supreme leader of the Democratic People's Republic of Korea (DPRK), commonly referred to as North Korea.");
            vectorRemark.add("Kim is the son of Kim Jong-il (1941–2011) and the grandson of Kim Il-sung (1912–1994).");
            vectorRemark.add("Kim obtained two degrees, one in Physics at Kim Il-sung University, and another as an Army officer at the Kim Il-sung Military University.");
            vectorRemark.add("Kim was named the World's 46th Most Powerful Person by the Forbes list of The World's Most Powerful People in 2013");
            context.put("remarks", vectorRemark);
            VelocityHelper.generateHtml(
                "velocity_test.vm", 
                "C:\\Users\\Tsybius\\Desktop\\output.html", 
                context);
            System.out.println("生成完毕");
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

模板velocity_test.vm是一个存储着人物通讯录的模板，代码如下：

#set($docDesc="VelocityTest")
#set($docAuthor="Tsybius2014")
#set($docDateTime="2016-05-10 14:29:04")
#set($docRemark="none")
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  <style type="text/css">
  </style>
  <head>
    <title>$!{name}</title>
  </head>
  <body>
    <table width="100%">
      <tr>
        <!-- Title -->
        <td align="center"><b>Address Book - $!{name}</b></td>
      </tr>
      <tr>
        <!-- BaseInfo -->
        <td>
          <table width="100%" height="100%">
            <tr>
              <td width="10%">Name:</td>
              <td width="30%">$!{name}</td>
              <td width="10%">Gender:</td>
              <td width="30%">$!{gender}</td>
              <td width="20%" rowspan="4">
                <img src="$!{portraitPath}" height="120" width="100"/>
              </td>
            </tr>
            <tr>
              <td width="10%">E-mail:</td>
              <td width="30%">$!{email}</td>
              <td width="10%">Job:</td>
              <td width="30%">$!{job}</td>
            </tr>
            <tr>
              <td width="10%">Company:</td>
              <td width="70%" colspan="3">$!{company}</td>
            </tr>
            <tr>
              <td width="10%">Address:</td>
              <td width="70%" colspan="3">$!{address}</td>
            </tr>
          </table>
        </td>
      </tr>
      <tr>
        <!-- Contact -->
        <td>
          <table width="100%" height="100%" >
            <tr>
              <td width="10%" align="left" valign="top">
                Contact:
              </td>
              <td>
                <table width="100%" height="100%" >
                  <tr>
                    <th></th>
                    <th align="left">Contact Type</th>
                    <th align="left">Contact Code</th>
                    <th></th>
                  </tr>
                  #foreach($contactItem in $contactItems.entrySet())
                    <tr>
                      <td align="left" width="5%">$velocityCount</td>
                      <td align="left" width="20%">$contactItem.key</td>
                      <td align="left" width="30%">$contactItem.value</td>
                      <td></td>
                    </tr>
                  #end 
                </table>
              </td>
            </tr>
          </table>
        </td>
      </tr>
      <tr>
        <!-- Remarks-->
        <td>
          <table width="100%" height="100%" >
            <tr>
              <td width="10%" align="left" valign="top">
                Remark:
              </td>
              <td>
                <table width="100%" height="100%" >
                  #foreach($remark in $remarks)
                    <tr>
                      <td>[$velocityCount] $remark</td>
                    </tr>
                  #end 
                </table>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>

以JavaApplication的方式运行本工程后，生成的HTML页面output.html如下：

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  <style type="text/css">
  </style>
  <head>
    <title>Kim Jung-un</title>
  </head>
  <body>
    <table width="100%">
      <tr>
        <!-- Title -->
        <td align="center"><b>Address Book - Kim Jung-un</b></td>
      </tr>
      <tr>
        <!-- BaseInfo -->
        <td>
          <table width="100%" height="100%">
            <tr>
              <td width="10%">Name:</td>
              <td width="30%">Kim Jung-un</td>
              <td width="10%">Gender:</td>
              <td width="30%">Male</td>
              <td width="20%" rowspan="4">
                <img src="file:///C:/Users/Tsybius/Desktop/kju.jpg" height="120" width="100"/>
              </td>
            </tr>
            <tr>
              <td width="10%">E-mail:</td>
              <td width="30%">kim001@northkorea.gov</td>
              <td width="10%">Job:</td>
              <td width="30%">Chairman of the WPK</td>
            </tr>
            <tr>
              <td width="10%">Company:</td>
              <td width="70%" colspan="3">Workers' Party Of Korea (WPK)</td>
            </tr>
            <tr>
              <td width="10%">Address:</td>
              <td width="70%" colspan="3">The Dark Side Laboratory, Pyongyang, North Korea</td>
            </tr>
          </table>
        </td>
      </tr>
      <tr>
        <!-- Contact -->
        <td>
          <table width="100%" height="100%" >
            <tr>
              <td width="10%" align="left" valign="top">
                Contact:
              </td>
              <td>
                <table width="100%" height="100%" >
                  <tr>
                    <th></th>
                    <th align="left">Contact Type</th>
                    <th align="left">Contact Code</th>
                    <th></th>
                  </tr>
                    <tr>
                      <td align="left" width="5%">1</td>
                      <td align="left" width="20%">Tel</td>
                      <td align="left" width="30%">XXX-XXXXXXXX</td>
                      <td></td>
                    </tr>
                    <tr>
                      <td align="left" width="5%">2</td>
                      <td align="left" width="20%">Fax</td>
                      <td align="left" width="30%">XXX-XXXXXXXX</td>
                      <td></td>
                    </tr>
                    <tr>
                      <td align="left" width="5%">3</td>
                      <td align="left" width="20%">Mobile</td>
                      <td align="left" width="30%">XXX-XXXX-XXXX</td>
                      <td></td>
                    </tr>
                  </table>
              </td>
            </tr>
          </table>
        </td>
      </tr>
      <tr>
        <!-- Remarks-->
        <td>
          <table width="100%" height="100%" >
            <tr>
              <td width="10%" align="left" valign="top">
                Remark:
              </td>
              <td>
                <table width="100%" height="100%" >
                  <tr>
                    <td>[1] Kim Jong-un is the Chairman of the Workers' Party of Korea and supreme leader of the Democratic People's Republic of Korea (DPRK), commonly referred to as North Korea.</td>
                  </tr>
                  <tr>
                    <td>[2] Kim is the son of Kim Jong-il (1941–2011) and the grandson of Kim Il-sung (1912–1994).</td>
                  </tr>
                  <tr>
                    <td>[3] Kim obtained two degrees, one in Physics at Kim Il-sung University, and another as an Army officer at the Kim Il-sung Military University.</td>
                  </tr>
                  <tr>
                    <td>[4] Kim was named the World's 46th Most Powerful Person by the Forbes list of The World's Most Powerful People in 2013</td>
                  </tr>
                </table>
              </td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </body>
</html>

使用 Firefox 46.0.1 打开此页面后效果图如下：

（部分内容摘自对应人物的维基百科页面）

END

来源：oschina

链接：https://my.oschina.net/u/1425762/blog/673610

标签

velocity

模板引擎