后端数据库客户端缓存【免费下载链接】node-redisRedis Node.js client项目地址https://gitcode.com/gh_mirrors/no/node-redis点击查看免费下载node-redis 是 Redis 官方的 Node.js 客户端本仓库以 npm workspaces 组织成多包monorepo结构全部代码使用 TypeScript 编写。本文以仓库根目录的 AGENTS.md即GEMINI.md/CLAUDE.md的实体内容为骨架结合packages/下的真实源码与测试系统讲解仓库的包划分、核心目录布局、命令Command开发模式、测试方法与工程规范。读完本文你将掌握在这个仓库中新增一条 Redis 命令的完整流程——从命令文件编写、注册到测试覆盖与 JSDoc 校验——并理解 RESP 编解码、key 前缀等底层机制如何与命令层协作。仓库全貌一个 TypeScript 化的 npm workspaces monoreponode-redis是一个现代 Redis 客户端modern Redis client for Node.js采用monoreponpm workspaces组织多个可独立发布的包要求运行时Node.js 20全仓使用TypeScript。根目录的 package.json 通过workspaces字段声明了 8 个工作区覆盖客户端核心、各 Redis 模块扩展与测试基础设施。各包职责一览包npm 名职责redisredis“全家桶”元包meta-package重新导出客户端与全部模块clientredis/client核心RedisClient、RedisCluster、RedisSentinel、连接池、RESP 编解码、命令框架bloomredis/bloom概率类命令bloom、cuckoo、count-min、t-digest、top-kjsonredis/jsonRedisJSON 命令searchredis/searchRediSearch 命令time-seriesredis/time-series时序Time-series命令entraidredis/entraidMicrosoft Entra ID 令牌认证test-utilsredis/test-utils共享测试工具通过 Docker 拉起真实 Redis 容器从源码结构看各模块包bloom/json/search/time-series 等都依赖redis/client并遵循与客户端一致的命令结构约定因此掌握了client包的开发模式即可迁移到任意模块包。以redis元包为例packages/redis/index.ts 将 bloom、json、ftRediSearch、tsRedisTimeSeries四类模块默认合并进RedisDefaultModules用户无需手动装配即可在createClient中直接使用这些模块命令。核心目录布局packages/client/lib 的地图redis/client的源码集中在packages/client/lib/下其目录划分直接对应客户端的不同能力域client/—— 连接内部实现index.tsRedisClient、socket.ts、commands-queue.ts、parser.ts、pool.ts、pub-sub.ts、cache.tscluster/、sentinel/—— 集群与哨兵客户端commands/—— 每条 Redis 命令一个文件如GET.ts外加index.ts注册表RESP/—— RESP2/RESP3 协议encoder.ts、decoder.ts、types.tsauthx/—— 认证与凭据提供者credentials provider这种“一命令一文件”的布局使得每个命令的实现、类型与测试天然内聚命令文件与对应的NAME.spec.ts测试同目录存放符合下文将详述的测试约定。命令模式一条命令是怎么写出来的这是本仓库最重要的开发范式。每条命令是一个NAME.ts文件默认导出一个Command对象。以最简单的GET为例packages/client/lib/commands/GET.ts 的完整实现是export default { CACHEABLE: true, IS_READ_ONLY: true, parseCommand(parser: CommandParser, key: RedisArgument) { parser.push(GET); parser.pushKey(key); }, transformReply: undefined as unknown as () BlobStringReply | NullReply } as const satisfies Command;该对象由两个核心方法与若干元数据字段组成parseCommand(parser, ...args)负责把 JS 参数翻译成 Redis 线上参数wire arguments。通过CommandParser提供的一系列方法完成push追加普通参数、pushKey追加键会自动应用 key 前缀、pushVariadic/pushVariadicWithLength/pushVariadicNumber处理可变参数、pushKeys/pushKeysLength批量追加键。接口定义见 packages/client/lib/client/parser.ts。transformReply把 Redis 回复映射为 JS 类型值为undefined表示透传pass-through即回复原样返回。它还可以按 RESP 协议版本拆分写成{ 2: ..., 3: ... }的形式针对 RESP2/RESP3 分别转换。元数据字段如CACHEABLE、IS_READ_ONLY等供客户端命令元数据体系command-metadata/在路由策略、缓存决策时读取。CommandParser参数构建与 key 前缀机制parser.ts 中的CommandParser接口不仅是参数容器还承载了 key 前缀逻辑pushKey(key, applyPrefix?)会把客户端配置的keyPrefix前置到键上若需要跳过前缀——例如SPUBLISH的分片 Pub/Sub 路由键——则传applyPrefix false。其热路径实现prefixKeyparser.ts#L11-L22在无前缀时直接返回原键字符串拼接与Buffer.concat两条路径分别优化了字符串键与 Buffer 键的性能。少数在parseCommand之外构建参数的命令如WATCH则借助prefixKeys辅助函数保证仍遵守keyPrefix配置。复杂命令的多样性参数HSET 与 MSET并非所有命令都像GET一样只有单一参数形态。以 HSET.ts 为例它通过联合类型声明了两种调用形式单字段(key, field, value)与多字段(key, object | Map | 元组数组)parseCommand内部分派到pushMap/pushTuples/pushObject三个辅助函数分别处理Map、数组元组与普通对象的扁平化。数字字段值会经convertValue转为字符串HSET.ts#L70-L74。同样地MSET.ts 的parseMSetArguments兼容三种入参形态二元组数组、扁平数组和Recordstring, value对象并在空数组时显式抛出错误避免生成非法协议数据。注册新命令写完NAME.ts后必须在所属包的commands/index.ts注册先import该命令再在映射表中添加条目导入 map entry 两步。该文件是命令注册表也是类型推导的枢纽——redis/client的commands/index.ts有数千行按字母序罗列了从ACL_CAT到ZUNIONSTORE等数百条命令的实现与导出。只有完成注册命令才会出现在客户端类型上并被createClient暴露同时以原始命令名GET与驼峰别名get两种形式暴露见下文“命名约定”。RESP3 是默认协议本仓库默认使用RESP3协议——这是redis元包与redis/client各构造函数的默认RESP类型参数见 packages/redis/index.ts 中RESP extends RespVersions 3。因此新增命令默认即支持 RESP3无需额外编写 RESP3 测试仅当命令需要针对 RESP2 做差异转换时才需要补充对应测试与transformReply版本分支。测试体系同文件、双拓扑、真实容器仓库的测试约定是在源码旁边放置同名NAME.spec.ts使用Mocha tsx运行断言库为 Node 内置的node:assert。两种测试形态纯参数/回复单元测试不连接 Redis直接用parseArgs(COMMAND, ...args)断言命令生成的协议参数。以 GET.spec.ts 为例it(transformArguments, () { assert.deepEqual( parseArgs(GET, key), [GET, key] ); });集成测试通过testUtils.testAll(name, fn, { client, cluster })注册同一份测试函数会在「单机 server」与「cluster 集群」两种拓扑下各跑一遍。GLOBAL.SERVERS.OPEN与GLOBAL.CLUSTERS.OPEN分别指定两种拓扑的开放实例GET.spec.ts#L14-L22testUtils.testAll(get, async client { assert.equal(await client.get(key), null); }, { client: GLOBAL.SERVERS.OPEN, cluster: GLOBAL.CLUSTERS.OPEN });test-utils的封装见 packages/client/lib/test-utils.ts它聚合了redis/test-utils的默认工具、GLOBAL拓扑常量以及defineScriptLua 脚本封装等共享辅助。运行测试与构建Docker 是硬性前提redis/test-utils会启动真实的 Redis 容器因此本地跑完整测试必须先具备 Docker 环境。npm test—— 全量测试所有 workspace先执行cleanup清理 junit 结果。npm test -w redis/client—— 只测单个包。从仓库根目录跑单文件npm run test-single -- path-to-spec。npm run build——tsc --build基于 TypeScript project references跨包开发前必须先构建。构建可能因 project references 残留的过期dist/而失败此时需要干净重建find packages -type d -name dist -exec rm -rf {} npm run buildnpm run lint—— 只 lint 变更过的文件npm run lint:all—— 检查全部文件。工程规范与开发约定TypeScript 严格模式开启noUnusedLocals编译目标ES2022 / NodeNext 模块体系见根目录 tsconfig.base.json 及各包 tsconfig。命名约定原始命令名HSET与驼峰别名hSet同时暴露兼顾 Redis 原生习惯与 JS 风格。提交规范使用Conventional Commits各包通过release-it独立发版npm run release。合规红线公司内部引用Jira/Confluence 编号、内网链接不得进入开源提交、分支、PR 与代码。JSDoc 强制检查命令上的 JSDoc 会被npm run check:command-jsdoc由 scripts/check-command-jsdoc.ts 实现校验新增命令必须补齐注释。文档与示例生态仓库在docs/下提供了体系化的深入指南覆盖客户端配置、集群、哨兵、连接池、RESP 协议、事务、编程能力Lua/函数、Pub/Sub、扫描迭代器以及 v3→v4、v4→v5、v5→v6 的迁移手册例如客户端配置指南集群指南 与 哨兵指南连接池指南RESP 协议说明事务指南 与 编程能力指南可运行的示例位于 examples/含 Pub/Sub、流、搜索、布隆过滤器、事务等场景与doctests/命令级可执行文档测试。对于新加入的 Agent建议先通读本文梳理的命令模式再结合docs/中与任务相关的专题指南最后用examples/验证客户端行为。给 Agent 的快速行动清单在 node-redis 仓库中新增或修改命令时按以下顺序操作可避免绝大多数返工在所属包的lib/commands/下创建NAME.ts实现parseCommand与transformReply默认undefined透传并补全 JSDoc。在lib/commands/index.ts中 import 并注册该命令。同目录创建NAME.spec.ts先用parseArgs覆盖参数构建再用testUtils.testAll覆盖双拓扑集成行为。本地跑npm run test-single -- packages/client/lib/commands/NAME.spec.ts需 Docker 提供 Redis 容器。通过npm run check:command-jsdoc与npm run lint:changed校验规范。修改涉及多包依赖时先npm run build必要时按上文命令干净重建dist/。这套“命令文件 → 注册表 → 双拓扑测试 → JSDoc/lint 门禁”的流水线是 node-redis 保持数百条命令类型安全、协议正确与跨拓扑行为一致的关键机制也是任何 AI Agent 或人类开发者进入本仓库的必修课。赞分享后端数据库客户端缓存【免费下载链接】node-redisRedis Node.js client项目地址https://gitcode.com/gh_mirrors/no/node-redis点击查看免费下载相关推荐Mealie 开发指南面向 AI Agent 的仓库架构、开发命令与协作规范Mealie 开发指南面向 AI Agent 的仓库架构、开发命令与协作规范 本文基于仓库根目录的 AGENTS.md https://link.gitcod后端前端ModelScope 本地部署快速上手从克隆到出结果的实操路线ModelScope 本地部署快速上手从克隆到出结果的实操路线 ModelScope 本地部署后你能在自己的机器上直接调用平台上的预训练模型做推理数据不用人工智能大模型模型推理服务微调模型评测预训练机器学习深度学习vux 实战基于 vue-router 与 Vuex 实现页面切换 Loading 加载提示vux 实战基于 vue router 与 Vuex 实现页面切换 Loading 加载提示 移动端单页应用一旦采用异步组件按需加载页面切换时就必然存在一段UI组件前端上一篇终极Windows ADB驱动解决方案3分钟搞定所有Android设备连接问题下一篇TVBoxOSC电视盒子播放器让落灰的旧盒子重新看直播追剧创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考