查看“Zookeeper：命令行（CLI）”的源代码

[[category:Zookeeper]]

__TOC__

== 命令行界面（CLI）==
ZooKeeper 命令行界面（CLI）用于与ZooKeeper集合进行交互以进行开发。它有助于调试和解决不同的选项。
* 要执行ZooKeeper CLI操作，首先打开ZooKeeper服务器（“bin/zkServer.sh start”），然后打开ZooKeeper客户端（“bin/zkCli.sh”）。


CLI 常用命令：
# '''create'''：创建节点并赋值。
#: <syntaxhighlight lang="java" highlight="">
create [-s] [-e] path data acl
</syntaxhighlight>
#* [-s] [-e]：-s 代表顺序节点，-e 代表临时节点，二者可以同时使用的，并且临时节点不能再创建子节点。
#* path：指定要创建节点的路径，比如 /runoob。
#* data：要在此节点存储的数据。
#* acl：访问权限相关，默认是 '''world'''：开放式权限（所有都可以访问）。
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：create.png|400px]]
# '''get'''：获取节点数据和状态信息。
#: <syntaxhighlight lang="java" highlight="">
get path [watch]
</syntaxhighlight>
#* path：代表路径。
#* [watch]：对节点进行事件'''监听'''。
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：get.png|400px]]
# '''set'''：修改节点存储的数据。
#: <syntaxhighlight lang="java" highlight="">
set path data [version]
</syntaxhighlight>
#* path：节点路径。
#* data：需要存储的数据。
#* [version]：可选项，版本号（可用作乐观锁）。【只有版本号正确操作才能成功】
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：set.png|400px]]
# '''stat'''：查看节点状态信息。
#: <syntaxhighlight lang="java" highlight="">
stat path [watch]
</syntaxhighlight>
#* path：代表路径。
#* [watch]：对节点进行事件监听。
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：stat.png|400px]]
# '''delete'''：删除某节点（包括其子节点）。
#: <syntaxhighlight lang="java" highlight="">
delete path [version]
</syntaxhighlight>
#* path：节点路径。
#* [version]：可选项，版本号（同 set 命令）。
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：delete.png|400px]]
# '''rmr'''：删除某节点（只能删除不含子节点的节点）。
#: <syntaxhighlight lang="java" highlight="">
rmr path [version]
</syntaxhighlight>
#* path：节点路径。
#* [version]：可选项，版本号（同 set 命令）。
# '''ls'''：查看某个路径下目录列表。
#: <syntaxhighlight lang="java" highlight="">
ls path
</syntaxhighlight>
#* path：代表路径。
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：ls.png|400px]]
# '''ls2'''：查看某个路径下目录列表。（比 ls 命令列出更多的详细信息）
#: <syntaxhighlight lang="java" highlight="">
ls2 path
</syntaxhighlight>
#* path：代表路径。
#: 示例：
#:: [[File:Zookeeper：CLI 常用命令示例：ls2.png|400px]]

