下载编译tomcat源码

咱们分析的是 tomcat 6

1. 下载Tomcat6.0的源代码 

首先用 svn export 出源代码， 官网下的源码包我不知道有没有 build.xml , 读者可以验证一下， 我映像中是没有的。

exoprt 之前你可以在浏览器直接输入 http://svn.apache.org/repos/asf/tomcat/tc6.0.x/tags/ ， 然后选择要export 出来的版本。

svn export http://svn.apache.org/repos/asf/tomcat/tc6.0.x/tags/TOMCAT_6_0_0/ D:/carl_wu/tomcat/src/ 







2. 编译并运行 

代码下载后，我们接下来就是要编译并运行Tomcat。一提编译，我们不禁会想到可爱的Ant。不错，Tomcat正是以Ant作为编译工具，如果您还没有安装，请从http://ant.apache.org/bindownload.cgi 处下载并安装它。然后，请从Tomcat的源代码文件找到build.properties.default文件，并将该文件复制到build.properties，然后打开build.properties，找到下面这行： 

base.path=/usr/share/java 

将它改为： 

base.path= D:/carl_wu/tomcat/share 

在Tomcat编译过程中，Ant会让我们下载一些必要的依赖项目，base.path目录就是用来保存这些项目文件的，我们可以将这个属性指向一个已经存在的目录。修改完base.path后，我们回到MS-DOS或Shell窗口，切换到Tomcat源代码所在目录，然后运行ant download命令，如下图所示： 




download 一般最新的版本是没有问题的，如果是老版本的话，如果有链接失效了需要在 build.properties文件 改链接。

下完了后，下面就开始真正的编译任务了，请在MS-DOS或Shell窗口内键入ant并回车，Ant将在2分钟内编译1000多个源文件并将Tomcat部署到output目录。编译顺利完成后，请打开Tomcat的源代码目录，会发现多了一个output目录，这是Ant的编译后的输出目录。请打开Tomcat源代码的output/build/bin子目录，双击startup.bat文件，我们即可成功启动Tomcat6.0，此时我们的编译工作就算顺利完成了。 


3. 导入源代码到Eclipse 

3.1 请打开Eclipse，新建一个Java项目，然后点击“Next”按钮，请选择“Create project from existing source”， 并在Directory文本框内填入我们刚才下载的Tomcat源代码目录（i.e. D:/carl_wu/tomcat/src)，然后点击“Next”直至结束。 




3.2 我们将会看到Eclipse拒绝编译，这是因为Eclipse找不到该项目指定的库文件。请右击该项目，在弹出菜单中选择“Properties”=>“Libraries”，然后删除两个以TOMCAT_LIBS开头的两个库文件，只保留一个JRE库文件，然后点击“OK”按钮，这时Eclipse开始编译Tomcat源代码，但是发现一堆错误，这是因为我们没有为该项目添加编译所必须的Jar包。 

3.3 准备好Tomcat项目所必须的jar文件，其实，刚才我们运行ant download任务时，已经下载过这些jar文件包。 

ant.jar （请在ant安装目录的lib子目录中拷贝） 

commons-collections-3.1.jar （从刚才Ant下载的commons-collections-3.1子目录中拷贝） 

commons-dbcp-1.2.1.jar（从刚才Ant下载的commons-dbcp-1.2.1子目录中拷贝） 

commons-logging-1.1.jar（如果您本机没有这个jar包，请从http://commons.apache.org/downloads/download_logging.cgi处下载） 

commons-pool-1.2.jar（从刚才Ant下载的commons-pool-1.2子目录中拷贝） 

org.eclipse.jdt.core_3.2.0.v_671.jar（从刚才Ant下载的eclipse/plugins子目录中拷贝）

 

在实际操作中，发现还需要导入wsdl4j这个包（跟web service相关），否则编译时会有错误，有些类用到了这些包

 

3.4 当我们准备好这些jar文件后，将这些文件拷贝到某一目录（比如说D:/carl_wu/tomcat/tomcat_lib目录），然后在Eclipse中新建一个User Libraries，我们将这个新建的User Libraries命名为TOMCAT_LIBS，并把这些文件加到TOMCAT_LIBS。然后将我们新建的TOMCAT_LIBS添加到Tomcat6项目。另外，别忘了把JUnit库也加到Tomcat6项目。这时Eclipse开始重新编译，编译过程顺利通过，所有错误均消失，此时Tomcat6项目的目录结构如下： 





还有，请把test目录也加入到源代码中，方法是在Eclipse中右击”test”目录，然后在弹出菜单中选择“Build path”=>”Use as Source Folder”，之后我们会看到test目录上就多了个源代码的符号，如上图所示。 

