zookeeper开山篇-编译安装与zk基础命令使用

随着软件开发的规模逐渐增大,传统的单体服务已经解决不了逐渐增大的并发流量问题,项目改造为分布式
已经成了一种趋势,伴随而来的是分布式协调相关的一系列问题,而apache的开源组件--zookeeper则是一款
成熟’、热门的分布式协调组件,从本篇开始,zk的学习之旅正式开始

zk是什么

在学习zk之前,我们先了解zk到底是什么?按照官方的说法,ZooKeeper是一个分布式的,开放源码的分布式应用程序协调服务,是Google的Chubby一个开源的实现,是Hadoop和Hbase的重要组件。它是一个为分布式应用提供一致性服务的软件,提供了包括:配置维护、域名服务、分布式同步、组服务等相关功能

zk的下载与安装

接下来我们开始下载zookeeper,这里有两个下载方式,第一个方式则是在zookeeper官网下载,最新版的下载地址如下:

https://mirrors.tuna.tsinghua.edu.cn/apache/zookeeper/zookeeper-3.5.6/

而第二种方式则是在gitHub中搜索Zookeeper,如下:


github搜索zk.png

点击进入后,选择releases进入正式发布的版本中,选择你需要下载的版本,即可


选择正式版下载.png

下载完毕后,我们将下载好的zookeeper-xxx.tar.gz解压到常用安装目录下面即可,然后将conf目录下的zoo_sample.cfg文件,复制一份,重命名为zoo.cfg,如下:


zoo.png

接着,我们打开zoo.cfg文件,将dataDir=/tmp/zookeeper修改成zookeeper安装目录所在的data文件夹(安装完以后需要手动创建zk的data文件夹和log存放的目录),并且添加dataLogDir(日志存放目录),如下:


配置日志和数据存放目录.png

配置完毕后,我们来启动zk服务,双击运行bin目录下的zkServer.cmd文件即可

编译zk源码

除了前面的直接下载zk的正式版以外,我们也可以选择下载zk源码,进行编译,然后配置启动zk服务端,此种方式的好处是zk的所有代码和启动类代码等都可以进行自定义编写和修改,但是较为繁琐,我们先来了解一下:

1.zk源码需要使用Ant进行编译,所以我们需要进入Ant官网下载对应的版本,进行配置

下载地址如下:http://ant.apache.org/bindownload.cgi ,这里需要注意的是我们下载的ant版本分为jdk1.5兼容版本和jdk1.8版本,我们需要按照当前开发环境的jdk版本以及需要编译的zk源码的版本与之对应,点击下载:

ant下载.png

下载完成后,我们将其解压,开始配置环境变量,例如:

ANT_HOME=E:\apache-ant-1.10.5

并且我们需要在全局的path路径下添加一个%ANT_HOME%\bin ,配置完毕后,我们进入cmd窗口,执行如下命令:

C:\Users\Administrator>ant -version
Apache Ant(TM) version 1.10.7 compiled on September 1 2019

可以看到成功返回了ant的版本信息,代表此时配置已经成功

2.进入github进行下载,我们找到当前所有的branchs:

git下载分支zk.png

找到我们需要版本的分支,进行git下载:

$ git clone -b branch-3.5.6 https://github.com/apache/zookeeper.git
Cloning into 'zookeeper'...
remote: Enumerating objects: 1, done.
remote: Counting objects: 100% (1/1), done.
remote: Total 59332 (delta 0), reused 0 (delta 0), pack-reused 59331
Receiving objects: 100% (59332/59332), 113.97 MiB | 41.00 KiB/s, done.
Resolving deltas: 100% (38347/38347), done.

3.进入刚才下载的zk源码目录,启动cmd窗口,输入编译命令

G:\开发软件>cd zk-3.5.6
G:\开发软件\zk-3.5.6>cd apache-zookeeper-3.5.6
G:\开发软件\zk-3.5.6\apache-zookeeper-3.5.6>ant eclipse

然后等待最终编译成功输出,如果为 build successful字样则为成功

build success.png

接下来,我们将代码导入开发工具(官方使用的是eclipse,这里我们使用ieda),


导入zk源码.png

一路next,最后将maven编译完成,即可完成源码的编译,我们可以看到源码的目录如下:


zk目录结构.png

而加载完毕后,我们可以看到,zk3.5版本起,官方将模块分离出来了,多出了很多的子模块,比如文档说明相关在zookeeper-docs工程下,而zk的一些基础数据结构类定义相关则在zookeeper-jute工程下,而zk的客户端和服务端相关的代码则是分别在zookeeper-clientzookeeper-server工程下,而在server工程下我们可以找到两个启动类: ZooKeeperServerMain以及QuorumPeerMain,分别位于org.apache.zookeeper.serverorg.apache.zookeeper.server.quorum包下,其中单机版的zk使用ZooKeeperServerMain作为启动类,集群版的zk使用QuorumPeerMain启动类。现在我们尝试启动单机版的zk,运行ZooKeeperServerMain类,结果如下:

