更轻量级的本地文件数据库 lowDB 实现 CRUD (JSON 文本读写, 支持 Node, Electron and the browser)

一分钟入门

lowdb 是一个基于 Lodash 的小型本地 JSON 数据库。神器!

  • 可以语义化较强的查询/操作方法,对指定的文本文件或者浏览器 LocalStorage 内容进行精确的查询读写操作
  • 基于 Lodash, 支持大量的处理方法
  • 支持 JSON 格式文本及任意可被转换为 JSON 结构的文本数据 (xml/yaml/toml/ini)

具体使用请参照 Github: https://github.com/typicode/lowdb

数据内容

{
  "posts": [
    { "id": 1, "title": "lowdb is awesome" },
    { "id": 2, "title": "sooooooo good" }
  ],
  "user": {
    "name": "typicode"
  },
  "count": 1
}

常用操作

// Node.js
// npm install lowdb
const low = require('lowdb')
const FileSync = require('lowdb/adapters/FileSync')

const adapter = new FileSync('db.json')
const db = low(adapter)

// Add a post
db.get('posts')
  .push({ id: 1, title: 'lowdb is awesome'})
  .write()

// Set a user using Lodash shorthand syntax
db.set('user.name', 'typicode')
  .write()
  
// Increment count
db.update('count', n => n + 1)
  .write()

// Sort the top five posts.
db.get('posts')
  .filter({published: true})
  .sortBy('views')
  .take(5)
  .value()


// Get post titles.
db.get('posts')
  .map('title')
  .value()

// Get the number of posts.
db.get('posts')
  .size()
  .value()

自定义 serialize/deserialize 函数支持更多格式

const adapter = new FileSync('array.xml', {
  defaultValue: [],
  serialize: (array) => toXMLString(array),
  deserialize: (string) => fromXMLString(string)
})

使用场景

之前使用 JavaScript 写过很多小工具,包括文件格式转换,简单数据处理,文档生成,代码生成等等。

这种轻量级的处理场景下本地数据存储简直是刚需,在 Node 环境中我通常使用 JSON 文件来进行存储,以下是某产品文档中的一则 FAQ JSON 格式数据示例,生成文档的时候我需要指定 category 提取相应的信息,指定 rank 来进行文档排序:

{
  "faq": [
    {
      "title": "EMQ X中ssl resumption session的使用",
      "category": "使用教程",
      "tag": ["TLS"],
      "content": "修改emqx.conf配置中的 reuse_sessions = on 并生效后。",
      "rank": 0
    },
    {
      "title": "MQTT 客户端断开连接统计",
      "category": "运维管理",
      "tag": ["指标"],
      "content": "执行 `emqx_ctl listeners`,查看对应端口下的 `shutdown_count` 统计。",
      "rank": 100
    },
    {
      "title": "EMQ X 的百万连接压力测试的场景是什么?",
      "category": "运维管理",
      "tag": ["性能测试"],
      "content": "在EMQ 2.0版本发布的时候,由第三方软件测试工具服务提供商 [XMeter](https://www.xmeter.net) 执行了一次百万级别连接的性能测试。...",
      "rank": 98
    }
  ]
}

使用前

很长一段时间里我在 Node.js 中采用 JavaScript 的数组查找、过滤和排序来完成数据筛选,在数据变更之后使用写文件的方式再次写入磁盘。

const { faq } = require('./datasource.json')

// 过滤
const deployFAQ = faq.filter($ => $.category === '运维管理')

// 以下还有排序代码...

基于如此复杂且不清晰的操作流,我多次思考纠结我是否需要一个数据库来处理这部分业务,哪怕是 SQLite 都行,但是引入数据库后我又不得不再开发一个 Admin 界面来进行增删查改。

使用后

const low = require('lowdb')
const FileSync = require('lowdb/adapters/FileSync')

const adapter = new FileSync('db.json')
const db = low(adapter)

db.defaults({ faq: [] })
  .write()

// Filter and Sort by rank.
const faq = db.get('faq')
  .filter({ category: '运维管理' })
  .sortBy('rank')
  .value()
console.log(faq)

项目计划

  1. 研究支持开源项目 emqx 前端配置项配置
  2. 封装常用在线文档/代码工具如 Markdown 表格转换, yapi 转 Element 表格及表单代码工具

文章首发

物联网 IoT 应用集成、前端倒腾 W I v 的博客 https://wivwiv.com

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,080评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,422评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,630评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,554评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,662评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,856评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,014评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,752评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,212评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,541评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,687评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,347评论 4 331
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,973评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,777评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,006评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,406评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,576评论 2 349

推荐阅读更多精彩内容