包装Zookeeper框架Curator，实现starter。
Mac安装：https://www.cnblogs.com/SuKiWX/p/13673710.html
图形化界面：https://www.cnblogs.com/cag2050/p/10278267.html
1. POM依赖
<?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.tellme</groupId>
<artifactId>zookeeper-starter</artifactId>
<version>1.0-RELEASE</version>
<description>ZooKeeper Starter</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.4.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-recipes</artifactId>
<version>5.1.0</version>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
<dependency>
<groupId>org.apache.curator</groupId>
<artifactId>curator-recipes</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</project>
2. resources配置
image.png
自动加载配置类：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tellme.zookeeper.autoconfig.ZooKeeperAutoConfiguration
3. 配置类代码
@Data
@ConfigurationProperties(prefix = "zookeeper")
public class ZooKeeperProperty {
/**
* zk连接集群，多个用逗号隔开
*/
private String servers;
/**
* 会话超时时间
*/
private int sessionTimeout = 60000;
/**
* 连接超时时间
*/
private int connectionTimeout = 15000;
/**
* 初始重试等待时间(毫秒)
*/
private int baseSleepTime = 1000;
/**
* 重试最大次数
*/
private int maxRetries = 10;
}
@Configuration
@ConditionalOnProperty(prefix = "zookeeper", name = "servers")
@EnableConfigurationProperties(value = ZooKeeperProperty.class)
public class ZooKeeperAutoConfiguration {
private Logger logger = LoggerFactory.getLogger(ZooKeeperAutoConfiguration.class);
/**
* 初始化连接以及重试
* @param zooKeeperProperty 配置属性
* @return 连接
*/
@Bean(initMethod = "start", destroyMethod = "close")
@ConditionalOnMissingBean
public CuratorFramework curatorFramework(ZooKeeperProperty zooKeeperProperty) {
RetryPolicy retryPolicy = new ExponentialBackoffRetry(zooKeeperProperty.getBaseSleepTime(), zooKeeperProperty.getMaxRetries());
CuratorFramework client = CuratorFrameworkFactory.builder()
.connectString(zooKeeperProperty.getServers())
.connectionTimeoutMs(zooKeeperProperty.getConnectionTimeout())
.sessionTimeoutMs(zooKeeperProperty.getSessionTimeout())
.retryPolicy(retryPolicy)
.build();
return client;
}
@Bean
@ConditionalOnMissingBean
public ZooKeeperTemplate zooKeeperTemplate(CuratorFramework client) {
return new ZooKeeperTemplate(client);
}
}
public interface ZooKeeperCallback<T> {
T callback() throws Exception;
String getLockPath();
}
4. 核心代码Template的实现
public class ZooKeeperTemplate {
private static final Logger logger = LoggerFactory.getLogger(ZooKeeperTemplate.class);
/**
* 路径分隔符
*/
private static final String PATH_SEPARATOR = "/";
/**
* zk连接
*/
private final CuratorFramework client;
public ZooKeeperTemplate(CuratorFramework client) {
this.client = client;
}
/**
* 创建空节点，默认持久节点
*
* @param path 节点路径
* @param node 节点名称
* @return 完整路径
*/
public String createNode(String path, String node) {
return createNode(path, node, CreateMode.PERSISTENT);
}
/**
* 创建带类型的空节点
*
* @param path 节点路径
* @param node 节点名称
* @param createMode 类型
* @return 路径
*/
public String createNode(String path, String node, CreateMode createMode) {
path = buildPath(path, node);
logger.info("create node for path: {} with createMode: {}", path, createMode.name());
try {
client.create()
.orSetData()
.creatingParentsIfNeeded()
.withMode(createMode)
.forPath(path);
return path;
} catch (Exception e) {
logger.error("create node for path: {} with createMode: {} failed!", path, createMode.name(), e);
return null;
}
}
/**
* 创建节点，默认持久节点
*
* @param path 节点路径
* @param node 节点名称
* @param value 节点值
* @return 完整路径
*/
public String createNode(String path, String node, String value) {
return createNode(path, node, value, CreateMode.PERSISTENT);
}
/**
* 创建节点，默认持久节点
*
* @param path 节点路径
* @param node 节点名称
* @param value 节点值
* @param createMode 节点类型
* @return 完整路径
*/
public String createNode(String path, String node, String value, CreateMode createMode) {
if (Objects.isNull(value)) {
throw new ZooKeeperException("ZooKeeper节点值不能为空!");
}
path = buildPath(path, node);
logger.info("create node for path: {}, value: {}, with createMode: {}", path, value, createMode.name());
try {
client.create()
.orSetData()
.creatingParentsIfNeeded()
.withMode(createMode)
.forPath(path, value.getBytes());
return path;
} catch (Exception e) {
logger.error("create node for path: {}, value: {}, with createMode: {} failed!", path, value, createMode.name(), e);
}
return null;
}
/**
* 获取节点数据
*
* @param path 路径
* @param node 节点名称
* @return 完整路径
*/
public String get(String path, String node) {
path = buildPath(path, node);
try {
byte[] bytes = client.getData().forPath(path);
if (bytes.length > 0) {
return new String(bytes);
}
} catch (Exception e) {
logger.error("get value for path: {}, node: {} failed!", path, node, e);
}
return null;
}
/**
* 更新节点数据
*
* @param path 节点路径
* @param node 节点名称
* @param value 更新值
* @return 完整路径
*/
public String update(String path, String node, String value) {
if (Objects.isNull(value)) {
throw new ZooKeeperException("ZooKeeper节点值不能为空!");
}
path = buildPath(path, node);
logger.info("update path: {} to value: {}", path, value);
try {
client.setData().forPath(path, value.getBytes());
return path;
} catch (Exception e) {
logger.error("update path: {} to value: {} failed!", path, value);
}
return null;
}
/**
* 删除节点，并且递归删除子节点
*
* @param path 路径
* @param node 节点名称
* @return 路径
*/
public boolean delete(String path, String node) {
path = buildPath(path, node);
logger.info("delete node for path: {}", path);
try {
client.delete().quietly().deletingChildrenIfNeeded().forPath(path);
return true;
} catch (Exception e) {
logger.error("delete node for path: {} failed!", path);
}
return false;
}
/**
* 获取子节点
* @param path 节点路径
* @return
*/
public List<String> getChildren(String path) {
if(StringUtils.isEmpty(path)) {
return null;
}
if (!path.startsWith(PATH_SEPARATOR)) {
path = PATH_SEPARATOR + path;
}
try{
return client.getChildren().forPath(path);
} catch (Exception e) {
logger.info("获取{}子节点失败！", path, e);
}
return null;
}
/**
* 判断节点是否存在
*
* @param path 路径
* @param node 节点名称
* @return 结果
*/
public boolean exists(String path, String node) {
try {
List<String> list = getChildren(path);
return !CollectionUtils.isEmpty(list) && list.contains(node);
} catch (Exception e) {
return false;
}
}
/**
* 申请锁，指定请求等待时间
*
* @param callback 回掉
* @param time 时间
* @param unit 时间单位
* @return .
*/
public <T> T lock(ZooKeeperCallback<T> callback, long time, TimeUnit unit) {
try {
InterProcessMutex lock = new InterProcessMutex(client, callback.getLockPath());
if (lock.acquire(time, unit)) {
try {
return callback.callback();
} finally {
lock.release();
}
} else {
logger.error("获取锁超时：{}!", callback.getLockPath());
}
} catch (Exception e) {
logger.error("获取锁失败: {}!", callback.getLockPath());
}
return null;
}
/**
* 申请锁，指定请求等待时间
*
* @param path 加锁zk节点
* @param time 时间
* @param unit 时间单位
* @param runnable 执行方法
*/
public void lock(String path, long time, TimeUnit unit, Runnable runnable) {
try {
InterProcessMutex lock = new InterProcessMutex(client, path);
if (lock.acquire(time, unit)) {
try {
runnable.run();
} finally {
lock.release();
}
} else {
logger.error("获取锁超时：{}!", path);
}
} catch (Exception e) {
logger.error("获取锁失败: {}!", path);
}
}
/**
* 申请锁，指定请求等待时间
*
* @param path 加锁zk节点
* @param time 时间
* @param unit 时间单位
* @param callable 执行方法
* @return .
*/
public <T> T lock(String path, long time, TimeUnit unit, Callable<T> callable) {
try {
InterProcessMutex lock = new InterProcessMutex(client, path);
if (lock.acquire(time, unit)) {
try {
return callable.call();
} finally {
lock.release();
}
} else {
logger.error("获取锁超时：{}!", path);
}
} catch (Exception e) {
logger.error("获取锁失败: {}!", path);
}
return null;
}
/**
* 对一个节点进行监听，监听事件包括指定的路径节点的增、删、改的操作
*
* @param path 节点路径
* @param listener 回调方法
*/
public void watchNode(String path, NodeCacheListener listener) {
CuratorCache curatorCache = CuratorCache.builder(client, path).build();
curatorCache.listenable().addListener(CuratorCacheListener.builder().forNodeCache(listener).build());
curatorCache.start();
}
/**
* 对指定的路径节点的一级子目录进行监听，不对该节点的操作进行监听，对其子目录的节点进行增、删、改的操作监听
*
* @param path 节点路径
* @param listener 回调方法
*/
public void watchChildren(String path, PathChildrenCacheListener listener) {
try {
PathChildrenCache pathChildrenCache = new PathChildrenCache(client, path, true);
pathChildrenCache.start(PathChildrenCache.StartMode.NORMAL);
pathChildrenCache.getListenable().addListener(listener);
} catch (Exception e) {
logger.error("watch children failed for path: {}", path, e);
}
}
/**
* 将指定的路径节点作为根节点（祖先节点），对其所有的子节点操作进行监听，呈现树形目录的监听，可以设置监听深度，最大监听深度为2147483647（int类型的最大值）
*
* @param path 节点路径
* @param maxDepth 回调方法
* @param listener 监听
*/
public void watchTree(String path, int maxDepth, TreeCacheListener listener) {
try {
TreeCache treeCache = TreeCache.newBuilder(client, path).setMaxDepth(maxDepth).build();
treeCache.start();
treeCache.getListenable().addListener(listener);
} catch (Exception e) {
logger.error("watch tree failed for path: {}", path, e);
}
}
public String buildPath(String path, String node) {
if (StringUtils.isEmpty(path) || StringUtils.isEmpty(node)) {
throw new ZooKeeperException("ZooKeeper路径或者节点名称不能为空！");
}
if (!path.startsWith(PATH_SEPARATOR)) {
path = PATH_SEPARATOR + path;
}
if (PATH_SEPARATOR.equals(path)) {
return path + node;
} else {
return path + PATH_SEPARATOR + node;
}
}
}
5. 配置类
zookeeper:
servers: 127.0.0.1:2181
