Zookeeper -- Zookeeper JavaAPI相关操作（Curator介绍、Curator API 常用操作（节点的CRUD，Watch事件监听）、分布式锁、模拟12306售票案例）

月白色的大狒

 关注

阅读 36

2022-04-13

文章目录

本节案例承接上节案例

1. Curator介绍

  • Curator 是 Apache ZooKeeper 的Java客户端库。
  • 常见的ZooKeeper Java API ：
    • 原生Java API
    • ZkClient
    • Curator
  • Curator 项目的目标是简化 ZooKeeper 客户端的使用。
  • Curator 最初是 Netfix 研发的，后来捐献了 Apache 基金会，目前是 Apache 的顶级项目。
  • 官网：http://curator.apache.org/
    在这里插入图片描述

2. Curator API 常用操作

我们先创建一个名为curator-zk的普通maven工程。
在这里插入图片描述

然后导入相关的依赖：pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.tian</groupId>
    <artifactId>curator-zk</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>

        <!--curator-->
        <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>
        <!--日志-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.21</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.7.21</version>
        </dependency>
    </dependencies>

</project>

在这里插入图片描述
配置日志信息打印：log4j.properties

log4j.rootLogger=off,stdout

log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%d{yyyy-MM-dd HH/:mm/:ss}]%-5p %c(line/:%L) %x-%m%n

在这里插入图片描述

新建一个Curator测试类：

package com.tian;

public class CuratorTest {
}

下面的这些方法都是写在这个测试类里面的。

2.1 建立连接

2.1.1 连接方式1

    @Test
    public void testConnect1() {
        CuratorFrameworkFactory.newClient("192.168.135.130:2181", 60 * 1000, 15 * 1000, new ExponentialBackoffRetry(300, 10)).start();
    }

在这里插入图片描述

在这里插入图片描述

2.1.2 连接方式2（链式编程）

    @Test
    public void testConnect2() {
        CuratorFrameworkFactory
                .builder()
                .connectString("192.168.135.130:2181")
                .sessionTimeoutMs(60 * 1000)
                .connectionTimeoutMs(15 * 1000)
                .retryPolicy(new ExponentialBackoffRetry(300, 10))
                .build()
                .start();
    }

在这里插入图片描述

2.2 添加节点

在这里插入图片描述

package com.tian;

import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.CuratorFrameworkFactory;
import org.apache.curator.retry.ExponentialBackoffRetry;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

public class CuratorTest {
    private CuratorFramework client;

    @Test
    public void testConnect1() {
        CuratorFrameworkFactory.newClient("192.168.135.130:2181", 60 * 1000, 15 * 1000, new ExponentialBackoffRetry(300, 10)).start();
    }

    @Before
    public void testConnect2() {
        client = CuratorFrameworkFactory
                .builder()
                .connectString("192.168.135.130:2181")
                .sessionTimeoutMs(60 * 1000)
                .connectionTimeoutMs(15 * 1000)
                .retryPolicy(new ExponentialBackoffRetry(300, 10))
                .build();
                
        client.start();
    }

    @After
    public void closeConnection() {
        client.close();
    }

}

2.2.1 基本创建

    @Test
    public void basicCreate() throws Exception {
        // 1. 基本创建
        // 如果创建节点没有指定数据, 则默认将当前客户端的ip作为数据存储
        client.create().forPath("/app1");
    }

在这里插入图片描述

在这里插入图片描述

2.2.1 创建节点：带有数据

    @Test
    public void createWithData() throws Exception {
    // 2. 创建节点：带有数据
        client.create().forPath("/app2", "CodeJiao".getBytes(StandardCharsets.UTF_8));
    }

在这里插入图片描述
在这里插入图片描述

2.2.3 创建节点：设置节点类型

    @Test
    public void createWithType() throws Exception {
        // 3. 设置类型, 默认类型, 持久化
        // 现在来创建一个临时节点 /app3
        // CreateMode是一个枚举类型
        client.create().withMode(CreateMode.EPHEMERAL).forPath("/app3");
    }

在这里插入图片描述
但是这里却看不见/app3节点，因为临时节点只在当前会话有效。Java方法执行完毕后，当前会话就结束了。
在这里插入图片描述

