Velocity学习之Servlet初体验

Velocity学习系列 之 Servlet应用

在基于WEB的应用中,通常大多数情况下是在servlet里使用Velocity。在servlet里的Velocity基本应用是非常简单的,你只需通过两个必要步骤就可以实现:

一、继承org.apache.velocity.servlet.VelocityServlet抽象类:
public class SampleServlet extends VelocityServlet

二、仅需实现VelocityServlet类的一个方法handleRequest():
public Template handleRequest( HttpServletRequest req, HttpServletResponse resp, Context context) {}

下面是例子(也是Velocity发行包自带的例子)。
一、准备工作
本例按如下结构建立一个web应用:
VelocityAppWeb
|____log
|____templates
| |____sample.vm
|____WEB_INF
|____classes
| |____your_full_path_servlet.class
| |____velocity.properties
|____lib
| |____velocity-dep-1.4.jar
|____web.xml


这里我们使用了velocity.properties配置文件,通过这个文件我们可以灵活地进行一些运行期的配置, 本例中,我们指定了模板文件和日志文件的位置。

二、servlet类及相关文件编写
1、 Velocity配置文件 velocity.properties :

# 指定模板文件存放目录
file.resource.loader.path = templates
# 指定日志文件位置
runtime.log = log/velocity.log

注意一下:键的名字即key是固定的,具体请参考veloctiy开发指南。

2、 模板文件 sample.vm :
<html>
<head><title>Sample velocity page</title></head>
<body bgcolor="#ffffff">
<center>
<h2>Hello,welcome to velocity's world!</h2>
<i>Here's the list of people</i>
<table cellspacing="0" cellpadding="5" width="100%">
<tr>
<td bgcolor="#eeeeee" align="center">Names</td>
</tr>
#foreach ($name in $theList)
<tr>
<td bgcolor="#eeeeee">$name</td>
</tr>
#end
</table>
</center>
</html>

3、servlet类 SampleServlet.java :
package com.cyberobject.study.velocity.servlet;

import java.io.IOException;
import java.io.FileNotFoundException;
import java.io.FileInputStream;
import java.util.Properties;
import java.util.Vector;
import javax.servlet.ServletConfig;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.ServletException;
import org.apache.velocity.Template;
import org.apache.velocity.context.Context;
import org.apache.velocity.servlet.VelocityServlet;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.exception.ParseErrorException;
/**
* @version 1.0
* @author
*/
public class SampleServlet extends VelocityServlet
{
protected Properties loadConfiguration(ServletConfig config)throws IOException, FileNotFoundException{
/*
* 得到属性配置文件并load它
*/
String propsFile = config.getInitParameter(INIT_PROPS_KEY);
Properties p = new Properties();
if (propsFile != null){
String realPath = getServletContext().getRealPath(propsFile);
if (realPath != null){
propsFile = realPath;
}
p.load(new FileInputStream(propsFile));
}
/*
* 设置velocity日志文件在web应用中的位置
*/
String log = p.getProperty(Velocity.RUNTIME_LOG);
if (log != null){
log = getServletContext().getRealPath(log);
if (log != null) {
p.setProperty(Velocity.RUNTIME_LOG, log);
}
}
/*
* 设置模板文件在web应用中的位置
*/
String path = p.getProperty(Velocity.FILE_RESOURCE_LOADER_PATH);
if (path != null){
path = getServletContext().getRealPath(path);
if (path != null){
p.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path);
}
}
return p;
}

public Template handleRequest(HttpServletRequest request,HttpServletResponse response,Context ctx){
String p1 = "Bob";
String p2 = "Harold";
Vector personList = new Vector();
personList.addElement(p1);
personList.addElement(p2);
/*
* 将模板数据 list 放置到上下文环境 context 中去
*/
ctx.put("theList", personList);
/*
* 获取模板对象,有三种可能产生的异常
*/
Template outty = null;
try{
outty = getTemplate("sample.vm");
} catch (ParseErrorException pee){
System.out.println(
"SampleServlet : parse error for template " + pee);
}catch (ResourceNotFoundException rnfe){
System.out.println("SampleServlet : template not found " + rnfe);
}catch (Exception e){
System.out.println("Error " + e);
}
return outty;
}
}
4、 Web应用程序配置文件 web.xml :
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app id="WebApp">
<display-name>VelocityAppWeb</display-name>
<servlet>
<servlet-name>SampleServlet</servlet-name>
<display-name>SampleServlet</display-name>
<servlet-class>com.cyberobject.study.velocity.servlet.SampleServlet</servlet-class>
<init-param>
<param-name>org.apache.velocity.properties</param-name>
<param-value>/WEB-INF/classes/velocity.properties</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>SampleServlet</servlet-name>
<url-pattern>/SampleServlet</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>
三、发布及运行
编译后,你可以发布到你熟悉的应用服务器中去,如Tomcat等。启动服务器,在浏览器中输入:http://localhost: 8080/VelocityAppWeb/servlet/SampleServlet,可看到如下结果:(略,请下载源文件运行)

