一次编写Node和浏览器通吃NeDB存储抽象层设计解析与localforage实战【免费下载链接】nedbThe JavaScript Database, for Node.js, nw.js, electron and the browser项目地址: https://gitcode.com/gh_mirrors/ne/nedbNeDB 是一款纯 JavaScript 编写的嵌入式数据库支持 Node.js、nw.js、Electron 和浏览器环境API 兼容 MongoDB 子集。它的核心魅力在于同一套文档数据库代码在 Node 里落到文件在浏览器里落到 localforage——这一切都归功于其精巧的存储抽象层设计。本文带你拆解这套跨端存储机制并看看 localforage 是如何被驯服的。一、什么是 NeDB一份数据两端运行NeDBNode Embedded DataBase是一个文件型的嵌入式数据库一个 Datastore 相当于一个 MongoDB 集合。你可以把它想象成一个装在应用里的 MongoDB✅ 100% JavaScript无二进制依赖跨平台✅ Node 端数据持久化到本地文件浏览器端持久化到浏览器存储✅ 服务端与浏览器端API 完全一致insert/find/update/remove✅ 支持索引、唯一约束性能充足入口非常简洁index.js 只做了两行事var Datastore require(./lib/datastore); module.exports Datastore;真正的跨端魔法藏在Datastore底层的持久化链路里。二、存储抽象层一张统一存储接口表NeDB 的核心模块 lib/persistence.js 负责所有持久化任务而它从不直接碰文件系统而是调用一个storage对象。这个对象对外暴露一套与文件操作语义一致的接口接口方法语义Node 端实现浏览器端实现exists文件是否存在fs.existslocalforage.getItem判空readFile读取内容fs.readFilelocalforage.getItemwriteFile写入内容fs.writeFilelocalforage.setItemappendFile追加内容fs.appendFile读出→拼接→写回rename重命名fs.rename读旧→写新→删旧unlink删除fs.unlinklocalforage.removeItemmkdirp确保目录存在mkdirp空操作浏览器无目录crashSafeWriteFile崩溃安全写临时文件重命名fsync退化为普通writeFile这就是依赖倒置的教科书案例上层逻辑lib/persistence.js、lib/datastore.js只依赖抽象不依赖具体。换存储引擎上层一行不改。两个实现文件Node 版lib/storage.js —— 基于fs、mkdirp外加崩溃安全读写函数浏览器版browser-version/browser-specific/lib/storage.js —— 基于 localforage按浏览器能力自动选择 IndexedDB → WebSQL → localStorage三、Node 端精华崩溃安全写入是怎么做到的lib/storage.js 中的crashSafeWriteFile实现了完整的崩溃防护流程刷目录与旧文件缓冲fsync父目录和已有数据文件把新数据写入临时文件filename~再次 fsync 临时文件确保数据真正落盘rename原子替换重命名操作是原子的不会出现半截文件最后再刷一次父目录配套的ensureDatafileIntegrity函数会在启动时检查如果只发现临时文件而没有正式文件说明上次写失败了于是回滚到旧版本。这样即使进程在写入过程中被杀数据库文件也不会损坏。 这也是为什么文件名不能以~结尾——这个后缀被保留给崩溃安全备份文件了。四、浏览器端实战localforage 如何接入 NeDB浏览器没有文件系统NeDB 的解法是让 localforage 充当虚拟文件系统。打开 browser-version/browser-specific/lib/storage.js可以看到非常有趣的语义翻译localforage.config({ name: NeDB, storeName: nedbdata }); // 重命名文件 读出旧值 → 写入新键 → 删除旧键 function rename (filename, newFilename, callback) { localforage.getItem(filename, function (err, value) { if (value null) { localforage.removeItem(newFilename, function () { return callback(); }); } else { localforage.setItem(newFilename, value, function () { localforage.removeItem(filename, function () { return callback(); }); }); } }); }几个设计取舍值得注意appendFile的实现是读-拼-写因为 localforage 的键值模型没有追加概念mkdirp和ensureDatafileIntegrity直接空转——浏览器里既没有目录也不会出现写一半断电crashSafeWriteFile直接别名到writeFile——浏览器存储引擎本身具备事务性无需临时文件方案五、自动切换的秘密package.json 的 browser 字段为什么一份代码能零配置跑在两端答案在 package.json 中browser: { ./lib/customUtils.js: ./browser-version/browser-specific/lib/customUtils.js, ./lib/storage.js: ./browser-version/browser-specific/lib/storage.js }打包器webpack、browserify 等在处理浏览器构建时会把require(./lib/storage)自动替换为浏览器版实现。Node 运行时则完全无视这个字段走原生fs。上层代码写的是同一句require拿到的却是两个不同的存储引擎——这就是一次编写两端通吃的机制内核。同样的替换也发生在 lib/customUtils.js 上Node 端用crypto.randomBytes生成文档_id浏览器端browser-version/browser-specific/lib/customUtils.js则用Math.random 自定义 base64 完成同样的事。六、浏览器端快速上手在 HTML 中引入构建产物后全局对象Nedb立即可用API 与服务端一模一样script srcnedb.min.js/script script var db new Nedb(); // 纯内存模式 var db2 new Nedb({ filename: myData }); // 持久化模式 /script指定filename后NeDB 会自动挑选当前浏览器最佳的存储后端优先 IndexedDB其次 WebSQL兜底 localStorage大多数浏览器下可存储数百 MB 数据。⚠️重要提醒NeDB 在 v1.3 到 v1.4 之间更换了底层存储系统两者不兼容升级后客户端需要重新同步数据。七、给新手的 5 条实战建议 浏览器端给new Nedb(...)传filename才会持久化否则数据只活在内存里 Node 端数据文件是追加式日志每次loadDatabase时自动压缩无需手动维护 需要加密落盘时使用afterSerialization/beforeDeserialization钩子但两者必须成对出现NeDB 会自检防止数据丢失 高频查询字段记得ensureIndex万级文档下索引创建仅需约 35ms 浏览器兼容范围Chrome、Safari、Firefox、IE9测试用例在 browser-version/test/ 目录总结NeDB 的存储抽象层是面向接口编程的优秀范例lib/storage.js 与 browser-version/browser-specific/lib/storage.js 实现同一套接口分别对接文件系统和 localforageNode 端通过临时文件 原子重命名 fsync实现崩溃安全浏览器端借助 localforage 自动适配 IndexedDB / WebSQL / localStoragepackage.json的browser字段让打包器一键完成换引擎掌握这套模式后你自己写跨端应用时也完全可以复刻抽象接口 双端实现 构建时替换的架构真正做到一次编写、Node 与浏览器通吃。【免费下载链接】nedbThe JavaScript Database, for Node.js, nw.js, electron and the browser项目地址: https://gitcode.com/gh_mirrors/ne/nedb创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
