Tomcat 源码编译和导入Eclipse

原文地址：http://panpan.blog.51cto.com/489034/120826

由于现在项目相对比较轻松，而且项目是研究SOA和Web Service的，因此这里我要对一些相关的开源技术做一些研究。接下来我要写的文章是Tomcat源码系列的文章，文章(一)是关于Tomcat源码编译和如何将Tomcat工程导入Eclips的，这里分享一下编译经验。
  大家都知道Java的开源项目很强大，正是这些开源项目促进大量优秀的程序员进步和推动软件的快速发展。了解和看过开源项目的程序员不少，但是真正参与进去的程序开发者就不多了。其实只有真正参与到开源项目中，我们的开发能力就会大大增强，我们的开发者就会更加优秀、更善于软件管理，我们的软件产业也会越做越强。
  我觉得可以用构建和谐社会的一句话来描述开源软件，那就是：在共享中共建，在共建中共享。好了，不说这么多了，开始我们的Tomcat源码之旅了。
 
  1.下载Tomcat源码

  请先从 [url]http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91[/url]  下载版本控制工具SubVersion，下载到的是svn-win32-1.5.4.zip，解压后将bin路径放到环境变量path下，就可以使用这个版本控制工具了。
  在MS-DOS窗口中输入：svn export [url]http://svn.apache.org/repos/asf/tomcat/tc6.0.x/tags/TOMCAT_6_0_18/[/url] F:\project\tomcat\apache-tomcat-6.0.18-src\  这里我把要下载的源码放到F盘的这个目录了。TOMCAT_6_0_18是当前最新的源码版本。
  该目录显示的就是Tomcat源码目录，这里的output目录和eclipse_output目录是没有的，这是我之后编译生成的目录。因此大家需要注意。
 
  2.编译并运行
 
  使用Ant工具进行代码编译。从 [url]http://ant.apache.org/bindownload.cgi[/url] 处下载Ant工具。我下载的是apache-ant-1.7.1-bin.zip，解压后把bin路径放到环境变量path下就可以使用了。
  把该目录下的build.properties.default文件改名为：build.properties。打开build.properties，找到base.path=/usr/share/java，改为base.path=F:/project/share。F盘下的这个目录是我本地的存在的目录，读者可以设置自己电脑上一个存在的目录即可。
  在Tomcat编译过程中，Ant会让我们下载一些必要的依赖项目，base.path目录就是用来保存这些项目文件的，我们可以将这个属性指向一个已经存在的目录。修改完base.path后，我们回到MS-DOS窗口，切换到Tomcat源代码所在目录，然后运行ant download命令，如下图所示：


  这次我们等的时间较长，因为eclipse-JDT-3.2.zip大约有20多M，下载需要一段时间。一段时间后，编译器可能给出几个警告。这时我们可发现刚才创建的base.path目录（F:/project/share）中已经下载了6个依赖项目，它们都是Tomcat编译所必须的。
  下面就开始真正的编译任务了，请在MS-DOS窗口内键入ant并回车，Ant将在2分钟内编译1000多个源文件并将Tomcat部署到output目录。编译顺利完成后，请打开Tomcat的源代码目录，会发现多了一个output目录，这是Ant的编译后的输出目录。请打开Tomcat源代码的output\build\bin子目录，双击startup.bat文件，我们即可成功启动Tomcat6.0，如果不成功，请注意设置环境变量CATALINA_HOME，设置为F:\project\tomcat\apache-tomcat-6.0.18-src\output\build。此时我们的编译工作就算顺利完成了。
  这里可能会有错误出现：
    (1)执行ant download命令时出现错误，原因可能是找不到build.properties文件中的行 jdt.loc=http://www.eclipse.org/downloads/download.php?file=/eclipse/downloads/drops/R-3.3.1-200709211145/eclipse-JDT-3.3.1.zip 这个包，读者在网上搜索到这个包后，把网址换一下即可。不过我用的都是最新的版本，至少在一段时间内都是可用的。
    (2)执行ant命令时出错，原因有很多。我遇到的错误是如下错误：

