构建tomcat源码环境

简介：

最近想要深入了解tomcat，所以下载了tomcat的源码，并导入到idea中进行学习，在源码构建过程中还是遇到了一些坑，记录下来，给想要构建源码的小伙伴一个参考；

开始：

首先前往tomcat官网将源码包下载下来：https://tomcat.apache.org/download-80.cgi
我们直接下载zip格式的就行，我的是mac系统，下载zip也可以

将源码下载下来后，进行解压，
解压后的apache-tomcat-8.5.50-src文件夹中目录结构

再apache-tomcat-8.5.50-src文件夹中创建一个source文件夹，将apache-tomcat-8.5.50-src文件夹中的：conf文件夹和webapps文件夹移动到新创建的source文件夹中：

此时在apache-tomcat-8.5.50-src文件夹下创建一个pom.xml文件，并将以下内容拷贝进新创建的文件中：

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.cat</groupId>
    <artifactId>tomcat-src</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>mytomcat Maven Webapp</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <!--tomcat 依赖的基础包-->
    <dependencies>
        <dependency>
            <groupId>org.easymock</groupId>
            <artifactId>easymock</artifactId>
            <version>3.4</version>
        </dependency>
        <dependency>
            <groupId>ant</groupId>
            <artifactId>ant</artifactId>
            <version>1.7.0</version>
        </dependency>
        <dependency>
            <groupId>wsdl4j</groupId>
            <artifactId>wsdl4j</artifactId>
            <version>1.6.2</version>
        </dependency>
        <dependency>
            <groupId>javax.xml</groupId>
            <artifactId>jaxrpc</artifactId>
            <version>1.1</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jdt.core.compiler</groupId>
            <artifactId>ecj</artifactId>
            <version>4.5.1</version>
        </dependency>
        <dependency>
            <groupId>javax.xml.soap</groupId>
            <artifactId>javax.xml.soap-api</artifactId>
            <version>1.4.0</version>
        </dependency>
    </dependencies>

    <build>
        <!--指定源⽬录-->
        <finalName>Tomcat8.5</finalName>
        <sourceDirectory>java</sourceDirectory>
        <resources>
            <resource>
                <directory>java</directory>
            </resource>
        </resources>
        <plugins>
            <!--引⼊编译插件-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

导入idea

此时就可以将源码导入到idea中，怎么导入项目应该就不用介绍啦，将项目导入后：

此时需要配置tomcat的启动环境：

此时你打开后可能和我的不一样,此时你需要找到 VM options输入框，

点击

你的打开后有可能是这样的：则直接在 VM options 里输入参数

找到 VM options 后在里面输入，以下四个参数配置，注意这个是你导入工程的tomcat的目录下的source目录，第三个参数不用变，其他几个根据你自己的目录进行修改：

-Dcatalina.home=/Users/chenhu/Desktop/source/private/apache-tomcat-8.5.50-src/source

-Dcatalina.base=/Users/chenhu/Desktop/source/private/apache-tomcat-8.5.50-src/source

-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager

-Djava.util.logging.config.file=/Users/chenhu/Desktop/source/private/apache-tomcat-8.5.50-src/source/conf/logging.properties

将参数配置好以后就可以进行启动了：
tomcat的启动入口在 Bootstrap 中，我们全局搜索找到这个类，并执行里面的main方法，此时可以看到我们的项目已经正常启动啦，如果在这一步你还是启动报错，那么恭喜你遇到了我没遇到的错误，可以看一下你下载的版本和我是否一致，或者自行百度搜索解决

在项目启动成功后，我们在浏览器输入：localhost:8080 进行访问：

此时我们可以发现，访问报错啦，这是因为tomcat默认没有初始化jsp引擎，而无法编译jsp文件，所以需要我们对源码进行一下修改；
在idea中全局搜索 org.apache.catalina.startup.ContextConfig 这个类，找到里面的 configureStart 这个方法，在里面添加以下代码：

 // 初始化 jsp解析引擎 - jasper
context.addServletContainerInitializer(new JasperInitializer(),null);

此时我们在启动 tomcat 并访问：
这时我们就可以正常访问啦：

控制台乱码问题：

在我构建过程中遇到了控制台输出乱码，解决方法如下：
注意在找对应的类的时候，注意包名和方法签名，因为有一些同名的类，和方法名

找到org.apache.tomcat.util.res.StringManager类中的getString(final String key, final Object… args)方法，在此方法中添加以下代码：

        try {
            value = new String(value.getBytes("ISO-8859-1"), "UTF-8");
        }catch(Exception e){
            e.printStackTrace();
        }

找到org.apache.jasper.compiler.Localizer类的getMessage(String errCode)方法，在里面添加以下代码：

errMsg = new String(errMsg.getBytes("ISO-8859-1"), "UTF-8");

此时在启动控制台，乱码消失，我们的构建tomcat源码也讲解完成！！！