本文是elasticsearch源码分析系列文档的第一篇,本篇简单介绍了elasticsearch源码在本机的编译环境搭建java
用到的工具备:IntelliJ Idea,JDK1.8,gradle3.5,elasticsearch-6.0.0-rc2的发行版bootstrap
首先从gihut上download下来elasticsearch的主干版本,导入IDE后看到缺乏不少依赖包,是由于尚未使用gradle编译项目。 安全
首先查看elasticsearch源码的当前版本,在类org.elasticsearch.Version#CURRENT中能看到,查看到当前master的版本是7.0.0-alpha1版本,而该版本官网发行版没有,该版本的文档页也是刚创建,因此将ide中的代码切换到6.0.0-rc2,由于这个版本是能在官网下载到比较新的发行版的版本,以下图: eclipse
切换完成后,去官网下载6.0.0-rc2的发行版本,待会用获得。以下图:jvm
由于elasticsearch在5.X版本后默认的编译工具从Maven换到了Gradle。须要在本机配置好Gradle环境,若有必要能够切换国内的源。本机使用Gradle3.5和JDK1.8编译elasticsearch。建议Gradle版本不要过高。以下图:elasticsearch
若是如今就在IDE中执行gradle idea(若是IDE是eclipse,那命令就是gradle idea),会提示,“必须在导入前执行gradle idea”,以下图:ide
cmd切换到core目录下,运行gradle idea命令(由于用的IDE是idea,若是IDE是Eclipse,则使用Gradle eclipse命令)。以下图:工具
再切换到elasticsearch的根目录下运行gradle idea 命令,若是编译成功的话会显示如图:源码分析
编译成功后,启动IDE,idea会进行很长时间的gradle的配置,等待配置完毕后,查看项目以下图,基本能看到项目的概览:测试
elasticsearch的启动文件是elasticsearch 文件中提到了path.conf,搜索该字段找到了distribution包中的rpm/src/main/packaging/init.d/,这就是elasticsearch的初始化的地方,path.conf等一些参数也是在这里被设置的。
根据启动脚本找到main方法的入口org.elasticsearch.bootstrap.Elasticsearch,该方法继承自EnvironmentAwareCommand类,这个类主要是一些参数指定与程序启动。 而EnvironmentAwareCommand又继承自Command类,继承关系以下图:
Elasticsearch中的main方法实际上是调用了Command的main方法,这个方法在建立了了shutdown钩子后,配置了logging,最后执行mainWithoutErrorHandling方法,这个方法最后会调用EnvironmentAwareCommand的execute方法。以下图:
EnvironmentAwareCommand环境构造类经过execute方法构造了elasticsearch的各类参数,如path.data,path.home,path.logs,而后经过该类的createEnv方法构造运行配置,如图:
这时运行main方法后会提示错误:
查看源码能够知道es.path.conf被做为参数传递,以下图:
这一步用到了刚才下载的elasticsearch发行版本包,把下载的发行版本包解压,在Run/Debug Configurations配置窗口中,配置VM options参数为:
-Des.path.conf=D:\seymour\elasticsearch\elasticsearch-6.0.0-rc2
-Des.path.home=D:\seymour\elasticsearch\elasticsearch-6.0.0-rc2
-Dlog4j2.disable.jmx=true
复制代码
路径D:\idea\workspace\elasticsearch\distribution\src\main\resources是下载解压好的发行版路径。
设定参数后在EnvironmentAwareCommand的createEnv方法中会将设定值做为参数传递。
在配置好了以上三个参数后,elasticsearch的本地启动就会读取发行版的参数,插件和模块,从而成功运行。
access denied ("javax.management.MBeanTrustPermission" "register") 解决方法是新建一个java策略文件elasticsearch.policy
内容是:
grant{
permission javax.management.MBeanTruxtPermission "register";
permission javax.management.MBeanServerPermission "createMBeanServer";
};
复制代码
再添加jvm参数:
-Djava.security.policy=/User/seymour/workspace/elasticsearch.policy
复制代码
在org.elasticsearch.bootstrap.Security类的readPolicy()方法中,代码探测到目前运行的是snapshot版本,可是在咱们下载解压的发行版本中的elasticsearch-rest-client-6.0.0-rc2.jar确是发行版的,把这个jar包的名称改为snapshot版本(elasticsearch-rest-client-6.0.0-rc2-SNAPSHOT),就能正常运行,以下图:
成功运行后,可使用127.0.0.1:9200来测试啦,测试成功后就能进行代码的调试。