== 四字命令【？？？】 ==
zookeeper 支持某些特定的四字命令与其交互，用户获取 zookeeper 服务的当前状态及相关信息，用户在客户端可以通过 '''telenet''' 或者 nc（'''netcat'''） 向 zookeeper 提交相应的命令。
* 参考官方链接：[https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_4lw https://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_4lw]。


安装 nc 命令：
<syntaxhighlight lang="bash" highlight="">
$ yum install nc                # centos
或
$ sudo apt install netcat       # ubuntu
</syntaxhighlight>


四字命令格式：
<syntaxhighlight lang="bash" highlight="">
echo [command] | nc [ip] [port]
</syntaxhighlight>


ZooKeeper 常用四字命令主要如下：
{| class="wikitable"
! 命令 !! 描述 
|-
| conf || 3.3.0版本引入。打印出服务相关配置的详细信息。
|-
| cons || 3.3.0版本引入。列出所有连接到这台服务器的客户端全部连接/会话详细信息。包括"接受/发送"的包数量、会话id、操作延迟、最后的操作执行等等信息。
|-
| crst || 3.3.0版本引入。重置所有连接的连接和会话统计信息。
|-
| dump || 列出那些比较重要的会话和临时节点。这个命令只能在leader节点上有用。
|-
| envi || 打印出服务环境的详细信息。
|-
| reqs || 列出未经处理的请求
|-
| ruok || 测试服务是否处于正确状态。如果确实如此，那么服务返回"imok"，否则不做任何相应。
|-
| stat || 输出关于性能和连接的客户端的列表。
|-
| srst || 重置服务器的统计。
|-
| srvr || 3.3.0版本引入。列出连接服务器的详细信息
|-
| wchs || 3.3.0版本引入。列出服务器watch的详细信息。
|-
| wchc || 3.3.0版本引入。通过session列出服务器watch的详细信息，它的输出是一个与watch相关的会话的列表。
|-
| wchp || 3.3.0版本引入。通过路径列出服务器watch的详细信息。它输出一个与session相关的路径。
|-
| mntr || 3.4.0版本引入。输出可用于检测集群健康状态的变量列表
|}


使用：
# '''stat'''命令：用于查看 zk 的状态信息，实例如下：
#: <syntaxhighlight lang="bash" highlight="">
$ echo stat | nc 192.168.3.38 2181
</syntaxhighlight>
#: [[File:Zookeeper：四字命令示例：stat 命令.png|600px]]
# '''ruok'''命令：用于查看当前 zkserver 是否启动，若返回 imok 表示正常。实例如下：
#: <syntaxhighlight lang="bash" highlight="">
$ echo ruok | nc 192.168.3.38 2181
</syntaxhighlight>
#: [[File:Zookeeper：四字命令示例：ruok 命令.png|600px]]
# '''dump'''命令：用于列出未经处理的会话和临时节点。实例如下：
#: <syntaxhighlight lang="bash" highlight="">
$ echo dump | nc 192.168.3.38 2181
</syntaxhighlight>
#: [[File:Zookeeper：四字命令示例：dump 命令.png|600px]]
# '''conf'''命令：用于查看服务器配置。实例如下：
#: <syntaxhighlight lang="bash" highlight="">
$ echo conf | nc 192.168.3.38 2181
</syntaxhighlight>
#: [[File:Zookeeper：四字命令示例：conf 命令.png|600px]]
# '''cons'''命令：用于展示连接到服务器的客户端信息。实例如下：
#: <syntaxhighlight lang="bash" highlight="">
$ echo cons | nc 192.168.3.38 2181
</syntaxhighlight>
#: [[File:Zookeeper：四字命令示例：cons 命令.png|600px]]
# '''envi'''命令：用于查看环境变量。实例如下：
#: <syntaxhighlight lang="bash" highlight="">
$ echo envi | nc 192.168.3.38 2181
</syntaxhighlight>
#: [[File:Zookeeper：四字命令示例：envi 命令.png|600px]]

== Java客户端 ==
Java 客户端包括两种方式：
# 原生 API；
# '''Curator'''；

=== Java 客户端搭建 ===
使用的 IDE 为 IntelliJ IDEA，创建一个 maven 工程，命名为 zookeeper-demo，并且引入如下依赖，可以自行在maven中央仓库选择合适的版本：
<syntaxhighlight lang="xml" highlight="">
<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.11</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.apache.zookeeper</groupId>
  <artifactId>zookeeper</artifactId>
  <version>3.4.8</version>
</dependency>
<dependency>
  <groupId>org.apache.curator</groupId>
  <artifactId>curator-framework</artifactId>
  <version>4.0.0</version>
</dependency>
<dependency>
  <groupId>org.apache.curator</groupId>
  <artifactId>curator-recipes</artifactId>
  <version>4.0.0</version>
</dependency>
</syntaxhighlight>
maven 工程目录结构：
: [[File:Zookeeper：Java客户端：maven工程目录结构.png|400px]]

=== 原生 API ===




=== Curator ===








<syntaxhighlight lang="java" highlight="">

</syntaxhighlight>