【ZooKeeper系列】3.ZooKeeper源码环境搭建
前文阅读:
【ZooKeeper系列】1.ZooKeeper单机版、伪集群和集群环境搭建
【ZooKeeper系列】2.用Java实现ZooKeeper API的调用
在系列的前两篇文章中,介绍了ZooKeeper环境的搭建(包括单机版、伪集群和集群),对创建、删除、修改节点等场景用命令行的方式进行了测试,让大家对ZooKeeper环境搭建及常用命令行有初步的认识,也为搭建ZooKeeper的开发环境、生产环境起到了抛砖引玉的作用。也介绍了用Java来实现API的调用,包括节点的增、删、改、查。通过对这两篇的学习,让大家对ZooKeeper的使用有了初步认识,也可用于实现系列后面篇章要介绍的命名服务、集群管理、分布式锁、负载均衡、分布式队列等。
在前两篇中,强调了阅读英文文档的重要性,也带领大家解读了部分官方文档,想传达出的理念是ZooKeeper没有想象中的那么难,阅读官方文档也没那么难。后面的篇章中,结合官方文档,在实战演练和解读源码的基础上加深理解。
上联:说你行你就行不行也行
下联:说不行就不行行也不行
横批:不服不行
阅读源码就跟这个对联一模一样,就看你选上联,还是下联了!
这一篇开始源码环境的搭建,here we go
!
很多老铁留言说很想研读些github上的开源项目,但代码clone下来后总出现这样或那样奇奇怪怪的问题,很影响学习的积极性。学习ZooKeeper的源码尤其如此,很多人clone代码后,报各种错,提示少各种包。问了下度娘ZooKeeper源码环境,搜出来的文章真的差强人意,有些文章错的竟然非常离谱。这里我重新搭建了一遍,也会介绍遇到的一些坑。
很多老铁上来一堆猛操作,从github上下载了ZooKeeper源码后,按常规方式导入IDEA,最后发现少各种包。起初我也是这样弄的,以为ZooKeeper是用Maven来构建的,仔细去了解了下ZooKeeper的版本历史,其实是用的Ant。如今一般用的Maven或Gradle,很少见到Ant的项目了,这里不对Ant多做介绍。
1 Ant环境搭建
Ant官网地址:https://ant.apache.org/bindownload.cgi
下载解压后,跟配置jdk一样配置几个环境变量:
//修改为自己本地安装的目录
ANT_HOMT=D:\apache-ant-1.10.7
PATH=%ANT_HOME%/bin
CLASSPATH=%ANT_HOME%/lib
配置好后,测试下Ant是否安装成功。ant -version,得到如下信息则代表安装成功:
Apache Ant(TM) version 1.10.7 compiled on September 1 2019
Ant的安装跟JDK的安装和配置非常相似,这里不做过多介绍。
2 下载ZooKeeper源码
源码地址:https://github.com/apache/zookeeper
猿人谷在写本篇文章时,releases列表里的最新版本为release-3.5.6
,我们以此版本来进行源码环境的搭建。
3 编译ZooKeeper源码
切换到源码所在目录,运行ant eclipse
将项目编译并转成eclipse的项目结构。
这个编译过程会比较长,差不多等了7分钟。如果编译成功,会出现如下结果:
4 导入IDEA
上面已经将项目编译并转成eclipse的项目结构,按eclipse的形式导入项目。
5 特别说明
将源码导入IDEA后在org.apache.zookeeper.Version
中发现很多红色警告,很明显少了org.apache.zookeeper.version.Info
类。
查询源码得知是用来发布的时候生成版本用的,我们只是研读源码,又不发布版本所以直接写死就ok了。
即新增Info类:
package org.apache.zookeeper.version;
public interface Info {
int MAJOR = 3;
int MINOR = 5;
int MICRO = 6;
String QUALIFIER = null;
String REVISION_HASH = "c11b7e26bc554b8523dc929761dd28808913f091";
String BUILD_DATE = "10/08/2019 20:18 GMT";
}
6 启动zookeeper
针对单机版本和集群版本,分别对应两个启动类:
- 单机:ZooKeeperServerMain
- 集群:QuorumPeerMain
这里我们只做单机版的测试。
在conf目录里有个zoo_sample.cfg,复制一份重命名为zoo.cfg。
zoo.cfg里的内容做点修改(也可以不做修改),方便日志查询。dataDir和dataLogDir根据自己的情况设定。
dataDir=E:\\02private\\1opensource\\zk\\zookeeper\\dataDir
dataLogDir=E:\\02private\\1opensource\\zk\\zookeeper\\dataLogDir
运行主类 org.apache.zookeeper.server.ZooKeeperServerMain
,将zoo.cfg的完整路径配置在Program arguments。
运行ZooKeeperServerMain
,得到的结果如下:
Connected to the target VM, address: '127.0.0.1:0', transport: 'socket'
log4j:WARN No appenders could be found for logger (org.apache.zookeeper.jmx.ManagedUtil).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
告知日志无法输出,日志文件配置有误。这里需要指定日志文件log4j.properties。
在VM options配置,即指定到conf目录下的log4j.properties:
-Dlog4j.configuration=file:E:/02private/1opensource/zk/zookeeper/conf/log4j.properties
配置后重新运行ZooKeeperServerMain
,输出日志如下,
可以得知单机版启动成功,单机版服务端地址为127.0.0.1:2181。
7 启动客户端
通过运行ZooKeeperServerMain
得到的日志,可以得知ZooKeeper服务端已经启动,服务的地址为127.0.0.1:2181
。启动客户端来进行连接测试。
客户端的启动类为org.apache.zookeeper.ZooKeeperMain
,进行如下配置:
即客户端连接127.0.0.1:2181,获取节点/yuanrengu
的信息。
下面带领大家一起看看客户端启动的源码(org.apache.zookeeper.ZooKeeperMain
)。这里要给大家说下我阅读源码的习惯,很多老铁以为阅读源码就是顺着代码看,这样也没啥不对,只是很多开源项目代码量惊人,这么个干看法,容易注意力分散也容易看花眼。我一般是基于某个功能点,从入口开始debug跑一遍,弄清这个功能的“代码线”,就像跑马圈块地儿一样,弄清楚功能有关的代码,了解参数传递的过程,这样看代码时就更有针对性,也能排除很多干扰代码。
7.1 main
main里就两行代码,通过debug得知args里包含的信息就是上面我们配置在Program arguments里的信息:
7.1.1 ZooKeeperMain
public ZooKeeperMain(String args[]) throws IOException, InterruptedException {
// 用于解析参数里的命令行的
cl.parseOptions(args);
System.out.println("Connecting to " + cl.getOption("server"));
// 用于连接ZooKeeper服务端
connectToZK(cl.getOption("server"));
}
通过下图可以看出,解析参数后,就尝试连接127.0.0.1:2181,即ZooKeeper服务端。cl.getOption("server")得到的就是127.0.0.1:2181。
7.1.2 parseOptions
可以很清楚的得知解析args的过程,主要从"-server","-timeout","-r","-"这几个维度来进行解析。
7.1.3 connectToZK
protected void connectToZK(String newHost) throws InterruptedException, IOException {
// 用于判断现在ZooKeeper连接是否还有效
// zk.getState().isAlive() 注意这个会话是否有效的判断,客户端与 Zookeeper连接断开不一定会话失效
if (zk != null && zk.getState().isAlive()) {
zk.close();
}
// 此时newHost为127.0.0.1:2181
host = newHost;
// 判断是否为只读模式,关于只读模式的概念在前一篇文章中有介绍
boolean readOnly = cl.getOption("readonly") != null;
// 用于判断是否建立安全连接
if (cl.getOption("secure") != null) {
System.setProperty(ZKClientConfig.SECURE_CLIENT, "true");
System.out.println("Secure connection is enabled");
}
zk = new ZooKeeperAdmin(host, Integer.parseInt(cl.getOption("timeout")), new MyWatcher(), readOnly);
}
ZKClientConfig.SECURE_CLIENT
已经被标注为deprecation了:
/**
* Setting this to "true" will enable encrypted client-server communication.
*/
@SuppressWarnings("deprecation")
public static final String SECURE_CLIENT = ZooKeeper.SECURE_CLIENT;
debug查看关键点处的信息,可以得知这是建立一个ZooKeeper连接的过程(【ZooKeeper系列】2.用Java实现ZooKeeper API的调用,这篇文章里详细介绍过ZooKeeper建立连接的过程)
下图看看几处关键信息:
Integer.parseInt(cl.getOption("timeout"))为30000。
至此完成了ZooKeeperMain main = new ZooKeeperMain(args);的整个过程。简短点说就是:
- 解析Program arguments里的参数
- 连接ZooKeeper服务端
7.2 main.run()
敲黑板,重头戏来了哦!
一起来看下run()的代码:
void run() throws CliException, IOException, InterruptedException {
// cl.getCommand()得到的是 “get”,就是上文传进来的
if (cl.getCommand() == null) {
System.out.println("Welcome to ZooKeeper!");
boolean jlinemissing = false;
// only use jline if it's in the classpath
try {
Class<?> consoleC = Class.forName("jline.console.ConsoleReader");
Class<?> completorC =
Class.forName("org.apache.zookeeper.JLineZNodeCompleter");
System.out.println("JLine support is enabled");
Object console =
consoleC.getConstructor().newInstance();
Object completor =
completorC.getConstructor(ZooKeeper.class).newInstance(zk);
Method addCompletor = consoleC.getMethod("addCompleter",
Class.forName("jline.console.completer.Completer"));
addCompletor.invoke(console, completor);
String line;
Method readLine = consoleC.getMethod("readLine", String.class);
while ((line = (String)readLine.invoke(console, getPrompt())) != null) {
executeLine(line);
}
} catch (ClassNotFoundException e) {
LOG.debug("Unable to start jline", e);
jlinemissing = true;
} catch (NoSuchMethodException e) {
LOG.debug("Unable to start jline", e);
jlinemissing = true;
} catch (InvocationTargetException e) {
LOG.debug("Unable to start jline", e);
jlinemissing = true;
} catch (IllegalAccessException e) {
LOG.debug("Unable to start jline", e);
jlinemissing = true;
} catch (InstantiationException e) {
LOG.debug("Unable to start jline", e);
jlinemissing = true;
}
if (jlinemissing) {
System.out.println("JLine support is disabled");
BufferedReader br =
new BufferedReader(new InputStreamReader(System.in));
String line;
while ((line = br.readLine()) != null) {
executeLine(line);
}
}
} else {
// 处理传进来的参数
processCmd(cl);
}
System.exit(exitCode);
}
通过下图可以看出processCmd(cl);
里cl
包含的信息:
debug到processCmd(MyCommandOptions co)
就到了决战时刻。里面的processZKCmd(MyCommandOptions co)
就是核心了,代码太长,只说下processZKCmd里的重点代码,获取节点/yuanrengu的信息:
因为我之前没有创建过/yuanrengu节点,会抛异常org.apache.zookeeper.KeeperException$NoNodeException: KeeperErrorCode = NoNode for /yuanrengu
, 如下图所示:
经过上面的步骤后exitCode为1,执行System.exit(exitCode);退出。
至此带领大家dubug了一遍org.apache.zookeeper.ZooKeeperMain,上面我说过,阅读源码干看效果很小,只有debug才能有助于梳理流程和思路,也能清楚参数传递的过程发生了什么变化。
温馨提示
上面我们介绍了源码环境的搭建过程,运行运行主类 org.apache.zookeeper.server.ZooKeeperServerMain
启动ZooKeeper服务端,运行org.apache.zookeeper.ZooKeeperMain
连接服务端。
阅读源码最好能动起来(debug)读,这样代码才是活的,干看的话代码如死水一样,容易让人索然无味!
每个人操作的方式不一样,有可能遇到的问题也不一样,搭建过程中遇到什么问题,大家可以在评论区留言。
【ZooKeeper系列】3.ZooKeeper源码环境搭建的更多相关文章
- Linux Kafka源码环境搭建
本文主要讲述的是如何搭建Kafka的源码环境,主要针对的Linux操作系统下IntelliJ IDEA编译器,其余操作系统或者IDE可以类推. 1.安装和配置JDK确认JDK版本至少为1.7,最好是1 ...
- MyBatis源码环境搭建
之前研究mybatis都是参考前面学习的人的一些经验,并没有自己搭建源码环境进行.现在以mybatis3.4.6版本搭建,搭建过程中各种failed,下面大致记录环境搭建过程. 1.mybatis3. ...
- 1-web应用之LAMP源码环境搭建
目录 一.LAMP环境的介绍 1.LAMP环境的重要性 2.LAMP组件介绍 二.Apache源码安装 1.下载Apache以及相关依赖包 2.安装Apache以及相关 ...
- 【一步一步】Spring 源码环境搭建
平时项目中基本上都会用到spring,但是源码还没有深入的了解过.趁这段时间稍微空闲点,开始研究下spring 源码.下面是spring 源码的环境搭建. 主要分为如下步骤: ①安装jdk,gradl ...
- Spring源码阅读 源码环境搭建(一)
ring 源码阅读的搭建(一) 一 下载spring源码 进入官方网页:https://spring.io/projects/spring-framework 进入相关的github位置,下载zip包 ...
- Hadoop源码学习笔记之NameNode启动场景流程一:源码环境搭建和项目模块及NameNode结构简单介绍
最近在跟着一个大佬学习Hadoop底层源码及架构等知识点,觉得有必要记录下来这个学习过程.想到了这个废弃已久的blog账号,决定重新开始更新. 主要分以下几步来进行源码学习: 一.搭建源码阅读环境二. ...
- Tomcat7源码环境搭建
一.下载Tomcat7源码 从官网上下载Tomcat源码, http://mirror.bit.edu.cn/apache/tomcat/tomcat-7/v7.0.70/src/apache-t ...
- Spring 5.2.x 源码环境搭建(Windows 系统环境下)
前期准备 1.确保本机已经安装好了 Git 2.Jdk 版本至少为 1.8 3.安装好 IntelliJ IDEA (其他开发工具,如 eclipse.Spring Tool Suite 等也是可以的 ...
- Tomcat 源码环境搭建
Tomcat 源码搭建 下载源码 下载地址 :https://tomcat.apache.org/download-80.cgi#8.5.35 下载之后解压缩 导入Idea 添加pom.xml文件 & ...
随机推荐
- sql —— like
用于在 WHERE 子句中搜索列中的指定模式. 原表: 一.% %表示任何字符出现任意次数. 1.以某个字符串开头的数据 2.包含某个字符串的数据 3.以某个字符串结尾的数据 二._ 只适用于匹配单个 ...
- iOS 设计 用户为王 - 关于征询授权、注册及加载等待的体验优化
你要做的东西一定要是你无比渴望这世界上能出现的东西,这股热情和能量将会融入到你的应用中,成为它腾飞的初速度,为你带来积极反馈.把自己当做app最重要的用户,这一点非常重要. http://www.co ...
- @loj - 2091@ 「ZJOI2016」小星星
目录 @description@ @solution@ @accepted code@ @details@ @description@ 小 Y 是一个心灵手巧的女孩子,她喜欢手工制作一些小饰品.她有 ...
- Liunx vi/vim 2
移动光标的方法 H 光标移动到这个屏幕的最上方那一行的第一个字符 M 光标移动到这个屏幕的中央那一行的第一个字符 L 光标移动到这个屏幕的最下方那一行的第一个字符 G 移动到这个档案的最后一行(常用 ...
- H3C Telnet配置例子
- oracle函数 round(x[,y])
[功能]返回四舍五入后的值 [参数]x,y,数字型表达式,如果y不为整数则截取y整数部分,如果y>0则四舍五入为y位小数,如果y小于0则四舍五入到小数点向左第y位. [返回]数字 [示例] se ...
- HTML5--语法
一.标记方法 1.内容类型(ContentType)还是.text/html 2.声明:<!DOCTYPE html SYSTEM “about:legacy-compat”> 3.字符编 ...
- SuperSocket SuperWebSocket并发数100限制的问题
var wsSer = new WebSocketServer(); wsSer.NewMessageReceived += wsSer_NewMessageReceived;//有消息传入时事件 w ...
- 手动实现如何从H264流中提取SPS/PPS信息
1,代码比较简单,可以直接用了.流的第一个NALU一定是SPS void get_sps_pps_nalu(uint8_t *data, int len, std::vector<uint8_t ...
- 列出display的值,说明他们的作用。position的值, relative和 absolute定位原点是?
display的值: block 像块类型元素一样显示. none 像行内元素类型一样显示. inline-block 像行内元素一样显示, 但其内容像块类型元素一样显示. list-item 像块类 ...