Velocity做为Java的模板引擎,在开发中,也会经常用到。下面做了一个Velocity的练习:把练习的代码记录了下来。
先把用到的lib包给发上:(其实可以不用log4j的。我这里使用了,顺便复习一下log4j)
commons-beanutils-1.7.0.jar、commons-collections-3.2.1.jar、commons-digester-1.8.jar、commons-lang-2.4.jar、commons-logging-1.1.jar、
log4j-1.2.12.jar、velocity-1.7.jar、velocity-1.7-dep.jar、velocity-tools-2.0.jar、velocity-tools-view-2.0.jar
首先在WebRoot下面新建一个文件夹template,在template下面,新建一个hellovelocity.vm的一个模板:
<!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>你好Velocity</title>
</head>
<body>
欢迎使用Velocity模板引擎 我是学习人:$name <br/><br/>
今天是: $date.<br/>
<h3>以下城市天气状况如下:</h3>
#foreach($citys in $list)
$citys
#end
</body>
</html>
里面的$name $date $list 这些是将要替换的变量。
下面新建log4j的属性文件和velocity的属性文件:
velocity.properties:
# 指定模板文件存放目录
file.resource.loader.path=template
# 指定日志文件位置
runtime.log=../logs/velocity.log
log4j.properties:
log4j.rootLogger=INFO,A1
log4j.addivity.org.apache=true
log4j.appender.A1=org.apache.log4j.RollingFileAppender
log4j.appender.A1.File=../logs/app.log
log4j.appender.A1.Append=false
log4j.appender.A1.Encoding=GBK
log4j.appender.A1.MaxFileSize=10KB
log4j.appender.A1.MaxBackupIndex=10
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=[velocity] %d - %c -%-4r [%t] %-5p %c %x - %m%n
log4j,我这里用的是文件超过了10KB,就新建一个备份,总共可以有10个备份。
接下来,我们新建一个servlet:
package com.zyujie.servlet;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.log4j.Logger;
import org.apache.velocity.Template;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.context.Context;
import org.apache.velocity.tools.view.VelocityViewServlet;
public class HelloServlet extends VelocityViewServlet {
private static final long serialVersionUID = 1L;
private Logger logger = Logger.getLogger(HelloServlet.class);
private VelocityEngine velocitypEngine;
public void init() throws ServletException {
logger.info("进入初始化Servlet...");
velocitypEngine = new VelocityEngine();// velocity引擎对象
Properties prop = new Properties();// 设置vm模板的装载路径
try {
prop = this.loadConfiguration();
logger.info("Velocity属性文件读取成功...");
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
try {
velocitypEngine.init(prop);// 初始化设置,下面用到getTemplate("*.vm")输出时;一定要调用velocitypEngine对象去做,即velocitypEngine.getTemplate("*.vm")
logger.info("Velocity引擎初始化...");
} catch (Exception e1) {
e1.printStackTrace();
}
}
protected Properties loadConfiguration() throws IOException, FileNotFoundException
{
//得到属性文件,找到后要加载
String propsFile = this.getInitParameter("org.apache.velocity.properties");
Properties prop = new Properties();
if (propsFile != null)
{
String realPath = getServletContext().getRealPath(propsFile);
if (realPath != null)
{
propsFile = realPath;
}
prop.load(new FileInputStream(propsFile));
}
//这里是日志的配置
String log = prop.getProperty(Velocity.RUNTIME_LOG);
if (log != null)
{
log = getServletContext().getRealPath(log);
if (log != null)
{
prop.setProperty(Velocity.RUNTIME_LOG, log);
}
}
// 设置模板文件的位置
String path = prop.getProperty(Velocity.FILE_RESOURCE_LOADER_PATH);
if (path != null)
{
path = getServletContext().getRealPath(path);
if (path != null)
{
prop.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path);
}
}
return prop;
}
protected Template handleRequest(HttpServletRequest request, HttpServletResponse response, Context ctx) {
ctx.put("name", "zhouyujie");
ctx.put("date", "2013-07-08");
//模板数据
String citybj ="beijing sunny<br/><br/>";
String citysh ="shanghai sunny<br/><br/>";
String citygz ="guangzhou sunny<br/><br/>";
String citysz ="shenzhen sunny<br/><br/>";
List<String> list = new ArrayList<String>();
list.add(citybj);
list.add(citysh);
list.add(citygz);
list.add(citysz);
// 数据 list添加到上下文环境 context 中去,它将在模板页面上显示
//list应和模板上的一样
ctx.put("list",list);
Template template = velocitypEngine.getTemplate("hellovelocity.vm");
return template;
}
}
该类继承了VelocityViewServlet,实现init方法,去读取属性文件。实现handleRequest返回velocity的模板。
最后是web.xml的配置。需要将这个servlet配置进去:
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<servlet>
<servlet-name>HelloServlet</servlet-name>
<servlet-class>com.zyujie.servlet.HelloServlet</servlet-class>
<init-param>
<param-name>org.apache.velocity.properties</param-name>
<param-value>
/WEB-INF/classes/velocity.properties
</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>HelloServlet</servlet-name>
<url-pattern>/HelloServlet</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>
init-param:把velocity的属性文件配置成name、value的方式,是为了防止在程序中使用硬编码。
好了,现在打开浏览器:http://127.0.0.1:8080/VelocityDemo/HelloServlet/,输出以下:
欢迎使用Velocity模板引擎 我是学习人:zhouyujie
今天是: 2013-07-08.
以下城市天气状况如下:
beijing sunnyshanghai sunny
guangzhou sunny
shenzhen sunny
一些Velocity的变量写法,可以参考其API。