PHPackages                             lit/redis-ext - 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. lit/redis-ext

ActiveLibrary[Caching](/categories/caching)

lit/redis-ext
=============

Redis的扩展使用

0.0.15(2y ago)29.9k↓40%PHPPHP >=5.6.0

Since Feb 4Pushed 2y ago1 watchersCompare

[ Source](https://github.com/ghostong/LitRedisExt)[ Packagist](https://packagist.org/packages/lit/redis-ext)[ RSS](/packages/lit-redis-ext/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (13)Used By (0)

RedisExt
========

[](#redisext)

通过redis实现一些常用功能

安装
--

[](#安装)

```
composer require lit/redis-ext

```

初始化Redis
--------

[](#初始化redis)

也可以使项目中已初始化好的redisHandler

```
//连接redis
$redisHandler = new \Redis();
$redisHandler->connect("192.168.1.163");
```

循环计数器
-----

[](#循环计数器)

### 场景说明

[](#场景说明)

```
某些情况下, 我们需要知道周期内某些行为执行了多少次, 但是又不需要把它长久保存下来.
例如:
    1. 欢迎您: 2021年1月1日第 x 位访问者.
    2. 判断周期内执行过多少次,下一周期自动重置.
    3. 整点限流器.

```

### 示例

[](#示例)

#### 初始化

[](#初始化)

```
//初始化计数器
Lit\RedisExt\LoopCounter::init($redisHandler);
```

#### 1. 分钟计数器

[](#1-分钟计数器)

```
/**
 * 分钟计数器: 实现每分钟5次限流器
 * 参数1 计数器redis key 可以根据使用维度自行设置
 * 参数2 计数器生命周期, 单位: 分钟
 * 参数3 是否完整分钟, true:完整的 x 分钟, false:从第一次计数开始 x 分钟)
 * 参数4 每次增加数量
 * */
if( Lit\RedisExt\LoopCounter::everyMinutes("test1", 1, false, 1) > 5 ) {
    //超限流
}else{
    //未超限流
}
```

#### 2. 小时计数器

[](#2-小时计数器)

```
/**
 * 小时计数器: 实现记录2小时之内第几次访问
 * 参数1 计数器redis key 可以根据使用维度自行设置
 * 参数2 计数器生命周期, 单位: 小时
 * 参数3 是否完整分钟, true:完整的 x 小时 false:从第一次计数开始 x 小时)
 * 参数4 每次增加数量
 * */
var_dump(Lit\RedisExt\LoopCounter::everyHours("test2", 2, true, 1));
```

#### 3. 日期计数器

[](#3-日期计数器)

```
//日期计数器 从当前开始3天
var_dump(Lit\RedisExt\LoopCounter::everyDays("test3", 3, false, 1));
```

#### 4. 自定义计数器

[](#4-自定义计数器)

```
//指定时间计数器 指定某时间过期
var_dump(Lit\RedisExt\LoopCounter::nextRoundAt("test4", time() + 3600 * 7));
```

#### 5. 其他操作

[](#5-其他操作)

```
//销毁一个计数器
var_dump(Lit\RedisExt\LoopCounter::destroy("test3"));

//获取一个计数器数值
var_dump(Lit\RedisExt\LoopCounter::get("test4"));
```

固定集合
----

[](#固定集合)

### 场景说明

[](#场景说明-1)

```
某些情况下, 我们需要记录固定条数的数据
例如:
    1. 最后充值的 x 位用户.
    2. 最后 x 位访客.
    3. 最新 x 条动态.

```

### 示例

[](#示例-1)

#### 初始化

[](#初始化-1)

```
//初始化固定集合
Lit\RedisExt\CappedCollections::init($redisHandler);
```

#### 1. 固定集合写入数据

[](#1-固定集合写入数据)

```
/**
 * 参数1 固定集合的key
 * 参数2 要记录的数据
 * 参数3 固定集合限制条数
 * */
var_dump(Lit\RedisExt\CappedCollections::set("cappedKey", uniqid(), 20));
```

#### 2. 获取固定集合数据条数

[](#2-获取固定集合数据条数)

```
/**
 * 参数1 固定集合的key
 * */
var_dump(Lit\RedisExt\CappedCollections::size("cappedKey"));
```

#### 3. 获取固定集合数据

[](#3-获取固定集合数据)

注意: 此方法在并发量大的时候,会造成翻页获取数据不准确.

```
/**
 * 参数1 固定集合的key
 * 参数2 偏移量
 * 参数3 获取数据条数限制
 * */
var_dump(Lit\RedisExt\CappedCollections::get("cappedKey", 15, 5));
```

#### 4. 销毁固定集合

[](#4-销毁固定集合)

```
/**
 * 参数1 固定集合的key
 * */
var_dump(Lit\RedisExt\CappedCollections::destroy("cappedKey"));
```

循环限流器
-----

[](#循环限流器)

### 特别提示

[](#特别提示)

```
此类使用 lua 脚本, 可能存在不兼容

```

### 场景说明

[](#场景说明-2)

```
假设我们某个程序需要限流 '相对周期内' 只能访问5次.
也就是说:
    1) 第 1,2,3,4,5 次没有限制.
    2) 第6次与第1次的间隔要大于等于1分种.
    3) 第7次与第2次的间隔要大于等于1分种.
    4) 如果周期内不访问, 过期的 3,4,5 将不会限制 8,9,10 的访问. 依次类推
    循环限流器可以保证, 第一次访问和下一次解除限制之间的时间是完整的相对周期.
举个例子:
    运输公司的卡车数量不限, 但是只有5个集装箱, 每个集装箱的单次使用周期是1天, 到期后准时归还.
    假设所有卡车都遵循此规则, 集装箱的流转过程就是循环限流器要实现的场景.
    卡车能拿到集装箱, 说明不限流, 拿不到说明限流. 我们要做的只是调整集装箱的数量.

```

### 示例

[](#示例-2)

#### 初始化

[](#初始化-2)

```
//初始化限流器
Lit\RedisExt\LoopThrottle::init($redisHandler);
```

#### 1. 访问并增加访问次数

[](#1-访问并增加访问次数)

```
/**
 * 参数1 限流器key
 * 参数2 限流次数
 * 参数2 限流周期
 * 返回 true: 可以访问, false: 被限流
 * */
var_dump(Lit\RedisExt\LoopThrottle::attempt("tKey1", 2, 10));
```

#### 2. 查询限流

[](#2-查询限流)

```
/**
 * 参数1 限流器key
 * 参数2 限流周期
 * 返回 周期内有效访问次数
 * */
var_dump(Lit\RedisExt\LoopThrottle::count("tKey1", 300));
```

#### 3. 销毁限流器

[](#3-销毁限流器)

```
/**
 * 参数1 限流器key
 * */
var_dump(Lit\RedisExt\LoopThrottle::destroy("tKey1"));
```

异步调用方法
------

[](#异步调用方法)

### 场景说明

[](#场景说明-3)

```
接口要执行很长一段时间的逻辑, 由于很轻量化, 不想再使用消息队列.可以试一下异步调用方法.
此方法需要启动一个定时任务或者守护进程.

```

### 示例

[](#示例-3)

#### 初始化链接

[](#初始化链接)

```
/**
 * 参数1: $redisHandler redis链接句柄
 * 参数2: int $collectionsLength 内置固定集合长度, 用于保存执行历史
 */
\Lit\RedisExt\AsyncMethod::init($redisHandler, 50);
```

#### 1. 增加一个异步调用

[](#1-增加一个异步调用)

```
/**
 * 参数1: 固定的RedisKey
 * 参数2: 被实例化的对象
 * 参数3: 要执行的方法名称
 * 参数4: 调用的所有参数 (注意,此参数会在执行是增加一个 _uniqId 下标的唯一ID,供使用者对进程进行监控, 详见demo)
 * 返回值: string 唯一的进程ID _uniqId
 */
\Lit\RedisExt\AsyncMethod::add("testKey", new \Demo\DemoClass(), 'staticClass', ["a" => 1, "b" => 3]);
```

#### 2. 执行一条异步调用

[](#2-执行一条异步调用)

```
/**
 * 参数1: 固定的RedisKey
 * 返回值: array
 *      callable: 函数调用信息
 *      return: 异步方法返回值
 */
\Lit\RedisExt\AsyncMethod::run("testKey");
```

#### 3. 获取一个任务的运行状态

[](#3-获取一个任务的运行状态)

```
/**
 * 参数1: add 方法返回的唯一进程ID
 * 返回值: int|false
 *     int 进程状态码
 *     false 未找到记录
 * 附进程状态码:
 *    -1 失败
 *     0 等待中
 *     1 运行中
 *     2 成功
 */
var_dump(\Lit\RedisExt\AsyncMethod::getStatus("t-632ad7f381214"));
```

#### 4. 获取任务列表

[](#4-获取任务列表)

```
/**
 * 参数1: 指定一个RedisKey, 同 add 方法一致
 * 参数2: 列表分页 索引
 * 参数3: 列表分页 显示条数
 * 返回值: array 列表数据
 *    data: 数据
 *    nextIndex: 下一页索引开始
 *    count: 总条数
 */
var_dump(\Lit\RedisExt\AsyncMethod::getList("testKey",0 , 10));
```

独占锁
---

[](#独占锁)

### 示例

[](#示例-4)

#### 初始化链接

[](#初始化链接-1)

```
\Lit\RedisExt\XLocks::init($redisHandler);
```

#### 1. 获取锁

[](#1-获取锁)

```
/**
 * 参数1: 锁的RedisKey
 * 参数2: 自动解锁时间(秒). 0为不自动解锁
 * 参数3: 使用完成后自动解锁(忽略自动解锁时间)
 * 返回值: bool true拿到锁, false未拿到锁
 */
var_dump(\Lit\RedisExt\XLocks::lock("testa", 20, true));
```

#### 2. 解锁

[](#2-解锁)

```
/**
 * 参数1: 锁的RedisKey
 * 返回值: bool true已解锁, false解锁失败或未上锁
 */
var_dump(\Lit\RedisExt\XLocks::unLock("testa"));
```

#### 3. 获取锁生命周期

[](#3-获取锁生命周期)

```
/**
 * 参数1: 锁的RedisKey
 * 返回值: int 锁的生命周期
 */
var_dump(\Lit\RedisExt\XLocks::ttl("testa"));
```

Redis 字符串缓存
-----------

[](#redis-字符串缓存)

### 示例

[](#示例-5)

#### 初始化链接

[](#初始化链接-2)

```
\Lit\RedisExt\CacheSup::init($redisHandler);
```

#### 1. 获取缓存数据

[](#1-获取缓存数据)

```
$version = "1.0.0";
var_dump(\Lit\RedisExt\CacheSup::get("tmpKey:0", $version));
//NULL
// 或者
//array(2) {
//  [0]=>
//  string(19) "tmp:1:64586e4405fa5"
//  [1]=>
//  string(19) "tmp:2:64586e4406026"
//}
```

#### 2. 写入缓存数据

[](#2-写入缓存数据)

```
$version = "1.0.0";
var_dump(\Lit\RedisExt\CacheSup::set("tmpKey:0", ["tmp:1:" . uniqid(), "tmp:2:" . uniqid()], $version, 30));
//bool(true)
```

#### 3. 获取缓存数据,不存在时则通过回调函数初始化

[](#3-获取缓存数据不存在时则通过回调函数初始化)

```
$version = "1.0.0";
$keyObject = new CacheStringKey("tmpKey:0:0", [1, 1]);
$data = \Lit\RedisExt\CacheSup::getOrSet($keyObject, function ($id1, $id2) {
    return $id1 . ":" . $id2 . ":" . uniqid();
}, $version, 30);
```

#### 4. 批量获取缓存数据

[](#4-批量获取缓存数据)

```
$version = "1.0.0";
var_dump(\Lit\RedisExt\CacheSup::mGet(["tmpKey:1", "tmpKey:2", "tmpKey:3"], $version));
//array(3) {
//  ["tmpKey:1"]=>
//  NULL
//  ["tmpKey:2"]=>
//  NULL
//  ["tmpKey:3"]=>
//  NULL
//}
//或者
//array(3) {
//  ["tmpKey:1"]=>
//  string(19) "tmp:1:64586e4407117"
//  ["tmpKey:2"]=>
//  string(19) "tmp:2:64586e4407140"
//  ["tmpKey:3"]=>
//  string(19) "tmp:3:64586e4407145"
//}
```

#### 5. 批量写入缓存数据

[](#5-批量写入缓存数据)

```
$version = "1.0.0";
$cacheData = ["tmpKey:1" => "tmp:1:" . uniqid(), "tmpKey:2" => "tmp:2:" . uniqid(), "tmpKey:3" => "tmp:3:" . uniqid()];
var_dump(\Lit\RedisExt\CacheSup::mSet($cacheData, $version, 30));
//bool(true)
```

#### 6. 批量获取缓存数据,不存在时则通过回调函数初始化

[](#6-批量获取缓存数据不存在时则通过回调函数初始化)

```
$version = "1.0.0";
$keyObjects = [
    new CacheStringKey("tmpKey:1:1", [1, 1]),
    new CacheStringKey("tmpKey:2:2", [2, 2]),
    new CacheStringKey("tmpKey:3:3", [3, 3])
];
$data = \Lit\RedisExt\CacheSup::mGetOrSet($keyObjects, function ($id1, $id2) {
    return $id1 . ":" . $id2 . ":" . uniqid();
}, $version, 30);
var_dump($data);
//array(3) {
//  ["tmpKey:1:1"]=>
//  string(17) "1:1:64586db82eded"
//  ["tmpKey:2:2"]=>
//  string(17) "2:2:64586db82ee35"
//  ["tmpKey:3:3"]=>
//  string(17) "3:3:64586db82ee3a"
//}
```

信息整合器
-----

[](#信息整合器)

```
见 示例

```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity26

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 97.4% 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 ~93 days

Recently: every ~126 days

Total

12

Last Release

906d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/46be0247284f1f1256accab2ccdb4900e568f6df746a9dc96bf7d6fdfd614d0d?d=identicon)[litong](/maintainers/litong)

---

Top Contributors

[![ghostong](https://avatars.githubusercontent.com/u/5644948?v=4)](https://github.com/ghostong "ghostong (37 commits)")[![panghaoran](https://avatars.githubusercontent.com/u/29667930?v=4)](https://github.com/panghaoran "panghaoran (1 commits)")

---

Tags

rediscounter

### Embed Badge

![Health badge](/badges/lit-redis-ext/health.svg)

```
[![Health](https://phpackages.com/badges/lit-redis-ext/health.svg)](https://phpackages.com/packages/lit-redis-ext)
```

###  Alternatives

[predis/predis

A flexible and feature-complete Redis/Valkey client for PHP.

7.8k305.7M2.4k](/packages/predis-predis)[snc/redis-bundle

A Redis bundle for Symfony

1.0k39.4M67](/packages/snc-redis-bundle)[awssat/laravel-visits

Laravel Redis visits counter for Eloquent models

975163.6k2](/packages/awssat-laravel-visits)[clue/redis-protocol

A streaming Redis protocol (RESP) parser and serializer written in pure PHP.

5211.0M13](/packages/clue-redis-protocol)[cache/redis-adapter

A PSR-6 cache implementation using Redis (PhpRedis). This implementation supports tags

523.9M27](/packages/cache-redis-adapter)[rtcamp/nginx-helper

Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also provides cloudflare edge cache purging with Cache-Tags.

23517.0k1](/packages/rtcamp-nginx-helper)

PHPackages © 2026

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