SuperAPI AI 工具集

code-patterns

编程与开发

查看项目

更新于 10-15 21:35

技能介绍

用途:这是一套从实际实现教训中提炼的代码模式,核心原则是“从错误中学习,不要重复犯错”。每个模式都源自真实 bug,用于在文件 I/O、数据持久化和校验环节主动预防同类问题。

主要能力:

  1. 文件加锁(references/file-io.md):针对共享状态访问提供建议性文件锁,解决多进程写同一文件导致的数据损坏或竞态条件,采用 .lock 文件模式,含超时与陈旧锁检测。
  2. 原子写入(references/data-persistence.md):解决 writeFileSync() 写入中途崩溃损坏文件的问题,做法是先写 .tmp 再重命名为最终路径(在 POSIX 上为原子操作),Windows 下用备份模式处理。
  3. 模式校验(references/data-validation.md):在每次持久化前校验,解决工厂函数产生无效数据并落盘、引发下游问题的情况;要求在创建时和每次写入前都校验,不信任“之前已校验过”。

使用方式:按快速参考选择对应文档——共享文件访问看 file-io.md(加锁),JSON 持久化看 data-persistence.md(原子写入),工厂函数看 data-validation.md(校验输出)。实现文件 I/O 前先过一遍预防清单:是否有多进程访问该文件、写入中途崩溃会怎样、每次写入前是否校验、是否处理陈旧锁(死进程检测)。

适用场景:基于文件的状态、共享资源、数据持久化、校验层、并发访问;尤其适用于多进程或钩子访问同一文件、持久化 JSON 数据、创建工厂函数、实现保存/加载逻辑。

限制:资料未提供具体安装命令、依赖、平台支持范围与收费信息;文中仅给出模式说明与文档引用,未附完整代码示例。任务规划上建议拆分为多个小待办,并在最后增加一个复查待办以发现需修复或增强之处。