2.2.4 创建多级节点

    @Test
    public void createMultiLevelNode() throws Exception {
        // 3. 创建多级节点 creatingParentsIfNeeded() 表示如果没有父节点 则自动创建父节点.
        client.create().creatingParentsIfNeeded().forPath("/app4/p1");
    }

在这里插入图片描述
在这里插入图片描述

2.2.5 小结

在这里插入图片描述

2.3 删除节点

2.3.1 删除单个节点（无子节点）

    @Test
    public void testDelEmptyNode() throws Exception {
        client.delete().forPath("/app1");
    }

2.3.2 删除带有子节点的节点（任何情况都可以删除：包括有子结点也可以删除成功）

    @Test
    public void testDelNode() throws Exception {
        client.delete().deletingChildrenIfNeeded().forPath("/app1");
    }

2.3.3 必须成功的删除

    @Test
    public void testDelNode() throws Exception {
        client.delete().guaranteed().forPath("/app1");
    }

2.3.4 回调（删完之后需要做的事情）

    @Test
    public void testWithCallback() throws Exception {
        client.delete().guaranteed().inBackground(new BackgroundCallback() {
            @Override
            public void processResult(CuratorFramework curatorFramework, CuratorEvent curatorEvent) throws Exception {
                System.out.println("/app1节点被删除了");
                System.out.println(curatorFramework.toString());
                System.out.println(curatorEvent);
            }
        }).forPath("/app2");
    }

在这里插入图片描述

2.4 修改节点

2.4.1 修改数据

    @Test
    public void modifyData() throws Exception {
        client.setData().forPath("/app1", "数据被修改了".getBytes(StandardCharsets.UTF_8));
    }

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述在这里插入图片描述

2.4.2 根据版本去修改数据（保证不被其他线程或操作干扰）

    @Test
    public void modifyDataByVersion() throws Exception {
        // 查询版本信息
        Stat stat = new Stat();
        client.getData().storingStatIn(stat).forPath("/app1");
        int version = stat.getVersion();
        System.out.println(version);

        // 根据版本修改数据：如果版本匹配, 则会报错
        client.setData().withVersion(version).forPath("/app1", "根据版本修改数据".getBytes(StandardCharsets.UTF_8));
    }

2.5 查询节点

2.5.1 查询数据

    @Test
    public void queryData() throws Exception {
        // 1. 查询数据
        byte[] bytes = client.getData().forPath("/app1");
        System.out.println(new String(bytes));
    }

在这里插入图片描述

2.5.2 查询子节点

    @Test
    public void queryChildNode() throws Exception {
        // 2. 查询子结点
        List<String> paths = client.getChildren().forPath("/");
        
        for (String path : paths) {
            System.out.println(path);
        }
    }

在这里插入图片描述

2.5.3 查询节点状态信息

    @Test
    public void queryNodeStatusInfo() throws Exception {
        Stat stat = new Stat();
        System.out.println(stat);

        // 3.查询节点状态信息
        byte[] bytes = client.getData().storingStatIn(stat).forPath("/app1");
        
        System.out.println(stat);
    }

在这里插入图片描述

2.6 Watch事件监听

  • ZooKeeper 允许用户在指定节点上注册一些Watcher，并且在一些特定事件触发的时候，ZooKeeper 服务端会将事件通知到感兴趣的客户端上去，该机制是 ZooKeeper 实现分布式协调服务的重要特性。
  • ZooKeeper 中引入了Watcher机制来实现了发布/订阅功能能，能够让多个订阅者同时监听某一个对象，当一个对象自身状态变化时，会通知所有订阅者。
  • ZooKeeper 原生支持通过注册Watcher来进行事件监听，但是其使用并不是特别方便 需要开发人员自己反复注册Watcher，比较繁琐。
  • Curator引入了 Cache 来实现对 ZooKeeper 服务端事件的监听。 ZooKeeper提供了三种Watcher：
    • NodeCache : 只是监听某一个特定的节点
    • PathChildrenCache : 监控一个ZNode的子节点.
    • TreeCache : 可以监控整个树上的所有节点，类似于PathChildrenCache和NodeCache的组合
      在这里插入图片描述