在servlet中使用Velocity的步骤和在独立应用程序中是基本相似的:
1、获得并初始化一个模板引擎;
2、以模板文件名为参数,调用getTemplate()得到一个模板对象;
3、创建一个上下文环境对象,并将模板数据放入上下文环境中;
4、合并(merge)模板和数据并产生一个输出。
事实上,有很多步骤如1、4,VelocityServlet基类都已经帮我们做了,就连3中的创建上下文环境对象都已经代劳了,你所要做的仅仅是通过指定模板文件名获得一个模板对象和将数据put到上下文中去,还是很简单吧?!呵呵。

注意事项:
1、不要在servlet中实现doGet()和doPost()方法。VelocityServlet已经帮你完成了。
2、web.xml文件中SampleServlet的初始化参数name的写法: org.apache.velocity.properties,这是固定的,它是VelocityServlet中的常量INIT_PROPS_KEY 对应的值。当然如果在你的servlet中loadConfiguration()方法中不使用该常量名时,你也可以随便取名,只要和这里的
String propsFile = config.getInitParameter(INIT_PROPS_KEY);参数名对应上即可。

[color=red]最后注意一个问题,那就是templates要放在WebContent主目录下!

解决乱码:resp.setCharacterEncoding("UTF-8");[/color]

还有其他的方式:
1.首先要确保开发工具(如MyEclipse),WEB服务器(如Tomcat),数据库 (如 MySql)采用的是同一种编码。

1.1 MyElcipse的配置:
对着工程项目按右键,点属性-->资源,在text file encoding里选GBK。

1.2 MyEclipse自带的Tomcat的配置:
强烈建议先装一个Apache Tomcat6.0,再把安装目录下的conf文件夹复制,放到MYEclipse的工程文件里的.data下的.plugins下的 com.genuitec.eclipse.easie.tomcat.myeclipse下的tomcat,把Tomca下的conf覆盖掉。
注:这是解决MyEclipse自带的Tomcat乱码问题最有效的解决办法。

然后修改conf文件下的server.xml文件,在server.xml里的
<Connector port="8080" .... />字段后
增加对GET方法获取数据时的编码设置参数 URIEncoding="GBK"
增加对Post方法获取数据时的编码设置参数 useBodyEncodingForURI="true" 即<Connector port="8080" ... URIEncoding="GBK" useBodyEncodingForURI="true"/>
若是用Apache Tomcat去运行Web程序,同理也是像上面一样修改。

1.3 修改MySql的编码:
建议下一个MySql Gui工具,打开MySql adminstrator ,在startup variables

项里的advanced下的Def.char Set里写进GBk。


2.设置velocity的编码设置

2.1 这里有两种方法,网上的文章一般是讲这些。

方法一:修改Veloicity.properties配置文件,加入以下信息
input.encoding=GBK
output.encoding=GBk

方法二:写到这里,顺便把velocity经常找不到vm文件的解决方法也加进去了
在关键servelt类里定义一个私有对象
private VelocityEngine velo; //velocity引擎对象

再在servelt类里的init()方法里加入以下语句去加入一些属性设置
velo = new VelocityEngine();
//设置vm模板的装载路径
Properties prop = new Properties();
String path = this.getServletContext().getRealPath("/");
//"template/" 是指定你的vm文件放在WEBROOT下的template,根据
// 你工程的vm文件位置的不同而作相应的变化
prop.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path + "template/");

//设置velocity的编码
prop.setProperty(Velocity.ENCODING_DEFAULT, "GBK");
prop.setProperty(Velocity.INPUT_ENCODING, "GBK");
prop.setProperty(Velocity.OUTPUT_ENCODING, "GBK");
try {
//初始化设置,下面用到getTemplate("*.vm")输出时
//一定要调用velo对象去做,即velo.getTemplate("*.vm")
velo.init(prop);
} catch (Exception e1) {
e1.printStackTrace();
}

2.2 接着,就是整个问题解决的关键之处了,在doGet()和doPost()方法的最初加入两条语句
request.setCharacterEncoding("GBK");
response.setContentType("text/html;charset=GBK");
为什么要加入这两句呢?因为Velocity源码中根本就没这两个参数,加入以后,无论是请求或回应,都会按GBK的编码去传递了。

3.当然,在所有的vm文件和JSP文件里也要加入 pageEncoding="GBK" 。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值