# Random ## Description Random 模块用于提供随机值（random value）相关的基础能力，当前主要承载随机布尔值、随机字符串、随机数字与随机整数生成语义。 它关注的是“如何生成一类通用、可复用、语义清楚的随机值”，而不是各种标识格式校验、业务编码规则或安全承诺各异的随机机制集合。 ## For Understanding 理解 Random 模块时，应先把它放在应用边界附近。随机值通常意味着不可复现、带有环境依赖，或者会影响测试与调试行为，因此更合理的做法是把它看作边界输入的生成层，而不是让随机行为无约束地扩散到核心业务逻辑内部。 当前这个模块的核心边界比较克制：它主要处理“随机布尔值如何生成”“随机字符串如何生成”“通用随机数字如何生成”与“通用随机整数如何生成”这一类问题。也就是说，它更关心 true 概率、字符集、长度、数值区间、整数边界、结果格式和重复概率，而不再负责 UUID 这类已经具有明确标识语义的格式模型。 不适合放入本模块的能力，通常包括两类：一类是与密码学安全直接绑定、需要单独安全承诺的能力；另一类是已经形成稳定标识语义的格式模型，例如 UUID。前者应以更明确的安全语义单独建模，后者则应放入更贴近标识问题域的模块。 ## For Using 当你需要在应用或库的边界层生成随机布尔值、临时标识、关联值、会话键或其它非业务主键用途的随机值时，可以使用这个模块。它更适合被理解为“随机值生成接口”，而不是一个什么都往里塞的杂项工具箱。 从使用角度看，当前公共能力主要围绕随机布尔值、随机字符串、随机数字与随机整数生成展开。更合适的接入方式，是在边界层尽早生成这些随机值，再把得到的结果作为普通输入传给后续模块，从而避免内部逻辑直接依赖随机过程本身。 需要特别注意的是，本模块中的“随机”默认应被理解为通用应用层随机，而不是自动带有密码学强度承诺的安全随机。只要调用场景对安全性、可预测性、重复碰撞风险或跨环境一致性有更严格要求，就应先在设计上明确这些前提，而不要仅凭模块名称推断安全等级。 ## For Contributing 贡献 Random 模块时，应先确认新增能力表达的是稳定、清楚且可长期承诺的随机语义，而不是某种实现手段的直接暴露。对外公开的重点应该是“调用方需要什么随机值能力”，而不是“内部恰好如何生成这些值”。只要一个能力过度依赖当前实现细节，或者只在某个很窄的业务上下文中成立，就不适合进入这个模块。 在扩展时，应特别警惕两个方向的边界漂移。其一，不要把安全领域的问题用模糊措辞塞进来，例如把需要明确密码学承诺的能力混入通用随机工具中。其二，不要把已经形成稳定标识语义的格式模型重新拉回 Random。Random 模块应尽量保持为面向广泛调用方的随机值生成边界，而不是业务专用规则仓库。 ### JSDoc 注释格式要求 - 每个公开导出的目标（类型、函数、变量、类等）都应包含 JSDoc 注释，让人在不跳转实现的情况下就能理解用途。 - JSDoc 注释第一行应为清晰且简洁的描述，该描述优先使用中文（英文也可以）。 - 如果描述后还有其他内容，应在描述后加一个空行。 - 如果有示例，应使用 `@example` 标签，后接三重反引号代码块（不带语言标识）。 - 如果有示例，应包含多个场景，展示不同用法，尤其要覆盖常见组合方式或边界输入。 - 如果有示例，应使用注释格式说明每个场景：`// Expect: `。 - 如果有示例，应将结果赋值给 `example1`、`example2` 之类的变量，以保持示例易读。 - 如果有示例，`// Expect: ` 应该位于 `example1`、`example2` 之前，以保持示例的逻辑清晰。 - 如果有示例，应优先使用确定性示例；避免断言精确的随机输出。 - 如果函数返回结构化字符串，应展示其预期格式特征。 - 如果有参考资料，应将 `@see` 放在 `@example` 代码块之后，并用一个空行分隔。 ### 实现规范要求 - 不同程序元素之间使用一个空行分隔，保持结构清楚。这里的程序元素，通常指函数、类型、常量，以及直接服务于它们的辅助元素。 - 某程序元素独占的辅助元素与该程序元素本身视为一个整体，不要在它们之间添加空行。 - 程序元素的辅助元素应该放置在该程序元素的上方，以保持阅读时的逻辑顺序。 - 若辅助元素被多个程序元素共享，则应将其视为独立的程序元素，放在这些程序元素中第一个相关目标的上方，并与后续程序元素之间保留一个空行。 - 辅助元素也应该像其它程序元素一样，保持清晰的命名和适当的注释，以便在需要阅读实现细节时能够快速理解它们的作用和使用方式。 - 辅助元素的命名必须以前缀 `internal` 开头（或 `Internal`，大小写不敏感）。 - 辅助元素永远不要公开导出。 - 被模块内多个不同文件中的程序元素共享的辅助元素，应该放在一个单独的文件中，例如 `./src/random/internal.ts`。 - 模块内可以包含子模块。只有当某个子目录表达一个稳定、可单独理解、且可能被父模块重导出的子问题域时，才应将其视为子模块。 - 子模块包含多个文件时，应该为其单独创建子文件夹，并为其创建单独的 Barrel 文件；父模块的 Barrel 文件再重导出子模块的 Barrel 文件。 - 子模块不需要有自己的 `README.md`。 - 子模块可以有自己的 `internal.ts` 文件，多个子模块共享的辅助元素应该放在父模块的 `internal.ts` 文件中，单个子模块共享的辅助元素应该放在该子模块的 `internal.ts` 文件中。 - 对模块依赖关系的要求（通常是不循环依赖或不反向依赖）与对 DRY 的要求可能产生冲突。此时，若复用的代码数量不大，可以适当牺牲 DRY，复制粘贴并保留必要的注释说明；若复用的代码数量较大，则可以将其抽象到新的文件或子模块中，如 `common.ts`，并在需要的地方导入使用。 - 与随机相关的实现应优先围绕结果格式、边界约束与调用方可理解的失败语义组织，不要把底层算法细节直接提升为公共承诺。 ### 导出策略要求 - 保持内部辅助项和内部符号为私有，不要让外部接入依赖临时性的内部结构。 - 每个模块都应有一个用于重导出所有公共 API 的 Barrel 文件。 - Barrel 文件应命名为 `index.ts`，放在模块目录根部，并且所有公共 API 都应从该文件导出。 - 新增公共能力时，应优先检查它是否表达稳定、清楚且值得长期维护的随机语义，而不是某段实现细节的便捷暴露；仅在确认需要长期对外承诺时再加入 Barrel 导出。 ### 测试要求 - 若程序元素是函数，则只为该函数编写一个测试，如果该函数需要测试多个用例，应放在同一个测试中。 - 若程序元素是类，则至少要为该类的每一个方法编写一个测试，如果该方法需要测试多个用例，应放在同一个测试中。 - 若程序元素是类，除了为该类的每一个方法编写至少一个测试之外，还可以为该类编写任意多个测试，以覆盖该类的不同使用场景或边界情况。 - 若编写测试时需要用到辅助元素（Mock 或 Spy 等），可以在测试文件中直接定义这些辅助元素。若辅助元素较为简单，则可以直接放在每一个测试内部，优先保证每个测试的独立性，而不是追求极致 DRY；若辅助元素较为复杂或需要在多个测试中复用，则可以放在测试文件顶部，供该测试文件中的所有测试使用。 - 测试顺序应与源文件中被测试目标的原始顺序保持一致。 - 若该模块不需要测试，必须在说明文件中明确说明该模块不需要测试，并说明理由。一般来说，只有在该模块没有可执行的公共函数、只承载类型层表达，或其语义已被上层模块的测试完整覆盖且重复测试几乎不再带来额外价值时，才适合这样处理。 - 模块的单元测试文件目录是 `./tests/unit/random`，若模块包含子模块，则子模块的单元测试文件目录为 `./tests/unit/random/`。 - 对随机布尔值相关能力，应优先测试概率边界、结果类型与极端输入语义，而不要把测试建立在脆弱的统计分布断言之上。 - 对随机字符串相关能力，应优先测试长度约束、字符集边界与结果特征，而不要把测试建立在脆弱的精确随机输出之上。