赞
踩
点击下方名片,设为星标!
回复“1024”获取2TB学习资源!
前面介绍了 Zookeeper 安装部署、常用管理命令、节点、选举机制等相关的知识点,今天我将详细的为大家介绍 zookeeper 监听机制相关知识,希望大家能够从中收获多多!如有帮助,请点在看、转发支持一波!!!
首先要有一个main()线程
在main()线程中创建Zookeeper客户端,这时就会创建两个线程connect线程负责网络连接通信,listen线程负责监听
通过connect线程将注册的监听事件发送给Zookeeper服务器
在Zookeeper的注册监听列表中将注册的监听事件添加到列表中,表示这个服务器中的/path,即根目录这个路径被客户端监听了
一旦被监听的服务器根目录下,数据或路径发生改变,Zookeeper服务器就会将这个消息发送给Listener线程
Listener线程内部调用process方法,采取相应的措施
watch 监听机制是 zookeeper 的关键技术之一!
当今时代,发布订阅场景到处可见,像微信中的公众号消息订阅,或者网购场景下库存消息的订阅通知等等,这些都是属于发布订阅的场景。
watch监听机制是zk的一个关键技术,zk通过它来实现发布订阅的功能,通过watch我们可以联想到设计模式中的观察者模式,二者确实有点类似,你可以将其看成是分布式场景下的观察者模式。
一次性:watcher是一次性的,一旦被触发就会移除,再次使用时需要重新注册
客户端顺序回调:watcher回调是顺序串行化执行的,只有回调后客户端才能看到最新的数据状态。一个watcher回调逻辑不应该太多,以免影响别的watcher执行
轻量级:watchEvent是最小的通信单元,结构上只包含通知状态、事件类型和节点路径,并不会告诉数据节点变化前后的具体内容。
时效性: watcher只有在当前session彻底失效时才会无效,若在session有效期内快速重连成功,则watcher依然存在,仍可接收到通知。
客户端收到集合数据更改的通知,client可以在读取的指定znode时设置watches,(客户端注册表)watches会向注册的client发送关于znode更改的通知(比如监听节点数据变更、节点删除、子节点状态变更等事件)。
例如:这里新增一个子节点就可以观察watcher监听事件的变化
- [zk: localhost:2181(CONNECTED) 1] ls /hello watch
- []
- [zk: localhost:2181(CONNECTED) 2] create /hello/test abc
-
- WATCHER::
-
- WatchedEvent state:SyncConnected type:NodeChildrenChanged path:/hello
- Created /hello/test
通过这个事件机制,可以基于zl实现分布式锁、集群管理等功能。
当节点变更时,zk产生一个watcher事件并发送到client,但是client只会收到一次通知,也就是后续节点再发生变化就不会再次收到通知。(watcher是一次性的),可以通过循环监听去实现永久监听。比如说我再建立一个子节点,此时就没有触发监听事件。
总体分三个过程:客户端注册watcher、服务器处理watcher、客户端回调watcher客户端。
发送一个带有watch事件的请求——>DataWatchRegistration保存watch事件——>将请求封装成Packet并放入一个队列等待发送——>调用SendThread中的readResponse——>ZKWatchManager将该watch事件进行存储
- //Zookeeper.java
- public byte[] getData(String path, Watcher watcher, Stat stat) throws KeeperException, InterruptedException {
- PathUtils.validatePath(path);
- ZooKeeper.WatchRegistration wcb = null;
- if (watcher != null) {
- //注册watch
- wcb = new ZooKeeper.DataWatchRegistration(watcher, path);
- }
-
- String serverPath = this.prependChroot(path);
- RequestHeader h = new RequestHeader();
- h.setType(4);
- GetDataRequest request = new GetDataRequest();
- request.setPath(serverPath);
- request.setWatch(watcher != null);
- GetDataResponse response = new GetDataResponse();
- ReplyHeader r = this.cnxn.submitRequest(h, request, response, wcb);
- if (r.getErr() != 0) {
- throw KeeperException.create(Code.get(r.getErr()), path);
- } else {
- if (stat != null) {
- DataTree.copyStat(response.getStat(), stat);
- }
-
- return response.getData();
- }
- }
- public ReplyHeader submitRequest(RequestHeader h, Record request, Record response, WatchRegistration watchRegistration, WatchDeregistration watchDeregistration) throws InterruptedException {
- ReplyHeader r = new ReplyHeader();
- ClientCnxn.Packet packet = this.queuePacket(h, r, request, response, (AsyncCallback)null, (String)null, (String)null, (Object)null, watchRegistration, watchDeregistration);
- synchronized(packet) {
- while(!packet.finished) {
- packet.wait();
- }
-
- return r;
- }
- }
- public ClientCnxn.Packet queuePacket(RequestHeader h, ReplyHeader r, Record request, Record response, AsyncCallback cb, String clientPath, String serverPath, Object ctx, WatchRegistration watchRegistration, WatchDeregistration watchDeregistration) {
- ClientCnxn.Packet packet = null;
- packet = new ClientCnxn.Packet(h, r, request, response, watchRegistration);
- packet.cb = cb;
- packet.ctx = ctx;
- packet.clientPath = clientPath;
- packet.serverPath = serverPath;
- packet.watchDeregistration = watchDeregistration;
- synchronized(this.state) {
- if (this.state.isAlive() && !this.closing) {
- if (h.getType() == -11) {
- this.closing = true;
- }
-
- this.outgoingQueue.add(packet);
- } else {
- this.conLossPacket(packet);
- }
- }
-
- this.sendThread.getClientCnxnSocket().packetAdded();
- return packet;
- }
- class SendThread extends ZooKeeperThread {
- .....
- void readResponse(ByteBuffer incomingBuffer) throws IOException {
- ByteBufferInputStream bbis = new ByteBufferInputStream(incomingBuffer);
- BinaryInputArchive bbia = BinaryInputArchive.getArchive(bbis);
- ReplyHeader replyHdr = new ReplyHeader();
- replyHdr.deserialize(bbia, "header");
- if (replyHdr.getXid() == -2) {
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Got ping response for sessionid: 0x" + Long.toHexString(ClientCnxn.this.sessionId) + " after " + (System.nanoTime() - this.lastPingSentNs) / 1000000L + "ms");
- }
- } else if (replyHdr.getXid() == -4) {
- if (replyHdr.getErr() == Code.AUTHFAILED.intValue()) {
- ClientCnxn.this.state = States.AUTH_FAILED;
- ClientCnxn.this.eventThread.queueEvent(new WatchedEvent(EventType.None, KeeperState.AuthFailed, (String)null));
- }
-
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Got auth sessionid:0x" + Long.toHexString(ClientCnxn.this.sessionId));
- }
-
- } else if (replyHdr.getXid() == -1) {
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Got notification sessionid:0x" + Long.toHexString(ClientCnxn.this.sessionId));
- }
-
- WatcherEvent event = new WatcherEvent();
- event.deserialize(bbia, "response");
- if (ClientCnxn.this.chrootPath != null) {
- String serverPath = event.getPath();
- if (serverPath.compareTo(ClientCnxn.this.chrootPath) == 0) {
- event.setPath("/");
- } else if (serverPath.length() > ClientCnxn.this.chrootPath.length()) {
- event.setPath(serverPath.substring(ClientCnxn.this.chrootPath.length()));
- } else {
- ClientCnxn.LOG.warn("Got server path " + event.getPath() + " which is too short for chroot path " + ClientCnxn.this.chrootPath);
- }
- }
-
- WatchedEvent we = new WatchedEvent(event);
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Got " + we + " for sessionid 0x" + Long.toHexString(ClientCnxn.this.sessionId));
- }
-
- ClientCnxn.this.eventThread.queueEvent(we);
- } else if (this.tunnelAuthInProgress()) {
- GetSASLRequest request = new GetSASLRequest();
- request.deserialize(bbia, "token");
- ClientCnxn.this.zooKeeperSaslClient.respondToServer(request.getToken(), ClientCnxn.this);
- } else {
- ClientCnxn.Packet packet;
- synchronized(ClientCnxn.this.pendingQueue) {
- if (ClientCnxn.this.pendingQueue.size() == 0) {
- throw new IOException("Nothing in the queue, but got " + replyHdr.getXid());
- }
-
- packet = (ClientCnxn.Packet)ClientCnxn.this.pendingQueue.remove();
- }
-
- try {
- if (packet.requestHeader.getXid() != replyHdr.getXid()) {
- packet.replyHeader.setErr(Code.CONNECTIONLOSS.intValue());
- throw new IOException("Xid out of order. Got Xid " + replyHdr.getXid() + " with err " + replyHdr.getErr() + " expected Xid " + packet.requestHeader.getXid() + " for a packet with details: " + packet);
- }
-
- packet.replyHeader.setXid(replyHdr.getXid());
- packet.replyHeader.setErr(replyHdr.getErr());
- packet.replyHeader.setZxid(replyHdr.getZxid());
- if (replyHdr.getZxid() > 0L) {
- ClientCnxn.this.lastZxid = replyHdr.getZxid();
- }
-
- if (packet.response != null && replyHdr.getErr() == 0) {
- packet.response.deserialize(bbia, "response");
- }
-
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Reading reply sessionid:0x" + Long.toHexString(ClientCnxn.this.sessionId) + ", packet:: " + packet);
- }
- } finally {
- ClientCnxn.this.finishPacket(packet);
- }
-
- }
- }
- private void finishPacket(ClientCnxn.Packet p) {
- int err = p.replyHeader.getErr();
- if (p.watchRegistration != null) {
- p.watchRegistration.register(err);
- }
-
- if (p.watchDeregistration != null) {
- Map materializedWatchers = null;
-
- try {
- materializedWatchers = p.watchDeregistration.unregister(err);
- Iterator i$ = materializedWatchers.entrySet().iterator();
-
- while(i$.hasNext()) {
- Entry<EventType, Set<Watcher>> entry = (Entry)i$.next();
- Set<Watcher> watchers = (Set)entry.getValue();
- if (watchers.size() > 0) {
- this.queueEvent(p.watchDeregistration.getClientPath(), err, watchers, (EventType)entry.getKey());
- p.replyHeader.setErr(Code.OK.intValue());
- }
- }
- } catch (NoWatcherException var9) {
- LOG.error("Failed to find watcher!", var9);
- p.replyHeader.setErr(var9.code().intValue());
- } catch (KeeperException var10) {
- LOG.error("Exception when removing watcher", var10);
- p.replyHeader.setErr(var10.code().intValue());
- }
- }
-
- if (p.cb == null) {
- synchronized(p) {
- p.finished = true;
- p.notifyAll();
- }
- } else {
- p.finished = true;
- this.eventThread.queuePacket(p);
- }
-
- }
在SendThread.readResponse()中的xid=-1来进行处理——>调用 eventThread.queueEvent()进行处理
- class SendThread extends ZooKeeperThread {
- .....
- void readResponse(ByteBuffer incomingBuffer) throws IOException {
- ByteBufferInputStream bbis = new ByteBufferInputStream(incomingBuffer);
- BinaryInputArchive bbia = BinaryInputArchive.getArchive(bbis);
- ReplyHeader replyHdr = new ReplyHeader();
- replyHdr.deserialize(bbia, "header");
- if (replyHdr.getXid() == -2) {
- ....
- } else if (replyHdr.getXid() == -1) {
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Got notification sessionid:0x" + Long.toHexString(ClientCnxn.this.sessionId));
- }
-
- WatcherEvent event = new WatcherEvent();
- event.deserialize(bbia, "response");
- if (ClientCnxn.this.chrootPath != null) {
- String serverPath = event.getPath();
- if (serverPath.compareTo(ClientCnxn.this.chrootPath) == 0) {
- event.setPath("/");
- } else if (serverPath.length() > ClientCnxn.this.chrootPath.length()) {
- event.setPath(serverPath.substring(ClientCnxn.this.chrootPath.length()));
- } else {
- ClientCnxn.LOG.warn("Got server path " + event.getPath() + " which is too short for chroot path " + ClientCnxn.this.chrootPath);
- }
- }
-
- WatchedEvent we = new WatchedEvent(event);
- if (ClientCnxn.LOG.isDebugEnabled()) {
- ClientCnxn.LOG.debug("Got " + we + " for sessionid 0x" + Long.toHexString(ClientCnxn.this.sessionId));
- }
-
- ClientCnxn.this.eventThread.queueEvent(we);
- }
- ....
- }
判断请求是否带有watch注册事件——>通过FinalRequestProcessor中的processRequest解析请求——>若有watch,则调用zks.getZKDatabase().getData将事件注册到WatchManager
- //FinalRequestProcessor.java
- public void processRequest(Request request) {
- ....
- ProcessTxnResult rc = null;
- synchronized(this.zks.outstandingChanges) {
- rc = this.zks.processTxn(request);
- if (request.getHdr() != null) {
- TxnHeader hdr = request.getHdr();
- Record txn = request.getTxn();
- long zxid = hdr.getZxid();
-
- while(!this.zks.outstandingChanges.isEmpty() && ((ChangeRecord)this.zks.outstandingChanges.get(0)).zxid <= zxid) {
- ChangeRecord cr = (ChangeRecord)this.zks.outstandingChanges.remove(0);
- if (cr.zxid < zxid) {
- LOG.warn("Zxid outstanding " + cr.zxid + " is less than current " + zxid);
- }
-
- if (this.zks.outstandingChangesForPath.get(cr.path) == cr) {
- this.zks.outstandingChangesForPath.remove(cr.path);
- }
- }
- }
-
- if (request.isQuorum()) {
- this.zks.getZKDatabase().addCommittedProposal(request);
- }
- }
-
- if (request.type != -11 || !this.connClosedByClient(request) || !this.closeSession(this.zks.serverCnxnFactory, request.sessionId) && !this.closeSession(this.zks.secureServerCnxnFactory, request.sessionId)) {
- if (request.cnxn != null) {
- ServerCnxn cnxn = request.cnxn;
- String lastOp = "NA";
- this.zks.decInProcess();
- Code err = Code.OK;
- Object rsp = null;
-
- try {
- if (request.getHdr() != null && request.getHdr().getType() == -1) {
- if (request.getException() != null) {
- throw request.getException();
- }
-
- throw KeeperException.create(Code.get(((ErrorTxn)request.getTxn()).getErr()));
- }
-
- KeeperException ke = request.getException();
- if (ke != null && request.type != 14) {
- throw ke;
- }
-
- if (LOG.isDebugEnabled()) {
- LOG.debug("{}", request);
- }
-
- boolean removed;
- String msg;
- WatcherType type;
- Stat stat;
- DataNode n;
- List children;
- Stat stat;
- label170:
- switch(request.type) {
- ...
- case 4:
- lastOp = "GETD";
- GetDataRequest getDataRequest = new GetDataRequest();
- ByteBufferInputStream.byteBuffer2Record(request.request, getDataRequest);
- n = this.zks.getZKDatabase().getNode(getDataRequest.getPath());
- if (n == null) {
- throw new NoNodeException();
- }
-
- PrepRequestProcessor.checkACL(this.zks, this.zks.getZKDatabase().aclForNode(n), 1, request.authInfo);
- stat = new Stat();
- byte[] b = this.zks.getZKDatabase().getData(getDataRequest.getPath(), stat, getDataRequest.getWatch() ? cnxn : null);
- rsp = new GetDataResponse(b, stat);
- break;
- ....
- } catch (SessionMovedException var15) {
- ....
- }
-
- long lastZxid = this.zks.getZKDatabase().getDataTreeLastProcessedZxid();
- ReplyHeader hdr = new ReplyHeader(request.cxid, lastZxid, err.intValue());
- this.zks.serverStats().updateLatency(request.createTime);
- cnxn.updateStatsForResponse((long)request.cxid, lastZxid, lastOp, request.createTime, Time.currentElapsedTime());
-
- try {
- cnxn.sendResponse(hdr, (Record)rsp, "response");
- if (request.type == -11) {
- cnxn.sendCloseSession();
- }
- } catch (IOException var14) {
- LOG.error("FIXMSG", var14);
- }
-
- }
- }
- }
setData()对节点数据变更——>调用 WatchManager.triggerWatch 触发事件——>触发之后删除(客户端watch机制是一次性的)
- //DataTree.java
- public Stat setData(String path, byte[] data, int version, long zxid, long time) throws NoNodeException {
- Stat s = new Stat();
- DataNode n = (DataNode)this.nodes.get(path);
- if (n == null) {
- throw new NoNodeException();
- } else {
- byte[] lastdata = null;
- byte[] lastdata;
- synchronized(n) {
- lastdata = n.data;
- n.data = data;
- n.stat.setMtime(time);
- n.stat.setMzxid(zxid);
- n.stat.setVersion(version);
- n.copyStat(s);
- }
-
- String lastPrefix = this.getMaxPrefixWithQuota(path);
- if (lastPrefix != null) {
- this.updateBytes(lastPrefix, (long)((data == null ? 0 : data.length) - (lastdata == null ? 0 : lastdata.length)));
- }
-
- this.dataWatches.triggerWatch(path, EventType.NodeDataChanged);
- return s;
- }
- }
- //WatchManager.java
- Set<Watcher> triggerWatch(String path, EventType type, Set<Watcher> supress) {
- WatchedEvent e = new WatchedEvent(type, KeeperState.SyncConnected, path);
- HashSet watchers;
- synchronized(this) {
- watchers = (HashSet)this.watchTable.remove(path);
- if (watchers == null || watchers.isEmpty()) {
- if (LOG.isTraceEnabled()) {
- ZooTrace.logTraceMessage(LOG, 64L, "No watchers for " + path);
- }
-
- return null;
- }
-
- Iterator i$ = watchers.iterator();
-
- while(i$.hasNext()) {
- Watcher w = (Watcher)i$.next();
- HashSet<String> paths = (HashSet)this.watch2Paths.get(w);
- if (paths != null) {
- paths.remove(path);
- }
- }
- }
-
- Iterator i$ = watchers.iterator();
-
- while(true) {
- Watcher w;
- do {
- if (!i$.hasNext()) {
- return watchers;
- }
-
- w = (Watcher)i$.next();
- } while(supress != null && supress.contains(w));
-
- w.process(e);
- }
- }
- //DataTree.java
- public void deleteNode(String path, long zxid) throws NoNodeException {
- int lastSlash = path.lastIndexOf(47);
- String parentName = path.substring(0, lastSlash);
- String childName = path.substring(lastSlash + 1);
- DataNode node = (DataNode)this.nodes.get(path);
- if (node == null) {
- throw new NoNodeException();
- } else {
- this.nodes.remove(path);
- synchronized(node) {
- this.aclCache.removeUsage(node.acl);
- }
-
- DataNode parent = (DataNode)this.nodes.get(parentName);
- if (parent == null) {
- throw new NoNodeException();
- } else {
- synchronized(parent) {
- parent.removeChild(childName);
- parent.stat.setPzxid(zxid);
- long eowner = node.stat.getEphemeralOwner();
- EphemeralType ephemeralType = EphemeralType.get(eowner);
- if (ephemeralType == EphemeralType.CONTAINER) {
- this.containers.remove(path);
- } else if (ephemeralType == EphemeralType.TTL) {
- this.ttls.remove(path);
- } else if (eowner != 0L) {
- HashSet<String> nodes = (HashSet)this.ephemerals.get(eowner);
- if (nodes != null) {
- synchronized(nodes) {
- nodes.remove(path);
- }
- }
- }
- }
-
- if (parentName.startsWith("/zookeeper") && "zookeeper_limits".equals(childName)) {
- this.pTrie.deletePath(parentName.substring("/zookeeper/quota".length()));
- }
-
- String lastPrefix = this.getMaxPrefixWithQuota(path);
- if (lastPrefix != null) {
- this.updateCount(lastPrefix, -1);
- int bytes = false;
- int bytes;
- synchronized(node) {
- bytes = node.data == null ? 0 : -node.data.length;
- }
-
- this.updateBytes(lastPrefix, (long)bytes);
- }
-
- if (LOG.isTraceEnabled()) {
- ZooTrace.logTraceMessage(LOG, 64L, "dataWatches.triggerWatch " + path);
- ZooTrace.logTraceMessage(LOG, 64L, "childWatches.triggerWatch " + parentName);
- }
-
- Set<Watcher> processed = this.dataWatches.triggerWatch(path, EventType.NodeDeleted);
- this.childWatches.triggerWatch(path, EventType.NodeDeleted, processed);
- this.childWatches.triggerWatch("".equals(parentName) ? "/" : parentName, EventType.NodeChildrenChanged);
- }
- }
- }
客户端和服务端各自处理watch事件,并将所需信息分别在两端,这样一来,能够减少彼此之间的通信内容和频率,大大提升了服务的处理性能。
既然Watcher监听器是一次性的,在开发过程中需要反复注册Watcher,比较繁琐。Curator引入了Cache来监听ZooKeeper服务端的事件。Cache事件监听可以理解为一个本地缓存视图与远程Zookeeper视图的对比过程,简单来说,Cache在客户端缓存了znode的各种状态,当感知到zk集群的znode状态变化,会触发event事件,注册的监听器会处理这些事件。Cache对ZooKeeper事件监听进行了封装,能够自动处理反复注册监听,主要有以下三类:NodeCache使用的第一步,就是构造一个NodeCache缓存实例,有两个构造方法NodeCache(CuratorFramework client, String path) 和NodeCache(CuratorFramework client, String path, boolean dataIsCompressed) 第一个参数就是传入创建的Curator的框架客户端,第二个参数就是监听节点的路径,第三个重载参数dataIsCompressed 表示是否对数据进行压缩。
NodeCache使用的第二步,就是构造一个NodeCacheListener监听器实例,NodeCacheListener监听器接口,只定义了一个简单的方法 nodeChanged,当节点变化时,这个方法就会被回调。
再创建完NodeCacheListener的实例之后,需要将这个实例注册到NodeCache缓存实例,使用缓存实例的addListener方法,然后使用缓存实例nodeCache的start方法,启动节点的事件监听。PathChildrenCache 子节点监听,只能监听子节点,监听不到当前节点,不能递归监听,子节点下的子节点不能递归监控。Tree Cache节点树缓存可以看做是上两种的合体,Tree Cache观察的是当前ZNode节点的所有数据。而TreeCache节点树缓存是PathChildrenCache的增强,不光能监听子节点,也能监听节点自身,使用步骤和NodeCache类似。
参考文章:https://blog.csdn.net/Z_HHHH_Z/article/details
/121750230 https://blog.csdn.net/weixin_44827241/article
/details/126092900
读者专属技术群
构建高质量的技术交流社群,欢迎从事后端开发、运维技术进群(备注岗位,已在技术交流群的请勿重复添加)。主要以技术交流、内推、行业探讨为主,请文明发言。广告人士勿入,切勿轻信私聊,防止被骗。
扫码加我好友,拉你进群
推荐阅读 点击标题可跳转
CentOS 搭建 OpenVPN 服务,一次性成功!收藏了
PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。点“在看”支持我们吧!
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。