3.5在Eclipse中运行Tomcat。请找到Tomcat的启动主类org.apache.catalina.startup.Bootstrap，右击这个类，在弹出菜单中选择“Run As…”=>”Open Run Dialog…”，然后在弹出的“Run”窗口中填入程序运行参数“start”和JVM运行参数catalina.home，如下面窗口所示： 




然后点击“Run”按钮，我们将会看到Tomcat正常启动。恭喜，咱们的Tomcat源码已经成功导入Eclipse，这时，可视化的UML分析工具及Debug工具就能派上用场了。 

3.5 调试Tomcat，请打开org.apache.jasper.compiler.Compiler类的源代码，在generateJava()方法的第一行打一个断点，然后在Eclipse的调试状态下运行Tomcat，等Tomcat运行后，打开我们的浏览器，在地址栏中输入http://localhost:8080/examples/jsp/jsp2/el/basic-comparisons.jsp并回车，然后我们可观察到Eclipse此时切换至调试视图： 







上面的小实验表明我们可以在Eclipse中通过Debugger观察Tomcat的内部运行机理。另外补充一点，上面的generateJava方法是将jsp动态编译至java class，这个方法只是在第一次请求或者Jsp源码发生变化时执行，如果您再次在浏览器中发送同样的请求，您将看不到上图的Debug界面，因为该方法不再执行。 

另外，还有一点很有意思。Tomcat6以前版本的源代码分散在好几个子项目中，他们分别叫做jakarta-servletapi-5，jakarta-tomcat-5，jakarta-tomcat-catalina，jakarta-tomcat-connectors和jakarta-tomcat-jasper，我觉得Tomcat的开发者可能嫌这样做太麻烦了，所以Tomcat6版本中将这些子项目都合并在一起了。但是，这种做法不利于我们阅读理解源代码。

3.4 当我们准备好这些jar文件后，将这些文件拷贝到某一目录（比如说D:/carl_wu/tomcat/tomcat_lib目录），然后在Eclipse中新建一个User Libraries，我们将这个新建的User Libraries命名为TOMCAT_LIBS，并把这些文件加到TOMCAT_LIBS。然后将我们新建的TOMCAT_LIBS添加到Tomcat6项目。另外，别忘了把JUnit库也加到Tomcat6项目。这时Eclipse开始重新编译，编译过程顺利通过，所有错误均消失，此时Tomcat6项目的目录结构如下：  





还有，请把test目录也加入到源代码中，方法是在Eclipse中右击”test”目录，然后在弹出菜单中选择“Build path”=>”Use as Source Folder”，之后我们会看到test目录上就多了个源代码的符号，如上图所示。 

3.5在Eclipse中运行Tomcat。请找到Tomcat的启动主类org.apache.catalina.startup.Bootstrap，右击这个类，在弹出菜单中选择“Run As…”=>”Open Run Dialog…”，然后在弹出的“Run”窗口中填入程序运行参数“start”和JVM运行参数catalina.home，如下面窗口所示：  




然后点击“Run”按钮，我们将会看到Tomcat正常启动。恭喜，咱们的Tomcat源码已经成功导入Eclipse，这时，可视化的UML分析工具及Debug工具就能派上用场了。 

3.5 调试Tomcat，请打开org.apache.jasper.compiler.Compiler类的源代码，在generateJava()方法的第一行打一个断点，然后在Eclipse的调试状态下运行Tomcat，等Tomcat运行后，打开我们的浏览器，在地址栏中输入http://localhost:8080/examples/jsp/jsp2/el/basic-comparisons.jsp并回车，然后我们可观察到Eclipse此时切换至调试视图： 







上面的小实验表明我们可以在Eclipse中通过Debugger观察Tomcat的内部运行机理。另外补充一点，上面的generateJava方法是将jsp动态编译至java class，这个方法只是在第一次请求或者Jsp源码发生变化时执行，如果您再次在浏览器中发送同样的请求，您将看不到上图的Debug界面，因为该方法不再执行。  

另外，还有一点很有意思。Tomcat6以前版本的源代码分散在好几个子项目中，他们分别叫做jakarta-servletapi-5，jakarta-tomcat-5，jakarta-tomcat-catalina，jakarta-tomcat-connectors和jakarta-tomcat-jasper，我觉得Tomcat的开发者可能嫌这样做太麻烦了，所以Tomcat6版本中将这些子项目都合并在一起了。但是，这种做法不利于我们阅读理解源代码。

附： Eclipse 关联源代码：

在eclipse的preference-->Java-->Build Path-->user library,点开想要添加的jar文件，选择“添加源文件”