世界上最简单的Xdoclect demo

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    
你可以根据自己的设置在 build.properties 属性文件中改变 Tomcat、XDoclet 的目录。
 
 
2. 运行程序
 
● 打开一个MS-DOS窗口,切换到 D:/XDocletSample 目录,输入 ant 命令:
  
● 然后启动Tomcat服务器,打开浏览器窗口,输入地址: http://localhost:8080/HelloWeb/Hello/
 
 
   打开 build.properties 文件,将“ hello.servlet=javamxj blog ”语句修改为“ hello.servlet=CSDN ”, 然后保存。
 
  在MS-DOS中,输入“ant -Dxdoclet.force=true”
 
  刷新浏览器窗口,则显示如下:
 
好了,这只是一个简单的XDoclet实例。
 
 
三、web.xml 是如何生成的   
 
   注意到没有,这里并没有写 web.xml 文件,但是可以从 D:/XDocletSample/dist/WEB-INF 目录下发现一个 web.xml 文件。 内容如下(为了便于浏览,我已把注释删除):
  D:/XDocletSample/dist/WEB-INF/web.xml
    也许你会认为这没什么,也不是很简单,但当利用XDoclet开发EJB时,你就会更加体会到它的优越性的。 下篇文章就谈谈如何开发EJB。
 
 
 
四、参考资料:
 
文章: 用 XDoclet 来改进 J2EE 组件的重用  
         (这是IBM网站上的一个教程,这篇文章就是以它为蓝本写作的。需要注册,才能登陆。)
             http://www2.tw.ibm.com/developerWorks/tutorial/content/java/t20031110_xdoclets.htm
         (同上,这是IBM 的中国台湾网站上的文章,繁体的,不用注册)
 
            XDoclet 学习笔记
        (这是一个系列,共有4篇文章,对于XDoclet的原理说的比较透彻。)
 
书籍: Manning - XDoclet In Action
 
其它: XDoclet本身自带的文档和实例。
        (建议好好看看,反正我是经常用到的)

你可能感兴趣的:(世界上最简单的Xdoclect demo)