使用 `node-json-db` 创建简易本地数据库

使用 node-json-db 创建简易本地数据库

node-json-dbA simple "database" that use JSON file for Node.JS.项目地址:https://gitcode.com/gh_mirrors/no/node-json-db

本文将指导您了解并使用 node-json-db 库，这是一个轻量级的JSON数据库解决方案，适用于简单的Node.js项目。

1. 项目目录结构及介绍

典型的node-json-db项目结构可能如下：

project-root/
├── node_modules/        # 存放安装的依赖包
├── src/                 # 主体代码目录
│   └── index.js         # 项目入口文件
└── db/                  # 数据库文件存放位置
    └── database.json    # 示例数据库文件

• node_modules/: 安装的依赖包自动管理在这里。
• src/: 主要的源代码目录。
  • index.js: 项目的主入口文件，通常用于设置数据库实例和处理数据操作。
• db/: 数据库文件所在的目录，你可以存放你的 .json 数据库文件。

2. 项目启动文件介绍

src/index.js 是项目的主要入口文件，这里通常初始化 node-json-db 并进行相关的数据操作。例如：

const { JsonDB } = require('node-json-db');
const { Config } = require('node-json-db/dist/config');

// 初始化数据库，指定数据库文件和是否启用保持原始格式
const db = new JsonDB(new Config('./db/database.json', true, false));

// 使用JsonDB提供的方法进行增删改查操作

在这个例子中，./db/database.json 是数据库文件路径，true 表示启用保留原始格式，false 表示不压缩数据。

3. 项目的配置文件介绍

虽然 node-json-db 不强制使用配置文件，但可以根据需要创建一个配置对象来调整其行为。在上面的例子中，Config 对象用于指定以下参数：

• FilePath: 数据库文件的完整路径。
• PreserveJson: 若设置为 true，则保持原始的 JSON 格式，否则会尝试优化（例如，去除多余的逗号）。
• Indentation: 指定缩进空格数，当 PreserveJson 为 true 时有效。

如果您想自定义这些设置，可以在初始化 JsonDB 实例时传递一个 Config 对象。

const customConfig = new Config(
  './path/to/db/file.json',
  true, /* 是否保留原始格式 */
  2 /* 缩进空格数 */
);

const db = new JsonDB(customConfig);

至此，您已经掌握了 node-json-db 的基本配置和使用方式。在实际项目中，您可以根据需求进行更复杂的操作，如数据模型设计、路由处理等。记住，在进行数据操作前确保正确初始化数据库实例，这样就可以愉快地使用这个简单且灵活的本地数据库了。

node-json-dbA simple "database" that use JSON file for Node.JS.项目地址:https://gitcode.com/gh_mirrors/no/node-json-db