IDEA 下如何修改 Elasticsearch 源码

2022-04-24 06:31:58

以下所有过程以mac操作系统下（macOS 10.13.6）为例进行。

环境准备

安装jdk10

因为es需要高版本jdk进行开发，所以我们直接安装jdk10。

前往 http://www.oracle.com/technetwork/java/javase/downloads/jdk10-downloads-4416644.html ，直接下载安装mac的dmg版本即可。

jdk8和jdk10并存

如果平时开发用的jdk8，为了不影响之后使用，jdk8和jdk10将会同时存在。如果之前没用过java低版本请忽略。在 .bash_profile 中设置如下：

export JAVA8_HOME=$(/usr/libexec/java_home -v 1.8)
export JAVA10_HOME=$(/usr/libexec/java_home -v 10)
# 默认为jdk8
export JAVA_HOME=$JAVA8_HOME
# 随时切换jdk8 和jdk10
alias jdk8="export JAVA_HOME=$JAVA8_HOME"
alias jdk10="export JAVA_HOME=$JAVA10_HOME"

其他操作系统与mac不同，请自行修改jdk配置。

IDEA开发准备

idea

自行下载宇宙第一IDE，我们这里使用的是IntelliJ IDEA 2018.2 (Ultimate Edition)，不同版本应该影响不大。

建议将idea的内存调大，因为es项目有点大。

下载ES源码

我们以es 6.2.4为例，直接在github上下载es源码即可。
https://github.com/elastic/elasticsearch/releases/tag/v6.2.4

解压到随意位置即可。

gradle操作

es 6.2.4 采用了宇宙第一自动化建构工具 gradle，相比maven会好用很多。

1. 修改maven源

首先，我们修改maven仓库源，打开源码根目录下的 build.gradle （相当于maven的pom.xml，但是功能强大，用法简单，如果用maven实现里面的功能会无比复杂）：

# 35行（import结束后）增加以下代码
allprojects {
    repositories {
        maven{ url 'http://maven.aliyun.com/nexus/content/groups/public/'}
    }
}

2. 生成idea文件

为了idea能修改编译源码，需要执行 ./gradlew idea （windows下为 gradlew.bat idea），这里会经过漫长的过程，如果不换maven源的话，将几个小时。

idea打开源码

idea中直接open刚操作的es源码文件夹，右下角提示`import gradle
project`，点击后弹出如下

如图选择jdk10，点击ok。

开始自动编译java源码，如下图红色框。

首次build，这个过程会比较慢，因为要额外下载jar包等。

运行源码

直接在idea中运行

打开文件工程根目录/server/src/main/org/elasticsearch/bootstrap/Elasticsearch.java，右键 Run Elasticsearch.main()，运行main方法。

提示报错

首先在项目根目录下创建3个文件夹

./home/conf
./home/plugins
./home/modules

然后前往es官网下载一个binary版本的es6.2.4，将其中的conf全部复制到 ./home/conf,将全部的 modules 复制到./home/modules

在下图中增加jvm参数：

-Des.path.conf=/Users/xunjian/Desktop/elasticsearch-6.2.4/home/config
-Des.path.home=/Users/xunjian/Desktop/elasticsearch-6.2.4/home
-Dlog4j2.disable.jmx=true

并勾选包含provide scope的jar。

然后运行报错：

org.elasticsearch.bootstrap.StartupException: java.security.AccessControlException: access denied ("java.lang.RuntimePermission" "createClassLoader")
    at org.elasticsearch.bootstrap.Elasticsearch.init(Elasticsearch.java:125) ~[main/:?]
    at org.elasticsearch.bootstrap.Elasticsearch.execute(Elasticsearch.java:112) ~[main/:?]
    at org.elasticsearch.cli.EnvironmentAwareCommand.execute(EnvironmentAwareCommand.java:86) ~[main/:?]
    at org.elasticsearch.cli.Command.mainWithoutErrorHandling(Command.java:124) ~[main/:?]
    at org.elasticsearch.cli.Command.main(Command.java:90) ~[main/:?]
    at org.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.java:92) ~[main/:?]
    at org.elasticsearch.bootstrap.Elasticsearch.main(Elasticsearch.java:85) ~[main/:?]
Caused by: java.security.AccessControlException: access denied ("java.lang.RuntimePermission" "createClassLoader")

解决方法：
在 home/config 新建 java.policy 文件，填入

grant {
    permission java.lang.RuntimePermission "createClassLoader";
};

之前修改过的jvm参数中再增加一个

-Djava.security.policy=/Users/xunjian/Desktop/elasticsearch-6.2.4/home/config/java.policy

启动：不报错，正常启动。

修改源码

做个小小的例子，在 server/src/main/java/org/elasticsearch/action/main/MainResponse.java 中修改119行左右为

builder.field("tagline", "Hello ！ 寻剑的ES  ^_^");

重新再idea中启动主函数，访问 http://localhost:9200/ 得到

Debug

直接用debug模式启动即可，然后随时添加断点和减少断点。以刚才我们修改的文件为例，增加两个断点：

浏览器访问网页，在idea中可方便的debug

码农公寓