# @themost/redis 中文文档

规范地址：https://npmcn.com/package/%40themost/redis/

版本：5\.4\.0
npm 元数据更新时间：2026-11-02T15:32:52.873Z
中文译文更新时间：2026-11-02T16:39:50.660Z
软件包许可：BSD-3-Clause

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

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

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

- 包体积（解压后）：13.8 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12
- 运行依赖：2 个
- peer 依赖：@themost/common ^2
- 首次发布：2019-08-26T20:10:37.669Z
- 最新版本发布：2026-11-02T15:32:52.689Z
- 已发布版本数：12（近 12 个月 2 个）

## 中文简介

大多数Web框架Redis缓存模块

## 安装

```sh
npm install @themost/redis
```

也可以使用：`pnpm add @themost/redis`、`yarn add @themost/redis`、`bun add @themost/redis`

## README

# @themost /复述,

大多数Web框架Redis缓存模块

`@themost/redis` 的用法。 [复述,](https://redis.io/) 作为缓存策略a [大多数Web框架](https://github.com/themost-framework) 应用程序。

## 安装

```bash
npm i @themost/redis
```

## 配置

添加 `settings/redis` 配置部分。

```json
    {
        "settings": {
            "redis": {
                "options": {
                    "host": "127.0.0.1",
                    "port": 6379
                },
                "pool": {
                    "min": 2,
                    "max": 25
                }
            }
        }
    }
```

一节`redis/options` 包含配置与Redis服务器连接的选项。

阅读更多关于连接选项 [ioredis](https://github.com/redis/ioredis#connect-to-redis)

### 连接池

`@themost/redis` 使用 [generic-pool](https://github.com/coopernurse/node-pool) 用于连接池。 配置 `redis/pool` 节设置要使用的最小和最大连接数。

阅读连接池选项 [generic-pool](https://github.com/coopernurse/node-pool#documentation)

## 使用

配置要使用的应用服务 `RedisCacheStrategy` 作为缓存服务。

```json
{
    "services": [
        {
            "serviceType": "@themost/data#DataCacheStrategy",
            "strategyType": "@themost/redis#RedisCacheStrategy"
        }
    ]
}
```

## 常见问题

### @themost/redis 是什么？

大多数Web框架Redis缓存模块

### 如何安装 @themost/redis？

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

### @themost/redis 支持 TypeScript 吗？

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

### @themost/redis 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

### @themost/redis 可以商用吗？

@themost/redis 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @themost/redis 还在维护吗？

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