［1］elasticsearch源码编译

2017-12-03 本文已影响176人飞来来

本文是elasticsearch源码分析系列文档的第一篇，本篇简单介绍了elasticsearch源码在本机的编译环境搭建

用到的工具有：IntelliJ Idea，JDK1.8，gradle3.5，elasticsearch-6.0.0-rc2的发行版

下载准备

首先从gihut上download下来elasticsearch的主干版本，导入IDE后看到缺少很多依赖包，是因为还没有使用gradle编译项目。

导入IDE后看到缺少很多包.png

首先查看elasticsearch源码的当前版本，在类org.elasticsearch.Version#CURRENT中能看到，查看到当前master的版本是7.0.0-alpha1版本，而该版本官网发行版没有，该版本的文档页也是刚建立，所以将ide中的代码切换到6.0.0-rc2,因为这个版本是能在官网下载到比较新的发行版的版本，如下图：

在ide中切换到6.0版本.png

切换完成后，去官网下载6.0.0-rc2的发行版本，待会用得到。如下图：

官网下载6.0.0-rc2的发行版.png

因为elasticsearch在5.X版本后默认的编译工具从Maven换到了Gradle。需要在本机配置好Gradle环境，如有必要可以切换国内的源。本机使用Gradle3.5和JDK1.8编译elasticsearch。建议Gradle版本不要太高。如下图：

修改gradle仓库配置.png

开始编译

如果现在就在IDE中执行gradle idea（如果IDE是eclipse，那命令就是gradle idea），会提示，“必须在导入前执行gradle idea”，如下图：

提示必须在导入idea之前执行gradle idea命令.png

cmd切换到core目录下，运行gradle idea命令（因为用的IDE是idea，如果IDE是Eclipse，则使用Gradle eclipse命令）。如下图：

本地编译elasticsearch成功.png

再切换到elasticsearch的根目录下运行gradle idea 命令，如果编译成功的话会显示如图：

在elasticsearch根目录下编译成功.png

编译成功后，启动IDE，idea会进行很长时间的gradle的配置，等待配置完毕后，查看项目如下图，基本能看到项目的概览：

t-8编译好后导入IDE结果.png

启动路径

elasticsearch的启动文件是elasticsearch
文件中提到了path.conf,搜索该字段找到了distribution包中的rpm/src/main/packaging/init.d/,这就是elasticsearch的初始化的地方，path.conf等一些参数也是在这里被设置的。

根据启动脚本找到main方法的入口org.elasticsearch.bootstrap.Elasticsearch，该方法继承自EnvironmentAwareCommand类，这个类主要是一些参数指定与程序启动。
而EnvironmentAwareCommand又继承自Command类，继承关系如下图：

启动类的继承关系.png

Elasticsearch中的main方法其实是调用了Command的main方法，这个方法在创建了了shutdown钩子后，配置了logging，最后执行mainWithoutErrorHandling方法，这个方法最后会调用EnvironmentAwareCommand的execute方法。如下图：

Command类中的main方法.png

EnvironmentAwareCommand环境构造类通过execute方法构造了elasticsearch的各种参数，如path.data，path.home，path.logs，然后通过该类的createEnv方法构造运行配置，如图：

EnvironmentAwareCommand类的execute方法.png

EnvironmentAwareCommand类的createEnv方法.png

这时运行main方法后会提示错误：

执行main方法后提示错误找不到es.path.conf.png

查看源码可以知道es.path.conf被作为参数传递，如下图：

t-11配置的Des.path.conf被作为参数传递.png

参数配置

这一步用到了刚才下载的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方法中会将设定值作为参数传递。

配置启用发行版的配置和插件运行.png

在配置好了以上三个参数后，elasticsearch的本地启动就会读取发行版的参数，插件和模块，从而成功运行。

运行中遇到的问题

有可能会遇到java安全策略的问题

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

有可能会遇到module中jar包的SNAPSHOT版本问题

在org.elasticsearch.bootstrap.Security类的readPolicy()方法中，代码探测到目前运行的是snapshot版本，但是在我们下载解压的发行版本中的elasticsearch-rest-client-6.0.0-rc2.jar确是发行版的，把这个jar包的名称改成snapshot版本（elasticsearch-rest-client-6.0.0-rc2-SNAPSHOT），就能正常运行，如下图：

jar包版本问题.png

节点不可写

org.elasticsearch.bootstrap.StartupException: java.lang.IllegalStateException: failed to obtain node locks, tried [[/usr/local/elasticsearch-5.2.0/data/my-application]] with lock id [0]; maybe these locations are not writable or multiple nodes were started without increasing
则：
删除/data目录下的内容
rm -rf nodes/

成功运行

成功运行后，可以使用127.0.0.1:9200来测试啦，测试成功后就能进行代码的调试。

成功运行.png