# @agendajs/redis-backend 中文文档

规范地址：https://npmcn.com/package/%40agendajs/redis-backend/

版本：3\.0\.8
npm 元数据更新时间：2026-10-31T12:58:02.926Z
中文译文更新时间：2026-11-06T02:30:35.235Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40agendajs/redis-backend
原文对照：https://npmcn.com/package/%40agendajs/redis-backend/?lang=original
项目主页：https://github.com/agenda/agenda#readme
源码仓库：https://github.com/agenda/agenda

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：146 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：2 个
- peer 依赖：agenda 6\.2\.7
- 首次发布：2026-01-26T15:53:55.942Z
- 最新版本发布：2026-10-31T12:58:02.577Z
- 近 30 天下载量：6320（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

带有 Pub/ Sub 通知支持的议程工作调度器的 Redis 后端

## 安装

```sh
npm install @agendajs/redis-backend
```

也可以使用：`pnpm add @agendajs/redis-backend`、`yarn add @agendajs/redis-backend`、`bun add @agendajs/redis-backend`

## README

# @ agendajs/ redis-后端

重写后端 [议程项目](https://github.com/agenda/agenda) pub/Sub 支持实时工作处理的工作调度器.

## 特征

-   议程任务的全部 Redis 存储后端
-   使用 Redis Pub/Sub 的实时工作通知
-   高效的工作索引与排序集
-   原子工作与WATCH/MULTI/EXEC
-   连接集合通过 `ioredis` 图书馆
-   带有完整类型定义的脚本类型支持

## 安装

```bash
npm install @agendajs/redis-backend
# or
pnpm add @agendajs/redis-backend
# or
yarn add @agendajs/redis-backend
```

## 使用量

### 基本用途

```typescript
import { Agenda } from 'agenda';
import { RedisBackend } from '@agendajs/redis-backend';

// Create agenda with Redis backend
const agenda = new Agenda({
  backend: new RedisBackend({
    connectionString: 'redis://localhost:6379'
  })
});

// Define jobs
agenda.define('send-email', async (job) => {
  const { to, subject, body } = job.attrs.data;
  await sendEmail(to, subject, body);
});

// Start processing
await agenda.start();

// Schedule jobs
await agenda.every('5 minutes', 'send-email', { to: 'user@example.com', subject: 'Hello', body: 'World' });
await agenda.schedule('in 10 minutes', 'send-email', { to: 'other@example.com', subject: 'Hi', body: 'There' });
```

### 配置选项

```typescript
import { RedisBackend } from '@agendajs/redis-backend';

const backend = new RedisBackend({
  // Redis connection string (required unless redis/redisOptions is provided)
  connectionString: 'redis://localhost:6379',

  // Or use Redis client options (creates a new client)
  redisOptions: {
    host: 'localhost',
    port: 6379,
    password: 'secret',
    db: 0
  },

  // Key prefix for all Redis keys (default: 'agenda:')
  keyPrefix: 'agenda:',

  // Channel name for Pub/Sub notifications (default: 'agenda:notifications')
  channelName: 'agenda:notifications',

  // Name to identify this Agenda instance (stored as lastModifiedBy)
  name: 'worker-1',

  // Sort order for job queries
  sort: {
    nextRunAt: 'asc',
    priority: 'desc'
  }
});
```

### 使用已有的 Redis 客户端

如果您的应用程序已经有Redis客户端,您可以直接通过. 客户会的 **没有** 当议程断开时关闭 :

```typescript
import { Redis } from 'ioredis';
import { RedisBackend } from '@agendajs/redis-backend';

// Your app's existing Redis client
const redis = new Redis('redis://localhost:6379');

const backend = new RedisBackend({ redis });

// After agenda.stop(), your Redis client is still usable
```

## 如何运作

### 存储

后端存储使用 Redis 数据结构的工作 :

-   **哈谢斯** (单位:千美元)`{prefix}job:{id}`) - 将工作数据作为密钥值对存储
-   **设定** (单位:千美元)`{prefix}jobs:all`\- 跟踪所有工作ID
-   **设定** (单位:千美元)`{prefix}jobs:by_name:{name}`) - 快速检索按名称列出的工作索引
-   **排序的集** (单位:千美元)`{prefix}jobs:by_next_run_at`) - 为高效调度,在下个运行前索引任务
-   **字符串** (单位:千美元)`{prefix}jobs:single:{name}`) - 跟踪单类型工作,用于高端操作

