在IDEA中调试jdk(openjdk)源码并添加注释

说明

本文不是将openjdk源码从零开始进行编译（需要C编译器），本文仅仅是是对jdk(openjdk)中常用的源码进行调试并添加上注释。如ArrayList/HashMap这些，主要是src中java目录的常用类。

image.png

下载jdk(openjdk)

本文以openjdk为例。下载openjdk。
windos系统请看：windows下安装openjdk，无需自己编译打包

解压openjdk(安装jdk)

我这里解压到openjdk8_debug目录。

image.png

新建pom文件

将openjdk8_debug目录变成一个maven项目(gradle同理)，新新建一个pom.xml文件。

    4.0.0

    com.openjdk
    openjdk8_debug
    1.0-SNAPSHOT

    openjdk8_debug
    
    http://www.example.com

    
        UTF-8
        1.8
        1.8
    

    
        
            junit
            junit
            4.11
            test
        
    

    
        
            
                
                    maven-compiler-plugin
                    3.8.0
                
            
        
    

新建src/main/java目录

新建src/main/java目录，然后将src.zip中的java目录复制到src/main/java目录中。
完成后的目录结构如图，注意src/main/java下面还有一个java目录，准确说应该是src/main/java下有java这个包(package)。

image.png

配置SDK

代码已经准备好了，那么src/main/java目录下的代码如何编译呢，当然需要配置jdk(openjdk)了。
通过project -> Open Module Settings，快捷键F4。

image.png

将openjdk8_debug配置上(用自己编译自己的src)。

image.png

编译

Build -> Build Project，快捷键Ctrl + F9。

编译速度取决于电脑配置。这也就是为什么一开始没有把整个src.zip中的代码全部解压到src/main/java中的原因，代码越庞大，编译越慢，反正常用的也就是java包中的代码。

编译好的代码位于target录下，因为是maven项目。

image.png

重新配置SDK

编译类代替rt.jar

现在的目标是让我们编译的代码要跑在jre/lib/rt.jar前面，在eclipse里面只要把编译的代码排在jre/lib/rt.jar前面就行。
在IDEA里相对复杂一点，只能通过-Xbootclasspath来配置。如下，配置Run/Debug Configurations：

image.png

image.png

-Xbootclasspath有三种用法：①-Xbootclasspath代表完全替代完全取代基本核心的Java class 搜索路径；②-Xbootclasspath/a代表后缀在核心class搜索路径后面；③-Xbootclasspath/p代表前缀在核心class搜索路径前面，正好是上图的配置方法。

使用模板

如果每个单元测试都要配置一次，会很麻烦，直接给模板配置一个，以后所有的单元测试就都有这个配置了。

image.png

配置源码目录：

image.png

加个注释试试

我在Stream#of处加上注释。

image.png

整个单元测试，debug一下：

public class StreamDemo {

    @Test
    public void testFilter() {
        Stream.of(1, 2, 3, 4, 5)
                .filter(item -> item > 3)
                .forEach(System.out::println);// 打印结果：4，5
    }
}

注意跑单元测试每次都会触发build，可能会比较慢。

可以看到确实进入的是src/main/java下的源码，而且是带注释的。

image.png

在其他项目中引用

在其他项目中引用可以看到openjdk8_debug的注释，但是不能增加注释（准确说你要强制增加注释也可以，就是无法编译）。

image.png

添加官方的测试代码

在openjdk的git上下载指定tag的代码，然后找到测试代码中的java目录，复制到项目中，比如我放到了src/test/official中（为什么这样做下面会讲）。

image.png

image.png

可以发现官方的测试代码都是没有包声明的(package xxxx;)，同时为了避免每次运行都编译大量的代码，我决定不把src/test/official标记为测试源码(Mark Directory As Test Source Root)，我决定在每次准备跑某个测试类的时候，才把对应的目录声明为测试源码，测完以后再取消声明。
这样就可以跑官方测试类了，同时保证每次跑不会编译太多代码。
比如我要测试java/awt/AlphaComposite目录下的代码。

image.png

资源

可直接运行的代码