2.6.1 NodeCache （监听某一个特定的节点 ）

 @Test
    public void testNodeCache() throws Exception {
        // 1. 创建NodeCache对象
        NodeCache nodeCache = new NodeCache(client, "/app1");

        // 2. 注册监听
        nodeCache.getListenable().addListener(new NodeCacheListener() {
            @Override
            public void nodeChanged() throws Exception {
                System.out.println("节点信息发生变化");
                System.out.println("更新后的数据为: " + new String(nodeCache.getCurrentData().getData()));

            }
        });

        // 3. 开启监听。true代表一次性把缓存的节点数据加载过来.
        nodeCache.start(true);


        while (true) {
            // 避免一直空转
            Thread.sleep(500);
        }
    }

在这里插入图片描述

在这里插入图片描述在这里插入图片描述
在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

2.6.2 PathChildrenCache （监听某一节点的子节点的变化 但是不可以监听自己）

    @Test
    public void testPathChildCache() throws Exception {
        // true 代表加载缓存数据
        PathChildrenCache pathChildrenCache = new PathChildrenCache(client, "/app1", true);
        // 绑定监听器
        pathChildrenCache.getListenable().addListener(new PathChildrenCacheListener() {
            @Override
            public void childEvent(CuratorFramework curatorFramework, PathChildrenCacheEvent pathChildrenCacheEvent) throws Exception {
                System.out.println("子节点变化了");
                System.out.println(pathChildrenCacheEvent);
                // 监听子节点的数据变更, 并且拿到变更后的数据
                // 1. 获取类型
                PathChildrenCacheEvent.Type type = pathChildrenCacheEvent.getType();
                if (type.equals(PathChildrenCacheEvent.Type.CHILD_UPDATED)) {
                    byte[] data = pathChildrenCacheEvent.getData().getData();
                    System.out.println(new String(data));
                }
            }
        });

        // 3. 开启监听。
        pathChildrenCache.start();


        while (true) {
            // 避免一直空转
            Thread.sleep(500);
        }
    }

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

2.6.3 TreeCache （不仅可以监听某一节点的子节点的变化 还可以监听自己）

public void testTreeCache() throws Exception {
        TreeCache treeCache = new TreeCache(client, "/app1");
        treeCache.getListenable().addListener(new TreeCacheListener() {
            @Override
            public void childEvent(CuratorFramework curatorFramework, TreeCacheEvent treeCacheEvent) throws Exception {
                System.out.println("节点变化了");
                System.out.println(treeCacheEvent);
            }
        });

        treeCache.start();
        while (true) {
            // 避免一直空转
            Thread.sleep(500);
        }
    }

2.7 分布式锁

2.7.1 分布式锁的介绍

  • 在我们进行单机应用开发，涉及并发同步的时候，我们往往采用synchronized或者Lock的方式来解决多线程间的代码同步问题，这时多线程的运行都是在同一个JVM之下，没有任何问题。
  • 但当我们的应用是分布式集群工作的情况下，属于多JVM下的工作环境，跨JVM之间已经无法通过多线程的锁解决同步问题。
  • 那么就需要一种更加高级的锁机制，来处理种跨机器的进程之间的数据同步问题——这就是分布式锁。

在这里插入图片描述

2.7.2 分布式锁的原理

核心思想：当客户端要获取锁，则创建节点，使用完锁，则删除该节点。

  • 客户端获取锁时，在lock节点下创建临时顺序节点。（类用于Java中需要在final关键字关闭资源，要保证程序出现异常或者宕机后依然能够释放资源。）
  • 然后获取lock下面的所有子节点，客户端获取到所有的子节点之后，如果发现自己创建的子节点序号最小，那么就认为该客户端获取到了锁。使用完锁后，将该节点删除。
  • 如果发现自己创建的节点并非lock所有子节点中最小的，说明自己还没有获取到锁，此时客户端需要找到比自己小的那个节点，同时对其注册事件监听器，监听删除事件。
  • 如果发现比自己小的那个节点被删除，则客户端的 Watcher会收到相应通知，此时再次判断自己创建的节点 是否是lock子节点中序号最小的，如果是则获取到了锁，如果不是则重复以上步骤继续获取到比自己小的一个节点 并注册监听。