错误: 找不到或无法加载主类 org.apache.zookeeper.server.ZooKeeperServerMain

这是怎么回事呢?难道是jdk版本不对?但是我们查阅了官网,zk3.5.x版本对应的jdk的确是1.8,那么只有一种可能就是编译出来的class不是当前jdk编译的,我们这里选择将zookeeper-server的工程重新编译一下:

重新编译zookeeper-server.png

却看到compile的时候控制台报错了,如下:

[ERROR] Failed to execute goal org.codehaus.mojo:properties-maven-plugin:1.0.0:read-project-properties (default) on project zookeeper:
Properties could not be loaded from File: D:\360安全浏览器下载\zk-3.5.6 - 副本\zookeeper-server\src\main\resources\git.properties -> [Help 1]

看报错的原因,似乎是有部分代码使用了resources\git.properties文件的配置,但是我们找了一下,在github上的代码中不会存在git.properties,那么是哪里出问题了呢?我们来到pom中找到了properties-maven-plugin插件,看到了如下的配置:

<plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>properties-maven-plugin</artifactId>
        <executions>
          <execution>
            <phase>initialize</phase>
            <goals>
              <goal>read-project-properties</goal>
            </goals>
            <configuration>
              <files>
                <file>${basedir}/src/main/resources/git.properties</file>
              </files>
            </configuration>
          </execution>
        </executions>
      </plugin>

原来是这里初始化的时候会加载该配置文件的内容,除此之外我们还注意到一个插件exec-maven-plugin,里面使用了部分参数在项目中并不存在,应该是引用了git.properties的配置参数导致了pom报错,并且初始化编译失败,如下:

<plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>exec-maven-plugin</artifactId>
        <executions>
          <execution>
            <id>generate-version-info</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>exec</goal>
            </goals>
            <configuration>
              <workingDirectory>${project.basedir}/src/main/java/</workingDirectory>
              <executable>java</executable>
              <arguments>
                <argument>-classpath</argument>
                <classpath />
                <argument>org.apache.zookeeper.version.util.VerGen</argument>
                <argument>${project.version}</argument>
                <argument>${git.commit.id}</argument>
                <argument>${build.time}</argument>
              </arguments>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>

并且我们也可以看到,这里需要这些参数的原因是为了配置VerGen的版本、时间等参数,查阅官方github才知道,VerGen仅仅是为了开发迭代的时候区分每个人的版本不重复冲突使用的,我们个人运行和查阅源码可以选择固定一个值,所以接下来我们来将properties-maven-plugin插件注释掉,并且将${git.commit.id}与

${build.time}两个参数改为自己的值,然后我们再次执行 mvn compile命令,此次编译成功!再次运行main方法,发现控制台出现了新的问题,输入如下:

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.
Usage: ZooKeeperServerMain configfile | port datadir [ticktime] [maxcnxns]

但是我们当前的启动类没有配置log4j,导致无法输出对应的日志信息,我们找到当前test包下的resources里面的log4j.properties文件,在当前启动类配置上对应的文件目录(vm options):

-Dlog4j.configuration=file:G:\开发软件\zookeeper-release-3.5.6\zookeeper-server\src\test\resources\log4j.properties

再次运行,发现启动报错了:

2020-01-07 01:28:48,727 [myid:] - ERROR [main:ZooKeeperServerMain@66] - Invalid arguments, exiting abnormally
java.lang.IllegalArgumentException: Invalid number of arguments:[]
    at org.apache.zookeeper.server.ServerConfig.parse(ServerConfig.java:60)
    at org.apache.zookeeper.server.ZooKeeperServerMain.initializeAndRun(ZooKeeperServerMain.java:103)
    at org.apache.zookeeper.server.ZooKeeperServerMain.main(ZooKeeperServerMain.java:64)
2020-01-07 01:28:48,729 [myid:] - INFO  [main:ZooKeeperServerMain@67] - Usage: ZooKeeperServerMain configfile | port datadir [ticktime] [maxcnxns]

从报错信息可以得出,我们需要一个运行时传递的参数,但是没有配置,而这个参数就是我们启动服务的时候需要修改的zoo.cfg文件,再次配置修改完毕(上面启动用的zoo.cfg)的文件,如下:

启动main配置.png

这时我们再次运行,即可成功启动zk的单机服务!

cli常用命令

zk服务端启动以后,我们来开始学习zk客户端命令,首先双击zkCli.cmd,会默认进行本地的zk连接操作,如下:

