快速上手XDoclet 1 -- Servlet简单实例

来源：互联网发布：七牛云外链默认域名编辑：程序博客网时间：2024/05/17 03:45

XDoclet是一个扩展的Javadoc Doclet引擎。它是一种通用的java工具，可以让你创建自己的javadoc @tags进而利用XDoclet中的Templet enging基于这些@tags生成源代码或其他文件（例如xml的deployment descriptors）。

关于XDoclet的体系结构和工作原理方面的内容我不想多说，可以google一下。我只想通过简单的实例对XDoclet快速上手。因为我发现，学习某个新的知识点的时候，概念方面介绍的很多，但是实例却很少，很难通过实例快速消化概念性的东西。与其说一大堆天书之类的话，还不如给我一个实例，好让我揣摩揣摩。

在看这篇文章之前，最好要熟悉ANT，

一、下载、安装和配置

1. 所需软件

● Ant 1.6.2 http://ant.apache.org

下载 http://mirror.apache.or.kr/ant/binaries/apache-ant-1.6.2-bin.zip

● XDoclet 1.2.2 http://xdoclet.sourceforge.net/xdoclet/

下载 http://prdownloads.sourceforge.net/xdoclet/xdoclet-bin-1.2.2.zip?download

● Tomcat 5.0.28 http://jakarta.apache.org/tomcat/

下载 http://apache.justdn.org/jakarta/tomcat-5/v5.0.28/bin/jakarta-tomcat-5.0.28.zip

2. 安装

F:/j2sdk JDK 目录

F:/java/ant Ant 目录

F:/java/xdoclet XDoclet 目录

F:/java/jakarta-tomcat Tomcat 目录

这里着重指出一下，需要在环境变量中设置 ANT_HOME ，并将其指向Ant安装目录，还要在Path变量值中添加 “%ANT_HOME%/bin;” 可以参考 java环境变量设置。

二、一个简单的实例

1. 编写代码

创建 D:/XDocletSample 目录, 依照如下结构建立3个文件。

D:/XDocletSample/src/javamxj/HelloServlet.java

/*  * @author javamxj （CSDN Blog) 创建日期 2005-1-7  */ package javamxj; import javax.servlet.*; import javax.servlet.http.*; /**  * @web.servlet name="HelloServlet"   *              display-name="Hello Servlet"  *              load-on-startup="1"  * @web.servlet-init-param name="hello"   *              value="${hello.servlet}"  * @web.servlet-mapping url-pattern="/Hello/*"  */ public class HelloServlet extends HttpServlet {
    public void init(ServletConfig config) throws ServletException {
        //从web.xml中获得初始化参数         super.init(config);
    }
    protected void doGet(HttpServletRequest request,
            HttpServletResponse response) throws ServletException,
            java.io.IOException {
        ServletConfig config = this.getServletConfig();
        String h = config.getInitParameter("hello");
        try {
            //首先设置文档类型             response.setContentType("text/html; charset=GBK");
            //获取输出流             java.io.PrintWriter out = response.getWriter();
            out.println("<html><head><title>Welcome javamxj Blog!</title></head>");
            out.println("<body><h1>");
            out.println(" Hello:  " + h);
            out.println("</h1></body></html>");
            out.close();
        } catch (Exception e) {
            throw new ServletException(e);
        }
    }
}

D:/XDocletSample/build.xml

<?xml version="1.0" encoding="GBK"?> <project name="filtering" default="deploy" basedir=".">  <description>一个简单的XDoclet实例</description>    <!-- 载入属性文件 -->  <property file="build.properties"/>    <!-- 定义类路径 -->  <path id="web.classpath">   <pathelement location="${tomcat.home}/common/lib/servlet-api.jar"/>   <pathelement location="${tomcat.home}/common/lib/jsp-api.jar"/>  </path>  <path id="xdoclet.classpath">   <fileset dir="${xdoclet.home}/lib">    <include name="*.jar"/>   </fileset>   <path refid="web.classpath"/>  </path>    <!-- 初始化,建立目录 -->  <target name="init">   <mkdir dir="${dist.dir}"/>   <mkdir dir="${dist.dir}/WEB-INF"/>   <mkdir dir="${dist.dir}/WEB-INF/classes"/>  </target>    <!-- XDoclet 的 WebDoclet 任务 -->  <target name="webdoclet" depends="init">   <taskdef 
      name="webdoclet" 
      classpathref="xdoclet.classpath" 
      classname="xdoclet.modules.web.WebDocletTask"/>          <webdoclet destDir="${dist.dir}/WEB-INF" force="${xdoclet.force}">       <deploymentdescriptor Servletspec="2.4" xmlencoding="GBK"/>    <fileset dir="${src.dir}" includes="**/*Servlet.java"/>   
  </webdoclet>  
 </target>    <!-- 编译与部署 -->  <target name="deploy" depends="webdoclet">   <javac srcdir="${src.dir}" destdir="${dist.dir}/WEB-INF/classes">    <classpath refid="web.classpath"/>   </javac>   <jar destfile="${tomcat.home}/webapps/${app.name}.war" basedir="${dist.dir}"/>  </target> 
</project>

D:/XDocletSample/build.properties

################ 环境设置 ###################   #   #  文件名：build.properties   #  作者： CSDN javamxj # #  web服务器目录 tomcat.home=F:/java/jakarta-tomcat
#  xdoclet目录 xdoclet.home=F:/java/xdoclet
#  web的临时目录 dist.dir=./dist
#  源文件目录 src.dir=./src
#  发布的程序名 app.name=HelloWeb
#  Servlet参数，可以改变 hello.servlet=javamxj blog