IDEA进行Tomcat源码调试

资源下载

• 下载源码并解压到目录${tomcat.source}。我这里下载的是tomcat-8.5.34，下载地址：https://tomcat.apache.org/download-80.cgi
• 下载JDK并并配置环境,需设置JAVA_HOME变量。
• 下载ant1.9.8或以上版本，解压后配置环境变量，下载地址：https://ant.apache.org/bindownload.cgi

编译构建

在${tomcat.source}目录中找到build.properties.default文件，找到base.path=${user.home}/tomcat-build-libs配置，该配置是构建需要的类库，建议将该目录放在与${tomcat.source}目录不同的路径中，我的配置：base.path=D:/git/tomcat-8.5.34-src/tomcat-build-libs。然后将文件改名为build.properties，cmd进入${tomcat.source}目录，输入ant命令开始构建
，build成功后如下，在${tomcat.source}目录下出现out目录。

导入IDEA

• 编译完成可以看到在原来解压目录下生成了一个output文件夹，output中有build文件夹
• 在源码根目录下增加pom.xml文件

    4.0.0
    org.apache.tomcat
    Tomcat8.0
    Tomcat8.5
    8.0

    
        Tomcat8.0
        java
        test
        
            
                java
            
        
        
            
                test
            
        
        
            
                org.apache.maven.plugins
                maven-compiler-plugin
                2.3
                
                    UTF-8
                    1.8
                    1.8
                
            
        
    

    
        
            junit
            junit
            4.12
            test
        
        
            org.easymock
            easymock
            3.4
        
        
            ant
            ant
            1.7.0
        
        
            wsdl4j
            wsdl4j
            1.6.2
        
        
            javax.xml
            jaxrpc
            1.1
        
        
            org.eclipse.jdt.core.compiler
            ecj
            4.5.1
        
    

• 以maven项目导入idea中。
• 在test.util包下增加类CookieFilter。

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package util;

import java.util.Locale;
import java.util.StringTokenizer;

/**
 * Processes a cookie header and attempts to obfuscate any cookie values that
 * represent session IDs from other web applications. Since session cookie names
 * are configurable, as are session ID lengths, this filter is not expected to
 * be 100% effective.
 *
 * It is required that the examples web application is removed in security
 * conscious environments as documented in the Security How-To. This filter is
 * intended to reduce the impact of failing to follow that advice. A failure by
 * this filter to obfuscate a session ID or similar value is not a security
 * vulnerability. In such instances the vulnerability is the failure to remove
 * the examples web application.
 */
public class CookieFilter {

    private static final String OBFUSCATED = "[obfuscated]";

    private CookieFilter() {
        // Hide default constructor
    }

    public static String filter(String cookieHeader, String sessionId) {

        StringBuilder sb = new StringBuilder(cookieHeader.length());

        // Cookie name value pairs are ';' separated.
        // Session IDs don't use ; in the value so don't worry about quoted
        // values that contain ;
        StringTokenizer st = new StringTokenizer(cookieHeader, ";");

        boolean first = true;
        while (st.hasMoreTokens()) {
            if (first) {
                first = false;
            } else {
                sb.append(';');
            }
            sb.append(filterNameValuePair(st.nextToken(), sessionId));
        }


        return sb.toString();
    }

    private static String filterNameValuePair(String input, String sessionId) {
        int i = input.indexOf('=');
        if (i == -1) {
            return input;
        }
        String name = input.substring(0, i);
        String value = input.substring(i + 1, input.length());

        return name + "=" + filter(name, value, sessionId);
    }

    public static String filter(String cookieName, String cookieValue, String sessionId) {
        if (cookieName.toLowerCase(Locale.ENGLISH).contains("jsessionid") &&
                (sessionId == null || !cookieValue.contains(sessionId))) {
            cookieValue = OBFUSCATED;
        }

        return cookieValue;
    }
}

• 使用maven工具 clean and install 跳过test构建完成。

• 增加一个run Application选项

Name：Bootstrap

Main Class：org.apache.catalina.startup.Bootstrap

VM options：-Dcatalina.home="D:\Users\Tomcat8.0\output\build"
路径即为ant构建之后生成的output目录中的build目录路径

其他正常配置即可

• 运行Application中的Bootstrap，Tomcat即可正常启动