# zknotify-cache

**Repository Path**: mirrors_hsiafan/zknotify-cache

## Basic Information

- **Project Name**: zknotify-cache
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Artistic-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-23
- **Last Updated**: 2026-05-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

zknotify-cache
=======================
[![Build Status](https://travis-ci.org/PhantomThief/zknotify-cache.svg)](https://travis-ci.org/PhantomThief/zknotify-cache)
[![Coverage Status](https://coveralls.io/repos/github/PhantomThief/zknotify-cache/badge.svg?branch=master)](https://coveralls.io/github/PhantomThief/zknotify-cache?branch=master)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/PhantomThief/zknotify-cache.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/PhantomThief/zknotify-cache/alerts/)
[![Language grade: Java](https://img.shields.io/lgtm/grade/java/g/PhantomThief/zknotify-cache.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/PhantomThief/zknotify-cache/context:java)
[![Maven Central](https://img.shields.io/maven-central/v/com.github.phantomthief/zknotify-cache)](https://search.maven.org/artifact/com.github.phantomthief/zknotify-cache/)

ZooKeeper通知更新的本地缓存

* 缓存按需延迟懒加载
* 通知加载可设置随机延迟，防止所有节点同时加载造成数据源瞬时压力过大
* 旧的缓存内容可定制清理回调
* 只支持Java8

## Get Started

```Java
ReloadableCache<List<String>> cache = ZkNotifyReloadCache.<List<String>> newBuilder()
				.withCacheFactory(this::buildFromSource) // 配置cache构建方法，必须
				.withNotifyZkPath("/notifyPath1") // zk监听变更的路径，必须
				.withCuratorFactory(this::getCuratorFactory) // 提供zkClient的工场方法，必须
				.withMaxRandomSleepOnNotifyReload(30*1000) // zk通知reload时随机最大延迟时间，可选
				.withOldCleanup(this::cleanup) // 旧数据的清理方法，可选
				.enableAutoReload(1, TimeUnit.MINUTES) // 打开自动定时加载，可选
				.build();

List<String> content = cache.get(); // 获取内容，第一次调用本方法时才初始化

cache.reload(); // 通过zk通知所有节点更新
```

```Java
private List<String> buildFromSource() {
	// 从数据源加载数据
}

private CuratorFramework getCuratorFactory() {
	// 返回一个初始化好的CuratorFramework
}

private void cleanup(List<String> list) {
	// 清理旧对象操作
}
```