Building Tomcat

Table of Contents

Introduction

从源代码构建Apache Tomcat非常容易,并且是向Tomcat贡献的第一步. 文件BUILDING.txt中提供了完整而全面的说明. 以下是快速的分步指南.

Download a Java Development Kit (JDK) version 7

构建Apache Tomcat需要安装JDK(版本7). 您可以从下载一个
http://www.oracle.com/technetwork/java/javase/downloads/index.html
http://openjdk.java.net/install/index.html
或其他JDK供应商.

重要说明 :将环境变量JAVA_HOME设置为安装JDK版本的目录的路径名.

Install Apache Ant 1.9.8 or later

此处下载Ant 1.9.8或更高版本的二进制发行版.

将二进制分发包解压缩到一个方便的位置,以便Ant发行版驻留在其自己的目录中(通常名为apache-ant-1.9.x ). 在本指南的其余部分中,符号名${ant.home}用于引用Ant安装目录的完整路径名.

重要说明 :创建ANT_HOME环境变量以指向目录${ant.home} ,并修改PATH环境变量以在其列表中包含目录${ant.home}/bin . 这使ant命令行脚本可用,该脚本将用于实际执行构建.

Checkout or obtain the Tomcat source code

Tomcat SVN存储库URL: https : //svn.apache.org/repos/asf/tomcat/tc8.5.x/trunk/

Tomcat源代码包: https : //tomcat.apache.org/download-80.cgi .

使用SVN签出源代码,为当前的开发代码选择发布版本或主干的标签,或者下载并解压缩源代码包. 在本指南的其余部分中,符号名${tomcat.source}用于指代放置源的位置.

Configure download area

构建Tomcat涉及下载它依赖的许多库. 强烈建议为这些库配置下载区域.

默认情况下,构建配置为将依赖项下载到${user.home}/tomcat-build-libs目录中. 您可以更改此设置(请参见下文),但是它必须是绝对路径.

通过创建${tomcat.source}/build.properties文件来控制构建. 它可用于重新定义build.properties.defaultbuild.xml文件中存在的任何属性. 默认情况下, build.properties文件不存在. 您必须创建它.

下载区域由属性base.path定义. 例如:

# ----- Default Base Path for Dependent Packages -----
# Replace this path with the directory path where
# dependencies binaries should be downloaded.
base.path=/home/me/some-place-to-download-to

允许不同版本的Tomcat共享相同的下载区域.

另一个例子:

base.path=${user.dir}/../libraries-tomcat8.5

通过代理访问Internet的用户必须使用属性文件来向Ant指示代理配置:

# ----- Proxy setup -----
proxy.host=proxy.domain
proxy.port=8080
proxy.use=on

Building Tomcat

使用以下命令来构建Tomcat:

cd ${tomcat.source}
ant

一旦构建成功完成,将在${tomcat.source}/output/build目录中生成可用的Tomcat安装,并可以使用常规脚本启动和停止该安装.

Building with Eclipse

重要信息:这不是构建Tomcat的受支持的方法;请参见第4章. 此信息不提供任何担保:-). 构建Tomcat的唯一受支持方法是上述的Ant构建. 但是,某些开发人员喜欢使用Java IDE来处理Java代码,并且某些开发人员已使用以下步骤.

注意:这不会让您在Eclipse下构建所有内容; 构建过程需要在许多阶段中使用Ant,这些阶段不是简单的Java编译. 但是,它将允许您查看和编辑Java代码,获取警告,重新格式化代码,执行重构,在IDE下运行Tomcat等.

警告:在运行任何Ant目标之前,请不要忘记如上所述创建和配置${tomcat.source}/build.properties文件.

源树的res/ide-support/eclipse目录中提供了样本Eclipse项目文件和启动目标. 以下说明将自动将其复制到所需的位置.

提供Ant目标是为了方便下载所有二进制依赖项,并在源树的根目录中创建Eclipse项目和类路径文件.

cd ${tomcat.source}
ant ide-eclipse

启动Eclipse并创建一个新的Workspace.

打开" 首选项"对话框,然后选择Java-> Build Path-> Classpath Variables以添加两个新的Classpath变量

TOMCAT_LIBS_BASEbuild.propertiesbase.path设置相同的位置,在此位置已下载二进制依赖项
ANT_HOMEAnt 1.9.8或更高版本的基本路径

使用File-> Import并选择Existing Projects into Workspace . 从那里选择Tomcat源代码树的根目录( ${tomcat.source} ),然后导入位于其中的Tomcat项目.

res/ide-support/eclipse中提供了start-tomcatstop-tomcat启动配置,这些配置在" 运行"->"运行配置"对话框中可用. 使用这些来从Eclipse启动和停止Tomcat. 如果要自己配置这些文件(或使用其他IDE),请使用org.apache.catalina.startup.Bootstrap作为主类,将start / stop等作为程序参数,并指定-Dcatalina.home=... (使用您的构建目录的名称)作为VM参数.

调整一些格式设置首选项将使与Tomcat编码约定保持一致(并使您的贡献被接受)变得容易得多:

Java->代码样式->格式化程序->编辑... 标签政策:仅空格
制表符和压痕大小:4
常规->编辑器->文本编辑器 显示的标签宽度:2
为制表符插入空格
显示空格字符(可选)
XML-> XML文件->编辑器 缩进使用空格
压痕尺寸:2
蚂蚁->编辑器->格式化程序 标签大小:2
使用制表符而不是空格:未选中

res/ide-support/eclipse/java-compiler-errors-warnings.txt文件中记录了建议的编译器警告配置.

Building with other IDEs

大多数IDE应该使用相同的通用方法. 例如,据报道它可以在IntelliJ IDEA中工作.

by  ICOPY.SITE