在这里插入图片描述

2.7.3 分布式锁：模拟12306售票案例

在Curator中有五种锁方案：

  • InterProcessSemaphoreMutex：分布式排它锁（非可重入锁） -
  • InterProcessMutex：分布式可重入排它锁
  • InterProcessReadWriteLock：分布式读写锁
  • InterProcessMultiLock：将多个锁作为单个实体管理的容器
  • InterProcessSemaphoreV2：共享信号量

在这里插入图片描述

我们首先新建2个类，LockTest是做这次案例测试的，Ticket12306是模拟12306客户端。
在这里插入图片描述

Ticket12306.java

package com.tian;

public class Ticket12306 implements Runnable {
    private int tickets = 10; // 数据的票数
    
    @Override
    public void run() {
        while (true) {
            if (tickets > 0) {
                System.out.println(Thread.currentThread() + " : " + tickets);
                tickets--;
            }
        }
    }
}

LockTest.java

package com.tian;

public class LockTest {
    public static void main(String[] args) {
        Ticket12306 ticket = new Ticket12306();

        // 创建客户端
        Thread thread1 = new Thread(ticket, "携程");
        Thread thread2 = new Thread(ticket, "飞猪");

        thread1.start();
        thread2.start();
    }
}

运行结果：

在这里插入图片描述

对Ticket12306.java加以改造

package com.tian;

import org.apache.curator.framework.CuratorFramework;
import org.apache.curator.framework.CuratorFrameworkFactory;
import org.apache.curator.framework.recipes.locks.InterProcessMutex;
import org.apache.curator.retry.ExponentialBackoffRetry;

import java.util.concurrent.TimeUnit;

public class Ticket12306 implements Runnable {
    private int tickets = 10; // 数据的票数
    private InterProcessMutex lock;
    private CuratorFramework client;

    public Ticket12306() {
        client = CuratorFrameworkFactory
                .builder()
                .connectString("192.168.135.130:2181")
                .sessionTimeoutMs(60 * 1000)
                .connectionTimeoutMs(15 * 1000)
                .retryPolicy(new ExponentialBackoffRetry(300, 10))
                .build();
        client.start();
			// 这个/lock节点可以不存在, InterProcessMutex会帮忙创建
        lock = new InterProcessMutex(client, "/lock");
    }

    @Override
    public void run() {
        while (true) {
            try {
                // 加锁 如果3s没有人来请求就会超时
                lock.acquire(3, TimeUnit.SECONDS);
                if (tickets > 0) {
                    System.out.println(Thread.currentThread() + " : " + tickets);
                    tickets--;
                }
            } catch (Exception e) {
//                e.printStackTrace();
            } finally {
                try {
                    // 释放锁
                    lock.release();
                } catch (Exception e) {
//                    e.printStackTrace();
                }
            }
        }
    }
}

现在的运行结果：

在这里插入图片描述在这里插入图片描述

2.8 源码分享

链接：https://pan.baidu.com/s/1hXg3C0GhOEYwXTk837NUAQ?pwd=3210 
提取码：3210

相关推荐

zookeeper Curator java 分布式锁

诗尚凝寒 38 0 0

Zookeeper：Zookeeper JavaAPI操作与分布式锁

凉夜lrs 27 0 0

Curator框架实现ZooKeeper分布式锁

Python百事通 32 0 0

ZooKeeper ： Curator框架之分布式锁InterProcessReadWriteLock

_鱼与渔_ 144 0 0

ZooKeeper ： Curator框架之分布式锁InterProcessSemaphoreMutex

承蒙不弃 72 0 0

ZooKeeper ： Curator框架之分布式锁InterProcessMutex

人间四月天i 28 0 0

Curator+Zookeeper实现分布式锁的示例

cwq聖泉寒江2020 11 0 0

4、zookeeper的java三种客户端介绍-Curator（crud、事务操作、监听、分布式计数器、分布式锁）

新鲜小饼干 95 0 0

java 使用 curator 的 API 操作 zookeeper

佃成成成成 68 0 0

zookeeper手动实现分布式锁以及Curator框架

萨科潘 82 0 0

精彩评论（0）

0 0 举报