PHPackages                             workbunny/webman-shared-cache - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Caching](/categories/caching)
4. /
5. workbunny/webman-shared-cache

ActiveLibrary[Caching](/categories/caching)

workbunny/webman-shared-cache
=============================

Webman plugin workbunny/webman-shared-cache

0.6.3(1mo ago)331.2k↓27%33MITPHPPHP >=7.4CI passing

Since Aug 15Pushed 1mo ago2 watchersCompare

[ Source](https://github.com/workbunny/webman-shared-cache)[ Packagist](https://packagist.org/packages/workbunny/webman-shared-cache)[ RSS](/packages/workbunny-webman-shared-cache/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (10)Dependencies (8)Versions (35)Used By (3)

[![workbunny](https://camo.githubusercontent.com/e2b1164338390ab45783434659e3e419e0c3b50fbe140c697ba1f82f59015ad6/68747470733a2f2f6368617a366368657a2e636e2f696d616765732f776f726b62756e6e792d6c6f676f2e706e67)](https://camo.githubusercontent.com/e2b1164338390ab45783434659e3e419e0c3b50fbe140c697ba1f82f59015ad6/68747470733a2f2f6368617a366368657a2e636e2f696d616765732f776f726b62756e6e792d6c6f676f2e706e67)

**workbunny/webman-shared-cache**

**🐇 A lightweight shared cache for webman plugin. 🐇**

A lightweight shared cache for webman plugin
============================================

[](#a-lightweight-shared-cache-for-webman-plugin)

 [ ![Build Status](https://github.com/workbunny/webman-shared-cache/actions/workflows/CI.yml/badge.svg) ](https://github.com/workbunny/webman-shared-cache/actions) [ ![Latest Stable Version](https://camo.githubusercontent.com/39c83ce7c1210619fd70816a06525dbeef1b1e191347b5ed0b36107646ecc265/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f762f776f726b62756e6e792f7765626d616e2d7368617265642d63616368652f6c6174657374) ](https://github.com/workbunny/webman-shared-cache/releases) [ ![PHP Version Require](https://camo.githubusercontent.com/efd42cca1aab956920dc18e0301f2180ed0dbfc377b620aceb5270c958d22589/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f776f726b62756e6e792f7765626d616e2d7368617265642d6361636865) ](https://github.com/workbunny/webman-shared-cache/blob/main/composer.json) [ ![GitHub license](https://camo.githubusercontent.com/0047dd662435f24c06021e0a955a2ae90926757ee5acfabe172508c09daf3383/68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f6c6963656e73652f776f726b62756e6e792f7765626d616e2d7368617265642d6361636865) ](https://github.com/workbunny/webman-shared-cache/blob/main/LICENSE)

常见问题
----

[](#常见问题)

### 1. 它与 Redis/Memcache 的区别

[](#1-它与-redismemcache-的区别)

- shared-cache是基于APCu的本地缓存，它的底层是带有锁的MMAP共享内存；
- Redis和Memcache本质上是“分布式”缓存系统/K-V数据库，存在网络IO；
- shared-cache没有持久化，同时也无法实现“分布式”，仅可用于本地的多进程环境（进程需要有亲缘关系）；
- shared-cache是μs级别的缓存，redis是ms级别的缓存；
- 网络IO存在内核态和用户态的多次拷贝，存在较大的延迟，共享内存不存在这样的问题；

### 2. 它的使用场景

[](#2-它的使用场景)

- 可以用作一些服务器的本地缓存，如页面缓存、L2-cache；
- 可以跨进程做一些计算工作，也可以跨进程通讯；
- 用在一些延迟敏感的服务下，如游戏服务器；
- 简单的限流插件；

### 3. 与redis简单的比较

[](#3-与redis简单的比较)

- 运行/tests/simple-benchmark.php
    - redis使用host.docker.internal
    - 在循环中增加不同的间隔，模拟真实使用场景
    - 结果如下： ```
        1^ "count: 100000"
        2^ "interval: 0 μs"
        ^ "redis: 73.606367111206"
        ^ "cache: 0.081215143203735"
        ^ "-----------------------------------"
        1^ "count: 100000"
        2^ "interval: 1 μs"
        ^ "redis: 78.833391904831"
        ^ "cache: 6.4423549175262"
        ^ "-----------------------------------"
        1^ "count: 100000"
        2^ "interval: 10 μs"
        ^ "redis: 79.543494939804"
        ^ "cache: 7.2690420150757"
        ^ "-----------------------------------"
        1^ "count: 100000"
        2^ "interval: 100 μs"
        ^ "redis: 88.58958697319"
        ^ "cache: 17.31387090683"
        ^ "-----------------------------------"
        1^ "count: 100000"
        2^ "interval: 1000 μs"
        ^ "redis: 183.2620780468"
        ^ "cache: 112.18278503418"
        ^ "-----------------------------------"
        ```

简介
--

[](#简介)

- 基于APCu拓展的轻量级高速缓存，读写微秒级；
- 支持具备亲缘关系的多进程内存共享；
- 支持具备亲缘关系的多进程限流；

安装
--

[](#安装)

**`PHP7.4`不完全兼容，请勿使用`Cache::Incr` `Cache::Decr`**

1. **自行安装APCu拓展**```
    # 1. pie安装
    pie install apcu/apcu
    # 2. docker中请使用安装器安装
    curl -sSL https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions -o - | sh -s apcu
    # 3. pecl安装 【不推荐】
    pecl instanll apcu
    ```
2. 安装composer包 ```
    composer require workbunny/webman-shared-cache
    ```
3. 使用命令进行php.ini的配置
    - 进入 **/config/plugin/workbunny/webman-shared-cache** 目录
    - 运行

    ```
    # 帮助信息
    sh ./shared-cache-enable.sh --help
    # or
    bash ./shared-cache-enable.sh --help
    ```

使用
--

[](#使用)

#### 注：\\Workbunny\\WebmanSharedCache\\Cache::$fuse为全局阻塞保险

[](#注workbunnywebmansharedcachecachefuse为全局阻塞保险)

### 1. Cache基础使用

[](#1-cache基础使用)

- **类似Redis的String【使用方法与Redis基本一致】**

    - 支持 Set/Get/Del/Keys/Exists
    - 支持 Incr/Decr，支持浮点运算
    - 支持 储存对象数据
    - 支持 XX/NX模式，支持秒级过期时间
- **类似Redis的Hash【使用方法与Redis基本一致】**

    - 支持 HSet/HGet/HDel/HKeys/HExists
    - 支持 HIncr/HDecr，支持浮点运算
    - 支持 储存对象数据
    - 支持 HashKey的秒级过期时间【版本 ≥ 0.5】
- **通配符/正则匹配Search**

    ```
    $result = [];
    # 默认正则匹配 - 以50条为一次分片查询
    \Workbunny\WebmanSharedCache\Cache::Search('/^abc.+$/', function ($key, $value) use (&$result) {
        $result[$key] = $value;
    }, 50);

    # 通配符转正则
    \Workbunny\WebmanSharedCache\Cache::Search(
        \Workbunny\WebmanSharedCache\Cache::WildcardToRegex('abc*'),
        function ($key, $value) use (&$result) {
            $result[$key] = $value;
        }
    );
    ```

    **Tips：Cache::Search()本质上是个扫表匹配的过程，是O(N)的操作，如果需要对特定族群的数据进行监听，推荐使用Channel相关函数实现监听。**
- **原子性执行**

    ```
    # key-1、key-2、key-3会被当作一次原子性操作

    # 非阻塞执行 - 成功执行则返回true，失败返回false，锁冲突会导致执行失败
    $result = \Workbunny\WebmanSharedCache\Cache::Atomic('lock-test', function () {
        \Workbunny\WebmanSharedCache\Cache::Set('key-1', 1);
        \Workbunny\WebmanSharedCache\Cache::Set('key-2', 2);
        \Workbunny\WebmanSharedCache\Cache::Set('key-3', 3);
    });
    # 阻塞等待执行 - 默认阻塞受Cache::$fuse阻塞保险影响
    $result = \Workbunny\WebmanSharedCache\Cache::Atomic('lock-test', function () {
        \Workbunny\WebmanSharedCache\Cache::Set('key-1', 1);
        \Workbunny\WebmanSharedCache\Cache::Set('key-2', 2);
        \Workbunny\WebmanSharedCache\Cache::Set('key-3', 3);
    }, true);
    # 自行实现阻塞
    $result = false
    while (!$result) {
        # TODO 可以适当增加保险，以免超长阻塞
        $result = \Workbunny\WebmanSharedCache\Cache::Atomic('lock-test', function () {
            \Workbunny\WebmanSharedCache\Cache::Set('key-1', 1);
            \Workbunny\WebmanSharedCache\Cache::Set('key-2', 2);
            \Workbunny\WebmanSharedCache\Cache::Set('key-3', 3);
        });
    }
    ```
- **查看cache信息**

    ```
    # 全量数据
    var_dump(\Workbunny\WebmanSharedCache\Cache::Info());

    # 不查询数据
    var_dump(\Workbunny\WebmanSharedCache\Cache::Info(true));
    ```
- **查看锁信息**

    ```
    # Hash数据的处理建立在写锁之上，如需调试，则使用该方法查询锁信息
    var_dump(\Workbunny\WebmanSharedCache\Cache::LockInfo());
    ```
- **查看键信息**

    ```
    # 包括键的一些基础信息
    var_dump(\Workbunny\WebmanSharedCache\Cache::KeyInfo('test-key'));
    ```
- **清空cache**

    - 使用Del多参数进行清理

    ```
    # 接受多个参数
    \Workbunny\WebmanSharedCache\Cache::Del($a, $b, $c, $d);
    # 接受一个key的数组
    \Workbunny\WebmanSharedCache\Cache::Del(...$keysArray);
    ```

    - 使用Clear进行清理

    ```
    \Workbunny\WebmanSharedCache\Cache::Clear();
    ```

### 2. RateLimiter插件

[](#2-ratelimiter插件)

> 高效轻量的亲缘进程限流器

1. 在/config/plugin/workbbunny/webman-shared-cache/rate-limit.php中配置
2. 在使用的位置调用

- 当没有执行限流时，返回空数组
- 当执行但没有到达限流时，返回数组is\_limit为false
- 当执行且到达限流时，返回数组is\_limit为true

```
$rate = \Workbunny\WebmanSharedCache\RateLimiter::traffic('test');
if ($rate['is_limit'] ?? false) {
    // 限流逻辑 如可以抛出异常、返回错误信息等
    return new \support\Response(429, [
        'X-Rate-Reset' => $rate['reset'],
        'X-Rate-Limit' => $rate['limit'],
        'X-Rate-Remaining' => $rate['reset']
    ])
}
```

### 3. Cache的Channel功能

[](#3-cache的channel功能)

- Channel是一个类似Redis-stream、Redis-list、Redis-Pub/Sub的功能模块
- 一个通道可以被多个进程监听，每个进程只能监听一个相同通道（也就是对相同通道只能创建一个监听器）
- **向通道发布消息**

    - 临时消息

    ```
    # 向一个名为test的通道发送临时消息；
    # 通道没有监听器时，临时消息会被忽略，只有通道存在监听器时，该消息才会被存入通道
    Cache::ChPublish('test', '这是一个测试消息'， false);
    ```

    - 暂存消息

    ```
    # 向一个名为test的通道发送暂存消息；
    # 通道存在监听器时，该消息会被存入通道内的所有子通道
    Cache::ChPublish('test', '这是一个测试消息'， true);
    ```

    - 指定workerId

    ```
    # 指定发送消息至当前通道内workerId为1的子通道
    Cache::ChPublish('test', '这是一个测试消息'， true, 1);
    ```
- **创建通道监听器**

    - 一个进程对相同通道仅能创建一个监听器
    - 一个进程可以同时监听多个不同的通道
    - 建议workerId使用workerman的workerId进行区分

    ```
    # 向一个名为test的通道创建一个workerId为1的监听器；
    # 通道消息先进先出，当有消息时会触发回调
    Cache::ChCreateListener('test', '1', function(string $channelKey, string|int $workerId, mixed $message) {
        // TODO 你的业务逻辑
        dump($channelKey, $workerId, $message);
    });
    ```
- **移除通道监听器**

    - 移除监听器子通道及子通道内消息

    ```
    # 向一个名为test的通道创建一个workerId为1的监听器；
    # 通道移除时不会移除其他子通道消息
    Cache::ChRemoveListener('test', '1', true);
    ```

    - 移除监听器子通道，但保留子通道内消息

    ```
    # 向一个名为test的通道创建一个workerId为1的监听器；
    # 通道移除时不会移除所有子通道消息
    Cache::ChRemoveListener('test', '1', false);
    ```
- **实验性功能：信号通知**

    - 由于共享内存无法使用事件监听，所以底层使用Timer定时器进行轮询，实验性功能可以开启使用系统信号来监听数据的变化

    ```
    // 设置信号
    // 因为event等事件循环库是对标准信号的监听，所以不能使用自定实时信号SIGRTMIN ~ SIGRTMAX
    // 默认暂时使用SIGPOLL，异步IO监听信号，可能影响异步文件IO相关的触发
    Future::$signal = \SIGPOLL;
    // 开启信号监听，这时候开启的监听会触发之前的回调和通道回调，不会影响之前的回调
    Cache::channelUseSignalEnable(true)
    ```

    - 当使用的监听信号存在已注册的回调产生回调冲突时，可以手动设置回调事件共享

    ```
    // 设置信号
    // 因为event等事件循环库是对标准信号的监听，所以不能使用自定实时信号SIGRTMIN ~ SIGRTMAX
    // 默认暂时使用SIGPOLL
    Future::$signal = \SIGPOLL;
    // 假设\SIGPOLL存在一个已注册的回调，YourEventLoop::getCallback(\SIGPOLL)可以获取该事件在当前进程注册的回调响应
    // 设置回调
    Future::setSignalCallback(YourEventLoop::getCallback(\SIGPOLL));
    // 开启信号监听，这时候开启的监听会触发之前的回调和通道回调，不会影响之前的回调
    Cache::channelUseSignalEnable(true)
    ```

    > 通道信号监听维系了一个事件队列，多次触发信号时，回调只会根据事件队列是否存在事件消费标记而执行事件回调

### 其他功能具体可以参看代码注释和测试用例

[](#其他功能具体可以参看代码注释和测试用例)

###  Health Score

48

—

FairBetter than 94% of packages

Maintenance92

Actively maintained with recent releases

Popularity31

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~32 days

Recently: every ~127 days

Total

34

Last Release

39d ago

PHP version history (3 changes)0.1.0PHP ^8.1

0.4.2PHP ^8.0

0.6.2PHP >=7.4

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/22535862?v=4)[chaz6chez](/maintainers/Chaz6Chez)[@chaz6chez](https://github.com/chaz6chez)

---

Top Contributors

[![chaz6chez](https://avatars.githubusercontent.com/u/22535862?v=4)](https://github.com/chaz6chez "chaz6chez (98 commits)")

---

Tags

shared-cachewebmanworkbunny

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/workbunny-webman-shared-cache/health.svg)

```
[![Health](https://phpackages.com/badges/workbunny-webman-shared-cache/health.svg)](https://phpackages.com/packages/workbunny-webman-shared-cache)
```

###  Alternatives

[iazaran/smart-cache

Smart Cache is a caching optimization package designed to enhance the way your Laravel application handles data caching. It intelligently manages large data sets by compressing, chunking, or applying other optimization strategies to keep your application performant and efficient.

21114.2k](/packages/iazaran-smart-cache)[phpfastcache/phpssdb

PHP SSDB Driver for phpFastCache

14736.9k1](/packages/phpfastcache-phpssdb)[rapidwebltd/rw-file-cache

RW File Cache is a PHP File-based Caching Library. Its syntax is designed to closely resemble the PHP memcache extension.

15196.8k7](/packages/rapidwebltd-rw-file-cache)[yuzuru-s/redis-recommend

Wrapping Redis's sorted set APIs for specializing recommending operations.

392.9k](/packages/yuzuru-s-redis-recommend)[ichhabrecht/intcache

Turn uncachable page objects into cacheable links

193.9k](/packages/ichhabrecht-intcache)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)