### 实时通知

瑞迪斯拥有内置的酒吧/分公司能力. 当一项工作被保存时,会向所有签署《议程》的事例发布通知,立即启动工作处理,而不必等待下一次投票间隔.

这意味着:

-   执行职务的延迟度较低
-   减少投票费用
-   二. 有效的跨进程协调

### 分布式锁定

后端使用 Redis WATCH/MULTI/EXEC 交易在解剖上锁定任务进行处理,防止多个"议程"实例的重复执行.

## 任务日志

RedisBackend 包含内置 `RedisJobLogger` 储存结构化的工作生命周期事件 使用Redis排序的集和散列。 伐木机是轻量级的,只在第一次使用时创建了它的键.

### 自动使用

当您在议事日程中启用日志时, 后端的内置登录器会被自动使用 :

```typescript
const agenda = new Agenda({
  backend: new RedisBackend({ connectionString: 'redis://localhost:6379' }),
  logging: true  // Uses RedisJobLogger automatically
});
```

### 独立使用

您还可以使用 `RedisJobLogger` 独立——例如,在使用不同的后端存储时登录到 Redis :

```typescript
import { RedisJobLogger } from '@agendajs/redis-backend';
import Redis from 'ioredis';

const logger = new RedisJobLogger({
  redis: new Redis('redis://localhost:6379')
});

// Use with any backend
import { MongoBackend } from '@agendajs/mongo-backend';
const agenda = new Agenda({
  backend: new MongoBackend({ mongo: db }),
  logging: logger
});
```

见 [议程项目研究](https://github.com/agenda/agenda#persistent-job-logging) 用于完整记录文件.

## 持久性

默认情况下,Redis将数据保存在内存中. 为了与《议程》一起生产,请配置Redis的持久性:

```bash
# In redis.conf
appendonly yes           # Enable AOF persistence
appendfsync everysec     # Sync to disk every second
```

或使用 RDB 快照 :

```bash
save 900 1      # Save after 900 seconds if at least 1 key changed
save 300 10     # Save after 300 seconds if at least 10 keys changed
save 60 10000   # Save after 60 seconds if at least 10000 keys changed
```

对于最大耐久性,同时启用AOF和RDB.

## 测试

测试需要一个 Redis 服务器 。 最简单的方法是使用多克:

```bash
# Start Redis container and run tests
pnpm test:docker

# Or manually:
pnpm docker:up      # Start Redis container
pnpm test           # Run tests
pnpm docker:down    # Stop container
```

您也可以使用已有的 Redis 服务器 :

```bash
REDIS_TEST_URL=redis://localhost:6379 pnpm test
```

### 可用的脚本

| 脚本 | 说明 |
| --- | --- |
| `pnpm test` | 运行测试( 需要 Redis 或 Docker) |
| `pnpm test:docker` | 开始容器,运行测试,停止容器 |
| `pnpm docker:up` | 启动 Redis 容器 |
| `pnpm docker:down` | 停止 Redis 容器 |
| `pnpm docker:logs` | 查看容器日志 |

## 所需资源

-   节点.js 18.0.0
-   雷迪丝 >= 6.0
-   议程项目6.0.0

## 许可证

麻省理工学院

## 常见问题

### @agendajs/redis-backend 是什么？

带有 Pub/ Sub 通知支持的议程工作调度器的 Redis 后端

### 如何安装 @agendajs/redis-backend？

在项目目录运行 npm install @agendajs/redis-backend，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：agenda（6\.2\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @agendajs/redis-backend 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @agendajs/redis-backend 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @agendajs/redis-backend 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @agendajs/redis-backend 可以商用吗？

@agendajs/redis-backend 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @agendajs/redis-backend 的下载量有多少？

根据 npm 官方下载统计，@agendajs/redis-backend 在 2026/10/05 – 2026/11/03 这 30 天内被下载 6,320 次，日均约 211 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @agendajs/redis-backend 还在维护吗？

最新版本 3\.0\.8 发布于 2026/10/31（7 天前）；至今共发布 12 个版本，其中过去 12 个月发布了 12 个；首次发布于 2026/01/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。