基本介绍
Curator是netflix公司开源的一套zookeeper客户端,目前是Apache的顶级项目。与Zookeeper提供的原生客户端相比,Curator的抽象层次更高,简化了Zookeeper客户端的开发量。Curator解决了很多zookeeper客户端非常底层的细节开发工作,包括连接重连、反复注册wathcer和
NodeExistsException 异常等。
通过查看官方文档,可以发现Curator主要解决了三类问题:
- 封装ZooKeeper client与ZooKeeper server之间的连接处理
- 提供了一套Fluent风格的操作API
- 提供ZooKeeper各种应用场景(recipe, 比如:分布式锁服务、集群领导选举、共享计数器、缓存机制、分布式队列等)的抽象封装,这些实现都遵循了zk的最佳实践,并考虑了各种极端情况
Curator由一系列的模块构成,对于一般开发者而言,常用的是curator-framework和curator-
recipes:
- curator-framework:提供了常见的zk相关的底层操作
- curator-recipes:提供了一些zk的典型使用场景的参考。本节重点关注的分布式锁就是该包提供的
基本配置
引入依赖:
最新版本的curator 4.3.0支持zookeeper 3.4.x和3.5,但是需要注意curator传递进来的依赖,需要和实际服务器端使用的版本相符,以我们目前使用的zookeeper 3.4.14为例。
1. <dependency> 2. <groupId>org.apache.zookeeper</groupId> 3. <artifactId>zookeeper</artifactId> 4. <version>3.4.14</version> 5. <exclusions> 6. <exclusion> 7. <groupId>org.arakhne.afc.slf4j</groupId> 8. <artifactId>slf4j-log4j</artifactId> 9. </exclusion> 10. </exclusions> 11. </dependency> 12. <dependency> 13. <groupId>org.apache.curator</groupId> 14. <artifactId>curator-framework</artifactId> 15. <version>4.3.0</version> 16. <exclusions> 17. <exclusion> 18. <groupId>org.apache.zookeeper</groupId> 19. <artifactId>zookeeper</artifactId> 20. </exclusion> 21. </exclusions> 22. </dependency>
添加curator客户端配置:
1. @Configuration 2. public class zkCuratorConfig { 3. @Bean 4. public CuratorFramework curatorFramework(){ 5. //后台重试,每个1000ms重试一次,重试3次 6. RetryPolicy retryPolicy=new ExponentialBackoffRetry(1000,3); 7. //初始化CuratorFramework客户端,如果有多哥zk地址,以逗号分割 8. CuratorFramework client = CuratorFrameworkFactory. 9. newClient("192.168.107.135", retryPolicy); 10. //启动链接 11. client.start(); 12. return client 13. } 14. }
可重入锁InterProcessMutex
Reentrant和JDK的ReentrantLock类似, 意味着同一个客户端在拥有锁的同时,可以多次获取,不会被 阻塞。它是由类InterProcessMutex来实现。
1. // 常用构造方法 2. public InterProcessMutex(CuratorFramework client, String path) 3. // 获取锁 4. public void acquire(); 5. // 带超时时间的可重入锁 6. public boolean acquire(long time, TimeUnit unit); 7. // 释放锁 8. public void release();
改造service测试方法:
1. @Autowired 2. 3. private CuratorFramework curatorFramework; 4. 5. public void checkAndLock() { 6. try { 7. // 加锁,获取锁失败重试 8. InterProcessMutex mutex = new InterProcessMutex(curatorFramework,"/curator/lock"); 9. mutex.acquire(); 10. // 先查询库存是否充足 11. Stock stock = this.stockMapper.selectById(1L); 12. // 再减库存 13. if (stock != null && stock.getCount() > 0) { 14. stock.setCount(stock.getCount() - 1); 15. this.stockMapper.updateById(stock); 16. } 17. // 释放锁 18. mutex.release(); 19. } catch (Exception e) { 20. e.printStackTrace(); 21. } 22. }
注意:如想重入,则需要使用同一个InterProcessMutex对象。
压力测试结果:
不可重入锁InterProcessSemaphoreMutex
具体实现:InterProcessSemaphoreMutex。与InterProcessMutex调用方法类似,区别在于该锁是不 可重入的,在同一个线程中不可重入。
1. // 构造函数需要包含的锁的集合,或者一组ZooKeeper的path 2. public InterProcessMultiLock(List<InterProcessLock> locks); 3. public InterProcessMultiLock(CuratorFramework client, List<String> paths); 4. // 获取锁 5. public void acquire(); 6. public boolean acquire(long time, TimeUnit unit); 7. // 释放锁 8. public synchronized void release();
可重入读写锁InterProcessReadWriteLock
类似JDK的ReentrantReadWriteLock。一个拥有写锁的线程可重入读锁,但是读锁却不能进入写锁。这也意味着写锁可以降级成读锁。从读锁升级成写锁是不成的。主要实现类
InterProcessReadWriteLock:
1. // 构造方法 2. public InterProcessReadWriteLock(CuratorFramework client, String basePath); 3. // 获取读锁对象 4. InterProcessMutex readLock(); 5. // 获取写锁对象 6. InterProcessMutex writeLock();
联锁InterProcessMultiLock
Multi Shared Lock是一个锁的容器。当调用acquire, 所有的锁都会被acquire,如果请求失败,所有的锁都会被release。同样调用release时所有的锁都被release(失败被忽略)。基本上,它就是组锁的代表,在它上面的请求释放操作都会传递给它包含的所有的锁。实现类InterProcessMultiLock:
1. // 构造函数需要包含的锁的集合,或者一组ZooKeeper的path 2. public InterProcessMultiLock(List<InterProcessLock> locks); 3. public InterProcessMultiLock(CuratorFramework client, List<String> paths); 4. // 获取锁 5. public void acquire(); 6. public boolean acquire(long time, TimeUnit unit); 7. // 释放锁 8. public synchronized void release();
信号量InterProcessSemaphoreV2
一个计数的信号量类似JDK的Semaphore。JDK中Semaphore维护的一组许可(permits),而Cubator中称之为租约(Lease)。注意,所有的实例必须使用相同的numberOfLeases值。调用acquire会返回一个租约对象。客户端必须在finally中close这些租约对象,否则这些租约会丢失掉。但是,如果客户端session由于某种原因比如crash丢掉, 那么这些客户端持有的租约会自动close, 这样其它客户端可以继续使用这些租约。主要实现类InterProcessSemaphoreV2:
1. // 构造方法 2. public InterProcessSemaphoreV2(CuratorFramework client, String path, int 3. maxLeases); 4. // 注意一次你可以请求多个租约,如果Semaphore当前的租约不够,则请求线程会被阻塞。 5. // 同时还提供了超时的重载方法 6. public Lease acquire(); 7. public Collection<Lease> acquire(int qty); 8. public Lease acquire(long time, TimeUnit unit); 9. public Collection<Lease> acquire(int qty, long time, TimeUnit unit) 10. // 租约还可以通过下面的方式返还 11. public void returnAll(Collection<Lease> leases); 12. public void returnLease(Lease lease);
栅栏barrier
1. DistributedBarrier构造函数中barrierPath参数用来确定一个栅栏,只要barrierPath参数相同
(路径相同)就是同一个栅栏。通常情况下栅栏的使用如下:
- 1. 主client设置一个栅栏
- 2. 其他客户端就会调用waitOnBarrier()等待栅栏移除,程序处理线程阻塞
- 3. 主client移除栅栏,其他客户端的处理程序就会同时继续运行。
DistributedBarrier类的主要方法如下:
1. setBarrier() - 设置栅栏 2. waitOnBarrier() - 等待栅栏移除 3. removeBarrier() - 移除栅栏
2. DistributedDoubleBarrier双栅栏,允许客户端在计算的开始和结束时同步。当足够的进程加入到
双栅栏时,进程开始计算,当计算完成时,离开栅栏。DistributedDoubleBarrier实现了双栅栏的
功能。构造函数如下:
1. // client - the client 2. // barrierPath - path to use 3. // memberQty - the number of members in the barrier 4. public DistributedDoubleBarrier(CuratorFramework client, String 5. barrierPath, int memberQty); 6. enter()、enter(long maxWait, TimeUnit unit) - 等待同时进入栅栏 7. leave()、leave(long maxWait, TimeUnit unit) - 等待同时离开栅栏
memberQty是成员数量,当enter方法被调用时,成员被阻塞,直到所有的成员都调用了enter。
当leave方法被调用时,它也阻塞调用线程,直到所有的成员都调用了leave。
注意:参数memberQty的值只是一个阈值,而不是一个限制值。当等待栅栏的数量大于或等于这
个值栅栏就会打开!
与栅栏(DistributedBarrier)一样,双栅栏的barrierPath参数也是用来确定是否是同一个栅栏的,双
栅栏的使用情况如下:
- 1. 从多个客户端在同一个路径上创建双栅栏(DistributedDoubleBarrier),然后调用enter()方
- 法,等待栅栏数量达到memberQty时就可以进入栅栏。
- 2. 栅栏数量达到memberQty,多个客户端同时停止阻塞继续运行,直到执行leave()方法,等待memberQty个数量的栅栏同时阻塞到leave()方法中。
- 3. memberQty个数量的栅栏同时阻塞到leave()方法中,多个客户端的leave()方法停止阻塞,继续运行。
倒计数器
利用ZooKeeper可以实现一个集群共享的计数器。只要使用相同的path就可以得到最新的计数器值,这是由ZooKeeper的一致性保证的。Curator有两个计数器, 一个是用int来计数,一个用long来计数。SharedCount这个类使用int类型来计数。主要涉及三个类。
1. * SharedCount 2. * SharedCountReader 3. * SharedCountListener
SharedCount代表计数器, 可以为它增加一个SharedCountListener,当计数器改变时此Listener可以监听到改变的事件,而SharedCountReader可以读取到最新的值, 包括字面值和带版本信息的值VersionedValue。
DistributedAtomicLong
除了计数的范围比SharedCount大了之外, 它首先尝试使用乐观锁的方式设置计数器, 如果不成功(比如期间计数器已经被其它client更新了), 它使用InterProcessMutex方式来更新计数值。此计数器有一系列的操作:
get(): 获取当前值
increment():加一
decrement(): 减一
add():增加特定的值
subtract(): 减去特定的值
trySet(): 尝试设置计数值
forceSet(): 强制设置计数值
你必须检查返回结果的succeeded(), 它代表此操作是否成功。如果操作成功, preValue()代表操作前的值, postValue()代表操作后的值。