应用启动时加载XML文档(Digester的用法)

今天有了个新的需求，去要在启动web应用时加载一个xml文档到serlvet的application范围中。于是乎在网上找了些资料。现在把它整理在下面，以便以后用到可以有个回顾，也希望对访客们有个帮助作用。

 

首先我们需要做一些准备工作。

第一步：在web.xml文件中配置你需要在启动web服务器时加载的类(如：tomcat)，以我的例子而言，他的代码段如下。

 <servlet> <servlet-name>userdatabase</servlet-name> <servlet-class>address.servlet.UserDatabaseServlet</servlet-class> <init-param> <param-name>debug</param-name> <param-value>2</param-value> </init-param> <init-param> <param-name>pathname</param-name> <param-value>/WEB-INF/userdatabase.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet>

作出说明：

servlet-name随意取，只要是有意义的。

serlvet-class为你项目中处理类所对应的路径。

init-param定义了servlet的一些初始化变量，以debug为例，我们可以在servlet中调用 getServletContext().getInitParameter("debug");方法来获得param-value，这里是2。

最后是load-on-startup属性当值为0或者大于0时，表示容器在应用启动时就加载这个servlet；当是一个负数时或者没有指定时，则指示容器在该servlet被选择时才加载。正数的值越小，启动该servlet的优先级越高。

此外我们在这里还定义了一个pathname用来存放需要解析的配置文件的路径。

 

接着我们来进行第2步：根据所配置的路径，将servlet类，xml文件，以及你解析中需要用到的相关POJO类创建好。

我们这里举个简单的例子。

pojo类代码：是一个UserBean对象包含有userName和password两个私有属性和他们的get set方法（略）。

xml文档如图：

<?xml version="1.0" encoding="UTF-8"?> <database> <user userName="guest" password="guest"/> </database>

 

 再来看servlet方法体：

package address.servlet; import java.io.BufferedInputStream; import java.io.IOException; import java.io.InputStream; import java.util.Hashtable; import javax.servlet.ServletException; import javax.servlet.UnavailableException; import javax.servlet.http.HttpServlet; import org.apache.commons.digester.Digester; import org.xml.sax.SAXException; import address.bo.UserBean; import address.constants.GlobalConstants; public class UserDatabaseServlet extends HttpServlet { private Hashtable<String, UserBean> database = null; private int debug = 0; private String pathname = "/WEB-INF/userdatabase.xml"; public void destory() { getServletContext().removeAttribute(GlobalConstants.DATABASE_KEY); } public int getDebug() { return this.debug; } public void init() throws ServletException { String value; value = getServletConfig().getInitParameter("debug"); debug = Integer.parseInt(value); if (debug >= 1) { log("Initializing database servlet"); value = getServletContext().getInitParameter("pathname"); if (value != null) { pathname = value; } } try { load(); getServletContext().setAttribute(GlobalConstants.DATABASE_KEY, database); } catch (Exception e) { log("Database load exception", e); throw new UnavailableException("Cannot load database from'" + pathname + "'" + e.getMessage()); } } public void addUser(UserBean user) { database.put(user.getUserName(), user); } public synchronized void load() throws IOException, SAXException { database = new Hashtable<String, UserBean>(); if (debug >= 1) { log("Loading database from " + pathname + "!"); } InputStream is = getServletContext().getResourceAsStream(pathname); if (is == null) { log("No such resource available - loading empty database"); return; } BufferedInputStream bis = new BufferedInputStream(is); Digester digester = new Digester(); digester.push(this); digester.setValidating(false); digester.addObjectCreate("database/user", "address.bo.UserBean"); // digester.addBeanPropertySetter("database/user/userName", "userName"); // digester.addBeanPropertySetter("database/user/password", "password"); digester.addSetProperties("database/user"); digester.addSetNext("database/user", "addUser"); digester.parse(bis); bis.close(); } }

 

该方法我们主要用了一个Hashtable来存放我们对xml解析后的信息。key为userName ，value为UserBean对象。

切入我们最关心的部分也就是Digester部分的代码：

push方法：

setValidating：设置xml不进行合法校验

addObjectCreate：创建POJO对象，第一个参数是xml对应的目录结构，第二个参数为项目中POJO类所对应的路径

addSetProperties：对POJO进行设值。参数为xml的该对象的根路径

addSetNext：每次遇到“database/user”节点，都去调用addUser方法。

最后parse则是把一个输入流传个digester对象进行解析。

 

完成了上述工作后。Hashtable中就有了东西了，我们可以调用getServletContext.setAttribute()方法，为application范围设值。从而在整个应用层面都能访问到你放进去的对象。

 

好了该说的说完，接下来来对代码流转做个总结。

从application范围内得到资源文件，把它转成InputStream类型,然后创建Digester类对象,对其进行配置(包括xml有效性,根据xml节点创建目标类对象,根据xml属性值设置对应Bo的属性值,还有每次遇到该节点调用的添加方法<添加方法，可以往web容器的各种范围内插入需要使用的对象数据>.最后将上面准备好的InputStream流交由Digester转换).