1-Zookeeper 基本API使用

最新推荐文章于 2025-01-22 07:36:20 发布

原创最新推荐文章于 2025-01-22 07:36:20 发布 · 451 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

Zookeeper 专栏收录该内容

9 篇文章

订阅专栏

连接ZK集群

使用 ./zkCli.sh -server ip:port

root@ubuntu-130:/opt/apache-zookeeper-3.5.8-bin/bin# ./zkCli.sh -server 192.168.13.130

如果是本主机部署了ZK，则直接使用 /zkCli.sh 就可以连接ZK客户端

root@ubuntu-130:/opt/apache-zookeeper-3.5.8-bin/bin# ./zkCli.sh
Connecting to localhost:2181
2021-04-04 17:05:55,629 [myid:] - INFO  [main:Environment@109] - Client environment:zookeeper.version=3.5.8-f439ca583e70862c3068a1f2a7d4d068eec33315, built on 05/04/2020 15:07 GMT
2021-04-04 17:05:55,637 [myid:] - INFO  [main:Environment@109] - Client environment:host.name=ubuntu-130
2021-04-04 17:05:55,638 [myid:] - INFO  [main:Environment@109] - Client environment:java.version=1.8.0_181
2021-04-04 17:05:55,644 [myid:] - INFO  [main:Environment@109] - Client environment:java.vendor=Oracle Corporation
2021-04-04 17:05:55,645 [myid:] - INFO  [main:Environment@109] - Client environment:java.home=/opt/jdk/jdk1.8.0_181/jre
2021-04-04 17:05:55,646 [myid:] - INFO  [main:Environment@109] - Client environment:java.class.path=/opt/apache-zookeeper-3.5.8-bin/bin/../zookeeper-server/target/classes:/opt/apache-zookeeper-3.5.8-bin/bin/../build/classes:/opt/apache-zookeeper-3.5.8-bin/bin/../zookeeper-server/target/lib/*.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../build/lib/*.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/zookeeper-jute-3.5.8.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/zookeeper-3.5.8.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/slf4j-log4j12-1.7.25.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/slf4j-api-1.7.25.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-transport-native-unix-common-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-transport-native-epoll-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-transport-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-resolver-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-handler-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-common-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-codec-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/netty-buffer-4.1.48.Final.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/log4j-1.2.17.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/json-simple-1.1.1.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jline-2.11.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jetty-util-9.4.24.v20191120.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jetty-servlet-9.4.24.v20191120.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jetty-server-9.4.24.v20191120.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jetty-security-9.4.24.v20191120.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jetty-io-9.4.24.v20191120.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jetty-http-9.4.24.v20191120.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/javax.servlet-api-3.1.0.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jackson-databind-2.10.3.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jackson-core-2.10.3.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/jackson-annotations-2.10.3.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/commons-cli-1.2.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../lib/audience-annotations-0.5.0.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../zookeeper-*.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../zookeeper-server/src/main/resources/lib/*.jar:/opt/apache-zookeeper-3.5.8-bin/bin/../conf:.:/opt/jdk/jdk1.8.0_181/lib:/opt/jdk/jdk1.8.0_181/jre/lib
2021-04-04 17:05:55,647 [myid:] - INFO  [main:Environment@109] - Client environment:java.library.path=/usr/java/packages/lib/amd64:/usr/lib64:/lib64:/lib:/usr/lib
2021-04-04 17:05:55,648 [myid:] - INFO  [main:Environment@109] - Client environment:java.io.tmpdir=/tmp
2021-04-04 17:05:55,648 [myid:] - INFO  [main:Environment@109] - Client environment:java.compiler=<NA>
2021-04-04 17:05:55,649 [myid:] - INFO  [main:Environment@109] - Client environment:os.name=Linux
2021-04-04 17:05:55,650 [myid:] - INFO  [main:Environment@109] - Client environment:os.arch=amd64
2021-04-04 17:05:55,650 [myid:] - INFO  [main:Environment@109] - Client environment:os.version=4.13.0-36-generic
2021-04-04 17:05:55,651 [myid:] - INFO  [main:Environment@109] - Client environment:user.name=root
2021-04-04 17:05:55,652 [myid:] - INFO  [main:Environment@109] - Client environment:user.home=/root
2021-04-04 17:05:55,653 [myid:] - INFO  [main:Environment@109] - Client environment:user.dir=/opt/apache-zookeeper-3.5.8-bin/bin
2021-04-04 17:05:55,654 [myid:] - INFO  [main:Environment@109] - Client environment:os.memory.free=25MB
2021-04-04 17:05:55,661 [myid:] - INFO  [main:Environment@109] - Client environment:os.memory.max=247MB
2021-04-04 17:05:55,663 [myid:] - INFO  [main:Environment@109] - Client environment:os.memory.total=30MB
2021-04-04 17:05:55,677 [myid:] - INFO  [main:ZooKeeper@868] - Initiating client connection, connectString=localhost:2181 sessionTimeout=30000 watcher=org.apache.zookeeper.ZooKeeperMain$MyWatcher@15615099
2021-04-04 17:05:55,705 [myid:] - INFO  [main:X509Util@79] - Setting -D jdk.tls.rejectClientInitiatedRenegotiation=true to disable client-initiated TLS renegotiation
2021-04-04 17:05:55,732 [myid:] - INFO  [main:ClientCnxnSocket@237] - jute.maxbuffer value is 4194304 Bytes
2021-04-04 17:05:55,752 [myid:] - INFO  [main:ClientCnxn@1653] - zookeeper.request.timeout value is 0. feature enabled=
Welcome to ZooKeeper!
2021-04-04 17:05:55,782 [myid:localhost:2181] - INFO  [main-SendThread(localhost:2181):ClientCnxn$SendThread@1112] - Opening socket connection to server localhost/127.0.0.1:2181. Will not attempt to authenticate using SASL (unknown error)
JLine support is enabled
2021-04-04 17:05:56,152 [myid:localhost:2181] - INFO  [main-SendThread(localhost:2181):ClientCnxn$SendThread@959] - Socket connection established, initiating session, client: /127.0.0.1:47930, server: localhost/127.0.0.1:2181
2021-04-04 17:05:56,251 [myid:localhost:2181] - INFO  [main-SendThread(localhost:2181):ClientCnxn$SendThread@1394] - Session establishment complete on server localhost/127.0.0.1:2181, sessionid = 0x100003dd68a0000, negotiated timeout = 30000
[zk: localhost:2181(CONNECTING) 0]
WATCHER::

WatchedEvent state:SyncConnected type:None path:null

[zk: localhost:2181(CONNECTED) 0]

输入命令 help 查看zookeeper所支持的所有命令：

[zk: localhost:2181(CONNECTED) 80] help ZooKeeper -server host:port cmd args addauth scheme auth close config [-c] [-w] [-s] connect host:port create [-s] [-e] [-c] [-t ttl] path [data] [acl] delete [-v version] path deleteall path delquota [-n|-b] path get [-s] [-w] path getAcl [-s] path history listquota path ls [-s] [-w] [-R] path ls2 path [watch] printwatches on|off quit reconfig [-s] [-v version] [[-file path] | [-members serverID=host:port1:port2;port3[,...]*]] | [-add serverId=host:port1:port2;port3[,...]]* [-remove serverId[,...]*] redo cmdno removewatches path [-c|-d|-a] [-l] rmr path set [-s] [-v version] path data setAcl [-s] [-v version] [-R] path acl setquota -n|-b val path stat [-w] path sync path

1. 创建zookeeper 节点命令

create [-s] [-e] [-c] [-t ttl] path [data] [acl]

中括号为可选项，没有则默认创建持久化节点

-s: 顺序节点

-e: 临时节点

-c: 容器节点

-t: 可以给节点添加过期时间，默认禁用，需要通过系统参数启用

（-Dzookeeper.extendedTypesEnabled=true, znode.container.checkIntervalMs : (Java system property only) New in 3.5.1: The time interval in milliseconds for each check of candidate container and ttl nodes. Default is "60000".)

创建节点：

create /test-node some-data

如上，没有加任何可选参数，创建的就是持久化节点

查看节点：

get /test-node

修改节点数据：

set /test-node some-data-changed

查看节点状态信息：

stat /test-node

Stat

cZxid：创建znode的事务ID（Zxid的值）。
mZxid：最后修改znode的事务ID。
pZxid：最后添加或删除子节点的事务ID（子节点列表发生变化才会发生改变）。
ctime：znode创建时间。
mtime：znode最近修改时间。
dataVersion：znode的当前数据版本。
cversion：znode的子节点结果集版本（一个节点的子节点增加、删除都会影响这个版本）。
aclVersion：表示对此znode的acl版本。
ephemeralOwner：znode是临时znode时，表示znode所有者的 session ID。如果znode不是临时znode，则该字段设置为零。
dataLength：znode数据字段的长度。
numChildren：znode的子znode的数量。

查看节点状态信息同时查看数据

根据状态数据中的版本号有并发修改数据实现乐观锁的功能

比如：客户端首先获取版本信息， get -s /node-test

/test-node 当前的数据版本是 1 ，这时客户端用 set 命令修改数据的时候可以把版本号带上

如果在执行上面 set命令前，有人修改了数据，zookeeper 会递增版本号，这个时候，如果再用以前的版本号去修改，将会导致修改失败，报如下错误

创建子节点，这里要注意，zookeeper是以节点组织数据的，没有相对路径这么一说，所以，所有的节点一定是以 / 开头。

create /test-node/test-sub-node

查看子节点信息，比如根节点下面的所有子节点，加一个大写 R 可以查看递归子节点列表

ls /

查看 /test-node 下面所有的子节点

创建临时节点

create -e /ephemeral data

create 后跟一个 -e 创建临时节点，临时节点不能创建子节点

创建序号节点，加参数 -s

create /seq-parent data // 创建父目录，单纯为了分类，非必须 create -s /seq-parent/ data // 创建顺序节点。顺序节点将再seq-parent 目录下面，顺序递增

为了容纳子节点，先创建个父目录 /seq-parent

也可以再序号节点前面带一个前缀

创建临时顺序节点,其它增删查改和其他节点无异，不再贴图

create -s -e /ephemeral-node/前缀-

创建容器节点

create -c /container

容器节点主要用来容纳字节点，如果没有给其创建子节点，容器节点表现和持久化节点一样，如果给容器节点创建了子节点，后续又把子节点清空，容器节点也会被zookeeper删除。

2. 事件监听机制：

针对节点的监听

一定事件触发，对应的注册立刻被移除，所以事件监听是一次性的

get -w /path // 注册监听的同时获取数据 stat -w /path // 对节点进行监听，且获取元数据信息

针对目录的监听

如下图，目录的变化，会触发事件，且一旦触发，对应的监听也会被移除，后续对节点的创建没有触发监听事件

ls -w /path

针对递归子目录的监听

ls -R -w /path ： -R 区分大小写，一定用大写

如下对/test 节点进行递归监听，但是每个目录下的目录监听也是一次性的，如第一次在/test 目录下创建节点时，触发监听事件，第二次则没有，同样，因为时递归的目录监听，所以在/test/sub0下进行节点创建时，触发事件，但是再次创建/test/sub0/subsub1节点时，没有触发事件。

Zookeeper事件类型：

None: 连接建立事件

NodeCreated：节点创建

NodeDeleted：节点删除

NodeDataChanged：节点数据变化

NodeChildrenChanged：子节点列表变化

DataWatchRemoved：节点监听被移除

ChildWatchRemoved：子节点监听被移除

4. Zookeeper 的 ACL 权限控制( Access Control List )

Zookeeper 的ACL 权限控制,可以控制节点的读写操作,保证数据的安全性，Zookeeper ACL 权限设置分为 3 部分组成，分别是：权限模式（Scheme）、授权对象（ID）、权限信息（Permission）。最终组成一条例如“scheme:id:permission”格式的 ACL 请求信息。下面我们具体看一下这 3 部分代表什么意思：

Scheme（权限模式）：

用来设置 ZooKeeper 服务器进行权限验证的方式。ZooKeeper 的权限验证方式大体分为两种类型：

一种是范围验证。所谓的范围验证就是说 ZooKeeper 可以针对一个 IP 或者一段 IP 地址授予某种权限。比如我们可以让一个 IP 地址为“ip：192.168.0.110”的机器对服务器上的某个数据节点具有写入的权限。或者也可以通过“ip:192.168.0.1/24”给一段 IP 地址的机器赋权。

另一种权限模式就是口令验证，也可以理解为用户名密码的方式。在 ZooKeeper 中这种验证方式是 Digest 认证，而 Digest 这种认证方式首先在客户端传送“username:password”这种形式的权限表示符后，ZooKeeper 服务端会对密码部分使用 SHA-1 和 BASE64 算法进行加密，以保证安全性。

还有一种Super权限模式, Super可以认为是一种特殊的 Digest 认证。具有 Super 权限的客户端可以对 ZooKeeper 上的任意数据节点进行任意操作。

授权对象（ID）

授权对象就是说我们要把权限赋予谁，而对应于 4 种不同的权限模式来说，如果我们选择采用 IP 方式，使用的授权对象可以是一个 IP 地址或 IP 地址段；而如果使用 Digest 或 Super 方式，则对应于一个用户名。如果是 World 模式，是授权系统中所有的用户。

权限信息（Permission）

权限就是指我们可以在数据节点上执行的操作种类，如下所示：在 ZooKeeper 中已经定义好的权限有 5 种：

数据节点（c: create）创建权限，授予权限的对象可以在数据节点下创建子节点；

数据节点（w: wirte）更新权限，授予权限的对象可以更新该数据节点；

数据节点（r: read）读取权限，授予权限的对象可以读取该节点的内容以及子节点的列表信息；

数据节点（d: delete）删除权限，授予权限的对象可以删除该数据节点的子节点；

数据节点（a: admin）管理者权限，授予权限的对象可以对该数据节点体进行 ACL 权限设置。

命令：

getAcl：获取某个节点的acl权限信息

setAcl：设置某个节点的acl权限信息

addauth: 输入认证授权信息，相当于注册用户信息，注册时输入明文密码，zk将以密文的形式存储

可以通过系统参数zookeeper.skipACL=yes进行配置，默认是no,可以配置为true, 则配置过的ACL将不再进行权限检测

生成授权ID的两种方式:

a.代码生成ID:

@Test public void generateSuperDigest() throws NoSuchAlgorithmException { String sId = DigestAuthenticationProvider.generateDigest("gj:test"); System.out.println(sId);// gj:X/NSthOB0fD/OT6iilJ55WJVado= }

b.在xshell 中生成

echo -n <user>:<password> | openssl dgst -binary -sha1 | openssl base64

设置ACL有两种方式

节点创建的同时设置ACL

create [-s] [-e] [-c] path [data] [acl]

create /zk-node datatest digest:gj:X/NSthOB0fD/OT6iilJ55WJVado=:cdrwa

或者用setAcl 设置

setAcl /zk-node digest:gj:X/NSthOB0fD/OT6iilJ55WJVado=:cdrwa

添加授权信息后，不能直接访问，直接访问将报如下异常

get /zk-node 异常信息: org.apache.zookeeper.KeeperException$NoAuthException: KeeperErrorCode = NoAuth for /zk-node

访问前需要添加授权信息

addauth digest gj:test get /zk-node datatest

另一种授权模式： auth 明文授权

使用之前需要先

addauth digest username:password 注册用户信息，后续可以直接用明文授权

如：

addauth digest u100:p100 create /node-1 node1data auth:u100:p100:cdwra 这是u100用户授权信息会被zk保存，可以认为当前的授权用户为u100 get /node-1 node1data

IP授权模式：

setAcl /node-ip ip:192.168.109.128:cdwra create /node-ip data ip:192.168.109.128:cdwra

多个指定IP可以通过逗号分隔，如 setAcl /node-ip ip:IP1:rw,ip:IP2:a

Super 超级管理员模式

这是一种特殊的Digest模式，在Super模式下超级管理员用户可以对Zookeeper上的节点进行任何的操作。

需要在启动了上通过JVM 系统参数开启：

DigestAuthenticationProvider中定义 -Dzookeeper.DigestAuthenticationProvider.superDigest=super:<base64encoded(SHA1(password))

5. ZooKeeper 内存数据和持久化

Zookeeper数据的组织形式为一个类似文件系统的数据结构，而这些数据都是存储在内存中的，所以我们可以认为，Zookeeper是一个基于内存的小型数据库

内存中的数据：

public class DataTree { private final ConcurrentHashMap<String, DataNode> nodes = new ConcurrentHashMap<String, DataNode>(); private final WatchManager dataWatches = new WatchManager(); private final WatchManager childWatches = new WatchManager();

DataNode 是Zookeeper存储节点数据的最小单位

public class DataNode implements Record { byte data[]; Long acl; public StatPersisted stat; private Set<String> children = null;

事务日志

针对每一次客户端的事务操作，Zookeeper都会将他们记录到事务日志中，当然，Zookeeper也会将数据变更应用到内存数据库中。我们可以在zookeeper的主配置文件zoo.cfg 中配置内存中的数据持久化目录，也就是事务日志的存储路径 dataLogDir. 如果没有配置dataLogDir（非必填）, 事务日志将存储到dataDir （必填项）目录，

zookeeper提供了格式化工具可以进行数据查看事务日志数据

org.apache.zookeeper.server.LogFormatter

java -classpath .:slf4j-api-1.7.25.jar:zookeeper-3.5.8.jar:zookeeper-jute-3.5.8.jar org.apache.zookeeper.server.LogFormatter /usr/local/zookeeper/apache-zookeeper-3.5.8-bin/data/version-2/log.1

如下是我本地的日志文件格式化效果

从左到右分别记录了操作时间，客户端会话ID，CXID,ZXID,操作类型，节点路径，节点数据（用#+ascii 码表示），节点版本。

Zookeeper进行事务日志文件操作的时候会频繁进行磁盘IO操作，事务日志的不断追加写操作会触发底层磁盘IO为文件开辟新的磁盘块，即磁盘Seek。因此，为了提升磁盘IO的效率，Zookeeper在创建事务日志文件的时候就进行文件空间的预分配- 即在创建文件的时候，就向操作系统申请一块大一点的磁盘块。这个预分配的磁盘大小可以通过系统参数 zookeeper.preAllocSize 进行配置。

事务日志文件名为： log.，应为日志文件时顺序写入的，所以这个最大事务ID也将是整个事务日志文件中，最小的事务ID，日志满了即进行下一次事务日志文件的创建

数据快照

数据快照用于记录Zookeeper服务器上某一时刻的全量数据，并将其写入到指定的磁盘文件中。

可以通过配置snapCount配置每间隔事务请求个数，生成快照，数据存储在dataDir 指定的目录中，

可以通过如下方式进行查看快照数据（为了避免集群中所有机器在同一时间进行快照，实际的快照生成时机为事务数达到 [snapCount/2 + 随机数(随机数范围为1 ~ snapCount/2 )] 个数时开始快照）

java -classpath .:slf4j-api-1.7.25.jar:zookeeper-3.5.8.jar:zookeeper-jute-3.5.8.jar org.apache.zookeeper.server.SnapshotFormatter /usr/local/zookeeper/apache-zookeeper-3.5.8-bin/data-dir/version-2/snapshot.0