在之前學(xué)習(xí)Redis的過程中，我就是一邊通過文檔/視頻學(xué)習(xí)，一邊閱讀源碼蕴坪。我發(fā)現(xiàn)兩種方法可以相輔相成，互相補(bǔ)充敬锐。閱讀文檔可以幫助我們快速了解某個(gè)功能背传，閱讀源碼有助于我們更深入的理解這一功能的實(shí)現(xiàn)及思想。
因此台夺，在學(xué)習(xí) Elasticsearch 的時(shí)候我也準(zhǔn)備采用這樣的模式续室。所以，從今天開始谒养，我會(huì)定期更新學(xué)習(xí) Elasticsearch 源碼的收獲挺狰。在開始學(xué)習(xí)之前，需要先把環(huán)境準(zhǔn)備好买窟。所以今天就先分享一下準(zhǔn)備環(huán)境的過程丰泊。
軟件環(huán)境
Intellij Idea:2020.1版本
JDK 12
Gradle 5.5
下載源碼
你可以在 Github 中下載 release 版本或指定 tag 的源碼，地址如下始绍。
https://github.com/elastic/elasticsearch/releases
下載好以后解壓到指定目錄/
tar -xzvf elasticsearch-7.3.1.tar.gz
也可以直接在命令行通過 git 下載源碼
git clone git@github.com:elastic/elasticsearch.git
然后可以切換到你想要的版本
git checkout v7.3.1
導(dǎo)入IntelliJ IDEA
下載好源碼以后瞳购，我們來將項(xiàng)目導(dǎo)入 IDEA，首先亏推，進(jìn)入到項(xiàng)目的根目錄学赛，執(zhí)行命令
./gradlew idea
這一步是生成 IntelliJ 的項(xiàng)目文件年堆，需要下載一些依賴包，下載的不順利的同學(xué)可以選擇將 gradle 源切換成國(guó)內(nèi)的源盏浇。
切換 gradle 源
進(jìn)入目錄
cd ~/.gradle
新建一個(gè)名為 init.gradle 的目錄变丧，內(nèi)容如下
allprojects {
repositories {
def ALIYUN_REPOSITORY_URL = 'https://maven.aliyun.com/repository/public'
all { ArtifactRepository repo ->
if(repo instanceof MavenArtifactRepository){
def url = repo.url.toString()
if (url.startsWith('https://repo1.maven.org/maven2')) {
project.logger.lifecycle "Repository ${repo.url} replaced by $ALIYUN_REPOSITORY_URL."
remove repo
}
}
}
maven { url ALIYUN_REPOSITORY_URL }
}
}
文件生成好之后，會(huì)有如下提示
現(xiàn)在我們開始往 idea 中導(dǎo)入項(xiàng)目绢掰，File -> New Project From Existing Sources痒蓬，選擇你的代碼根目錄，然后點(diǎn)擊open滴劲，之后在Import project from external model -> Gradle攻晒，到 idea 中，它還會(huì)下載一些包班挖。下載完以后鲁捏，我們就算是導(dǎo)入完成了。
本地運(yùn)行Elasticsearch
將項(xiàng)目導(dǎo)入到 idea 中之后萧芙，我們就可以嘗試運(yùn)行項(xiàng)目了给梅，這一步看似簡(jiǎn)單，卻是我花費(fèi)時(shí)間最多的一步末购。首先我們找到 server 包下的org/elasticsearch/bootstrap/Elasticsearch.java，運(yùn)行其中的main函數(shù)虎谢。
如果你運(yùn)行失敗盟榴，不要驚慌，我們需要加一些配置婴噩。
點(diǎn)開 Run/Debug Configrations擎场，如圖，我們需要在 VM options 中加一些配置几莽。還需要勾選上 Include dependencies with "Provided" scope
VM options 如下
-Des.path.home=/Users/moka/eshome
-Des.path.conf=/Users/moka/eshome/config
-Xms1g
-Xmx1g
-Dlog4j2.disable.jmx=true
-Djava.security.policy=/Users/moka/eshome/config/elasticsearch.policy
下面對(duì)這些參數(shù)進(jìn)行一下說明
-Des.path.home：指定eshome所在路徑迅办，elasticsearch 會(huì)需要從這個(gè)路徑下加載一些包，因此章蚣，我們需要指定一個(gè)目錄站欺，然后把必要的模塊和配置文件復(fù)制到該目錄下，你可以選擇自己編譯源碼纤垂，或者是從官網(wǎng)下載對(duì)應(yīng)的二進(jìn)制版本矾策，
tar -zxvf elasticsearch-7.3.1-darwin-x86_64.tar.gz
cd elasticsearch-7.3.1
cp -r config modules plugins /Users/moka/eshome
-Des.path.conf：指定配置文件所在的路徑名，后續(xù)調(diào)整節(jié)點(diǎn)配置時(shí)峭沦，修改其下的配置文件
-Xms1g 和 -Xmx1g 設(shè)置 JVM 堆的大小
-Dlog4j2.disable.jmx=true：這個(gè)是jvm.options文件中的默認(rèn)配置贾虽，不加的話會(huì)報(bào)“access denied”等錯(cuò)誤。
-Djava.security.policy：這個(gè)也是權(quán)限問題吼鱼，配置policy文件路徑蓬豁，內(nèi)容如下
grant{
permission javax.management.MBeanTruxtPermission "register";
permission javax.management.MBeanServerPermission "createMBeanServer";
permission java.lang.RuntimePermission "createClassLoader";
};
按照這些配置好以后绰咽，發(fā)現(xiàn)還是會(huì)報(bào)錯(cuò)
java.lang.NoClassDefFoundError: org/elasticsearch/plugins/ExtendedPluginsClassLoader
at org.elasticsearch.plugins.PluginsService.loadBundle(PluginsService.java:494) ~[main/:?]
at org.elasticsearch.plugins.PluginsService.loadBundles(PluginsService.java:422) ~[main/:?]
at org.elasticsearch.plugins.PluginsService.<init>(PluginsService.java:146) ~[main/:?]
at org.elasticsearch.node.Node.<init>(Node.java:303) ~[main/:?]
at org.elasticsearch.node.Node.<init>(Node.java:246) ~[main/:?]
at org.elasticsearch.bootstrap.Bootstrap$5.<init>(Bootstrap.java:213) ~[main/:?]
at org.elasticsearch.bootstrap.Bootstrap.setup(Bootstrap.java:213) ~[main/:?]
at org.elasticsearch.bootstrap.Bootstrap.init(Bootstrap.java:323) ~[main/:?]
at org.elasticsearch.bootstrap.Elasticsearch.init(Elasticsearch.java:121) ~[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.lang.ClassNotFoundException: org.elasticsearch.plugins.ExtendedPluginsClassLoader
at jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:582) ~[?:?]
at jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:190) ~[?:?]
at java.lang.ClassLoader.loadClass(ClassLoader.java:499) ~[?:?]
... 15 more
這一步應(yīng)該是 IDEA 的報(bào)錯(cuò)，網(wǎng)上有同學(xué)說是勾選Include dependencies with "Provided" scope地粪，我試了一下沒什么效果取募。然后把 server 包下的 build.gradle 文件修改一下解決了問題。
找到
compileOnly project(':libs:elasticsearch-plugin-classloader')
修改為
compile project(':libs:elasticsearch-plugin-classloader')
改完之后再次運(yùn)行驶忌，會(huì)有一個(gè)空指針報(bào)錯(cuò)矛辕，報(bào)錯(cuò)位置是
server/src/main/java/org/elasticsearch/node/InternalSettingsPreparer.java:119
這里是因?yàn)槲覜]有設(shè)置 node.name，在 elasticsearch.yml 文件中設(shè)置一下就可以了付魔。
現(xiàn)在再點(diǎn)擊 Run/Debug 聊品，就可以成功運(yùn)行了。
遠(yuǎn)程調(diào)試
本地調(diào)試的另一種方法就是遠(yuǎn)程 debug几苍。
首先翻屈，我們進(jìn)入到下載的一個(gè)穩(wěn)定版本的 elasticsearch 目錄，在bin/elasticsearch文件中加上一行代碼
-agentlib:jdwp=transport=dt_socket,server=y,address=8888,suspend=y \
加上之后的代碼如下：
if ! echo $* | grep -E '(^-d |-d$| -d |--daemonize$|--daemonize )' > /dev/null; then
exec \
"$JAVA" \
$ES_JAVA_OPTS \
-agentlib:jdwp=transport=dt_socket,server=y,address=8888,suspend=y \
-Des.path.home="$ES_HOME" \
-Des.path.conf="$ES_PATH_CONF" \
-Des.distribution.flavor="$ES_DISTRIBUTION_FLAVOR" \
-Des.distribution.type="$ES_DISTRIBUTION_TYPE" \
-Des.bundled_jdk="$ES_BUNDLED_JDK" \
-cp "$ES_CLASSPATH" \
org.elasticsearch.bootstrap.Elasticsearch \
"$@"
else
exec \
"$JAVA" \
$ES_JAVA_OPTS \
-Des.path.home="$ES_HOME" \
-Des.path.conf="$ES_PATH_CONF" \
-Des.distribution.flavor="$ES_DISTRIBUTION_FLAVOR" \
-Des.distribution.type="$ES_DISTRIBUTION_TYPE" \
-Des.bundled_jdk="$ES_BUNDLED_JDK" \
-cp "$ES_CLASSPATH" \
org.elasticsearch.bootstrap.Elasticsearch \
"$@" \
<&- &
retval=$?
pid=$!
[ $retval -eq 0 ] || exit $retval
if [ ! -z "$ES_STARTUP_SLEEP_TIME" ]; then
sleep $ES_STARTUP_SLEEP_TIME
fi
if ! ps -p $pid > /dev/null ; then
exit 1
fi
exit 0
fi
exit $?
然后我們執(zhí)行./elasticsearch妻坝，會(huì)出現(xiàn)如下信息伸眶，說明 Elasticsearch 在監(jiān)聽8888端口。
現(xiàn)在我們到 IDEA 中添加一個(gè) Remote Run
接著進(jìn)行端口配置刽宪。
然后就可以選擇這個(gè) Remote 來進(jìn)行 Debug 了厘贼。當(dāng)控制臺(tái)出現(xiàn)
Connected to the target VM, address: 'localhost:8888', transport: 'socket'
說明連接成功了。
我們來實(shí)驗(yàn)一下圣拄，在這個(gè)位置打一個(gè)斷點(diǎn)
server/src/main/java/org/elasticsearch/rest/action/cat/RestHealthAction.java:54
然后在瀏覽器地址欄中輸入
http://localhost:9200/_cat/health
如果進(jìn)入斷點(diǎn)嘴秸，說明我們已經(jīng)可以成功 Debug 了。
總結(jié)
工欲善其事庇谆，必先利其器岳掐。在閱讀源碼之前，我們首先需要搭建好環(huán)境饭耳，本文我們介紹了兩種方法串述，一種是直接在 IDEA 中啟動(dòng) Elasticsearch ，另一種是 Debug 遠(yuǎn)程的 Elasticsearch寞肖。其中第二種方法纲酗，相對(duì)比較簡(jiǎn)單，推薦大家使用新蟆。