[javac] D:\tomcat\share\tomcat6-deps\dbcp\src\java\org\apache\tomcat\dbcp\db
cp\BasicDataSource.java:43: org.apache.tomcat.dbcp.dbcp.BasicDataSource 不是抽象
的，并且未覆盖 java.sql.Wrapper 中的抽象方法 isWrapperFor(java.lang.Class<?>)
  [javac] public class BasicDataSource implements DataSource {
  [javac]     ^
  [javac] D:\tomcat\share\tomcat6-deps\dbcp\src\java\org\apache\tomcat\dbcp\db
cp\DelegatingStatement.java:45: org.apache.tomcat.dbcp.dbcp.DelegatingStatement
不是抽象的，并且未覆盖 java.sql.Statement 中的抽象方法 isPoolable()

    等等一大堆错误，这个原因是由于我使用的JDK版本是1.6的，所以会出现这个问题，把JDK版本换成1.5的，把JAVA_HOME也换成1.5版本的JDK即可，这些错误就解决了。还有一些警告，不过没有关系。

    如果读者在编译过程中还有其他错误和问题，请留言联系我。

  3.导入源码到Eclipse中

  (1)打开Eclipse，新建一个Java工程，选择“Create project from existing source”，导入现有的代码工程，如下图所示：


  点击“Finish”完成工程创建。
  (2)导入完成后，会看到一些错误提示。右击工程tomcat，选择"build Path"->Config Build path ，删除两个以TOMCAT_LIBS开头的两个库，保留JRE库和JUnit库。
  (3)把ant.jar（刚才下载的ant中的lib里有）和org.eclipse.jdt.core_3.3.1.v_780_R33x.jar（在刚才设置的F:\project\share中有）copy到代码工程下的lib文件夹下(lib文件夹之前没有，需要手动新建)。选择“Config Build path”->"Add library"，加入一个User library,把这两个jar包加进来，命名成tomcat_lib。在Tomcat最新版本6.0.18中，有两个.java代码文件：ServiceProxy.java和ServiceRefFactory.java中用到了一些其他包中的类，如import javax.xml.rpc.Service和import javax.wsdl.Definition等类，这些类分别在包jaxrpc.jar和wsdl4j-1.5.1.jar中，这两个包都在axis2的lib中，我下载的版本是axis-bin-1_4.zip，下载地址是：[url]http://apache.freelamp.com/ws/axis/1_4/axis-bin-1_4.zip [/url] 解压后在lib目录可以看到这两个jar包，直接加入到工程即可。
  添加完成后，如下图所示：


  (4)运行tomcat:找到tomcat的启动主类org.apache.catalina.startup包下的Bootstrap类，右击->“Run AS”->"Run Configurations"，在Arguments窗口中做如下设置：
    在Program arguments中写入:start
    在VM arguments中写入：-Dcatalina.home="F:\project\tomcat\apache-tomcat-6.0.18-src\output\build" 。如下图所示：



  然后运行，可以看到tomcat启动成功，如下图所示：



  (5)停止tomcat：跟上面步骤一样，在Program arguments中写入:stop，点击运行。即可停止tomcat。

  4.总结

  到此为止，我们的tomcat源码的两种编译方式和导入Eclipse都已经完成，这里之所以导入到Eclipse是为了方便读代码，也可以对代码进行单步调式，看看代码的执行过程，这是比较有意义的事情。好了接下来的任务就是深入代码内部了，这是一个令人激动的事情，因为tomcat是一个很优秀的项目，其代码也很有诱惑力。不说了，我开始欣赏代码了，以后的文章就会跟大家分享代码的细节了，还去有兴趣读者关注和一起讨论。由于工程比较大，远远超过2M，我就不上传了，有需要的读者可以留言，我发给大家。