zk客户端.png

help

我们先来看看zk有哪些命令操作,在cmd窗口中输入help命令回车,即可查看到zk当前支持的所有的命令,如下:

[zk: localhost:2181(CONNECTED) 0] help
ZooKeeper -server host:port cmd args
        stat path [watch]
        set path data [version]
        ls path [watch]
        delquota [-n|-b] path
        ls2 path [watch]
        setAcl path acl
        setquota -n|-b val path
        history
        redo cmdno
        printwatches on|off
        delete path [version]
        sync path
        listquota path
        rmr path
        get path [watch]
        create [-s] [-e] path data acl
        addauth scheme auth
        quit
        getAcl path
        close
        connect host:port

接下来我们来学习常见的一些命令操作

ls 查看

如果我们想要查看当前的zk路径下存在哪些文件,这个时候就需要使用到ls系列的命令了,语法为ls path [watch],我们输入ls 以及对应的路径即可查看,如下:

[zk: localhost:2181(CONNECTED) 0] ls /
[zookeeper]

由于这里我们没有创建节点,所以输出的结果为空

create -s -e path data acl 创建节点(-s:有顺序的节点 -e:临时的节点 acl:当前节点的权限)

我们知道zk里有节点的概念,用来存储数据,会绑定对应的路径,这里我们先来创建一个简单的节点:

[zk: localhost:2181(CONNECTED) 2] create /root root
Created /root

get path [watch] 获取节点内容[可添加监听]

创建节点命令成功了,这里我们来通过get命令查看刚刚创建的节点吧,如下:

[zk: localhost:2181(CONNECTED) 3] get /root
root
cZxid = 0x5
ctime = Wed Jan 01 22:30:10 CST 2020
mZxid = 0x5
mtime = Wed Jan 01 22:30:10 CST 2020
pZxid = 0x5
cversion = 0
dataVersion = 0
aclVersion = 0
ephemeralOwner = 0x0
dataLength = 4
numChildren = 0

可以看到当我们获取/root节点的数据的时候,出现了一堆属性,比如cZxid、ctime等,那么这些属性是什么意思呢?别着急,暂时留下一个悬念,后面我们会针对这些属性进行详细的讲解

stat path [watch] 节点更新[可添加监听]

如果我们需要给某一个节点的内容进行更新操作,可以使用stat命令对某个节点进行更新,如下:

[zk: localhost:2181(CONNECTED) 4] stat /root update_root
cZxid = 0x5
ctime = Wed Jan 01 22:30:10 CST 2020
mZxid = 0x5
mtime = Wed Jan 01 22:30:10 CST 2020
pZxid = 0x5
cversion = 0
dataVersion = 0
aclVersion = 0
ephemeralOwner = 0x0
dataLength = 4
numChildren = 0

ls2 path [watch] ls和stat的整合[可添加监听]

还记得上面的命令有ls,可以查看当前路径下的节点,但是还有个ls2是干啥的呢?其实ls2命令则是将ls与stat操作进行合并,实现了一个命令查看当前节点下的其他节点并且修改当前节点内容的操作,如下:

[zk: localhost:2181(CONNECTED) 5] ls2 /root ls2_update_root
[]
cZxid = 0x5
ctime = Wed Jan 01 22:30:10 CST 2020
mZxid = 0x5
mtime = Wed Jan 01 22:30:10 CST 2020
pZxid = 0x5
cversion = 0
dataVersion = 0
aclVersion = 0
ephemeralOwner = 0x0
dataLength = 4
numChildren = 0

可以看到既返回了当前节点路径下的所有节点集合,这里因为没有创建子节点,所以返回了[],并且我们设置的新的节点内容也生效并且返回了

delete path [version] 删除指定节点[可以指定版本号]

创建完节点以后,我们可以给对应路径的节点进行删除,并且需要注意的是,我们可以指定删除的版本号,即可以实现乐观锁更新,防止误操作,如下:

[zk: localhost:2181(CONNECTED) 1] get /root
root
cZxid = 0x5
ctime = Wed Jan 01 22:30:10 CST 2020
mZxid = 0x5
mtime = Wed Jan 01 22:30:10 CST 2020
pZxid = 0x5
cversion = 0
dataVersion = 1
aclVersion = 0
ephemeralOwner = 0x0
dataLength = 4
numChildren = 0
[zk: localhost:2181(CONNECTED) 3] delete /root 1
[zk: localhost:2181(CONNECTED) 4] get /root
Node does not exist: /root

可以看到,我们查询出的对应的dataVersion为1,所以当我们删除的时候指定了版本1,再次查询的时候报错,即节点已经被删除(Node does not exist: /root)

推荐阅读更多精彩内容