登录 注册

请问思源挂件数据持久化有哪些解决方案呢？有官方的存储方案吗？

本贴最后更新于 462 天前，其中的信息可能已经水流花落

最近在开发一款挂件，想要永久存储用户的配置数据到本地，发现数据持久化让我比较头疼

想了几种，感觉都有缺点：

  1. localStorage: 这个我暂时没用过，因为我记得在某版的思源发布后，有挂件作者反映 localstorage 不好用还是怎么的（存疑），而且也不符合我的使用场景，因为我要保存的是用户的配置数据，需要一直保存，且多端同步保存

    1. 官方我看到有如下 api：（没研究过 go 语言，还不知道该传啥参数）

      ginServer.Handle("POST","/api/storage/setLocalStorage",model.CheckAuth,setLocalStorage)
      ginServer.Handle("POST", "/api/storage/getLocalStorage", model.CheckAuth, getLocalStorage)
      ginServer.Handle("POST", "/api/storage/setLocalStorageVal", model.CheckAuth, setLocalStorageVal)
      ginServer.Handle("POST", "/api/storage/removeLocalStorageVal", model.CheckAuth, removeLocalStorageVal)2.

  2. 存储到特定文档或者某个特定的 block 的属性中，这种也不太好，因为万一那个文档或者 block，用户不再需要，删除了，那数据就清空了。（此方案的衍生方案：向特定的文档写入 html 片段，数据放在 html 片段 的 dataset 属性上，但是如果此 html 片段被误删，那配置文件也就没了）

  3. 引导用户新建一个设置文档，在此设置文档的属性上面或者文档内的特定 block 的属性上存储数据，此方案的优点是：

    1.可以确保用户不会轻易删除自己的配置，即使误删，也有官方的回收站做背书，数据比较不容易丢；

    2.可以在文档内的不同 block 的属性上存入数据，以此达到，一个设置文档，管理多个挂件的数据（当然，需要各个挂件的作者都把数据存入这个文档内的特定 block 上）

    3.可以开发一个挂件，可视化编辑此文档中存储的各个挂件的配置，（模板作者也可以存储数据到此文档）；

    4.如果要删除某个挂件的配置，只需要删除存储了那个挂件配置的 block 即可，可视化操作（缺点是 block 太容易删除了，都没有弹框确认，或许可以官方下场，哈哈哈哈）；
    5.用户掌控所有数据，包括挂件的，完美契合思源笔记的设计哲学；

    缺点：

    1.太有侵入性了（大胆！小小挂件，竟然胆敢让本王在朕的数字花园新建一个文档！）

    2.存储的数据单一，只能存储文本类的配置数据（但是大多数挂件似乎也不太需要更高级的数据类型了？反正我不需要）

    3.删除挂件，需要用户手动删除相关 block，有误删成其它 block 的可能性

  4. 思源官方提供 api，将数据存储在用户的本地数据目录下（或许已经有了？只是我不知道？有的话请大佬们告诉我）

  5. 将数据存储在某个挂件本身挂载的 block 的属性上：这种是个人感觉挺好的方法了 😄

    1. 优点：当用户不再需要这个挂件了，直接移除即可，相应的配置数据也一并移除了，没有额外的操作，也没有垃圾数据残留；并且多个相同挂件的数据互不影响，方便隔离
    2. 缺点：目前没有找到啥 api 能在挂件内准确的获取该挂件所在 block 的 id

总结：还有一些其它的基于云端的方案，都被我率先放弃，毕竟本地优先，个人认为，上述方案 4 和 5 是我能想到的比较不错的方案，但是都需要额外的官方 api 支撑。如果大家有什么好的解决方案，欢迎讨论指导，如果我的描述大家有疑惑，也欢迎指出~谢谢大家看到这里，感谢

  • 思源笔记

    思源笔记是一款隐私优先的个人知识管理系统，支持完全离线使用，同时也支持端到端加密同步。

    融合块、大纲和双向链接，重构你的思维。

    18914 引用 • 70897 回帖
  • Q&A

    提问之前请先看《提问的智慧》，好的问题比好的答案更有价值。

    6613 引用 • 29663 回帖 • 250 关注
1 引用
挂件开发的文档在哪里 • Undii
深圳 位置
20 悬赏
1 关注
2 收藏
1 引用
8 回帖
2
661 223 59 81 8 16 272

相关帖子

8 回帖
请问思源挂件数据持久化有哪些解决方案呢？有官方的存储方案吗？

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
  • soltus • • 1
    捐赠者

    在思源里使用 API 读写文本文件（比如 json），在汐洛分支可以使用 IDB

  • Undii •
    付费者 捐赠者
    1. 我看 HbuilderX 主题里面用了以下代码（/conf/appereance/themes/HBuilderX-light/theme.js）；补充 API 文档-获取/写入文件
    写入文件("/data/widgets/HBuilderX-Light.config.json", JSON.stringify(window.HBuilderXLight.config, undefined, 4), (a) => { funs() });

   async function 写入文件(path, filedata, then = null, obj = null, isDir = false, modTime = Date.now()) {
   
       let blob = new Blob([filedata]);
       let file = new File([blob], path.split('/').pop());
       let formdata = new FormData();
       formdata.append("path", path);
       formdata.append("file", file);
       formdata.append("isDir", isDir);
       formdata.append("modTime", modTime);
       await fetch(
           "/api/file/putFile", {
           body: formdata,
           method: "POST",
           headers: {
               Authorization: `Token ""`,
           },
       }).then((v) => {
           setTimeout(() => {
               if (then) then(obj);
           }, 200)
       });
   }

    

    async function 获取文件(path, then = null, obj = null) {
    let url = '/api/file/getFile';
    await 向思源请求数据(url, {
        path: path
    }).then((v) => {
        if (then) then(v, obj);
    });
}
    1. 我不了解 api，我一般用这个从页面上获取挂件 id：window.frameElement.parentElement.parentElement.dataset.nodeId;

    `

    1 操作
    Undii 在 2023-01-31 21:12:00 更新了该回帖
  • 88250 •
    订阅者 MOD

    localStorage 不会进行数据同步，需要数据同步的场景不要用。正如其他开发者提到的，建议使用文件读写 API，但是需要注意的是数据同步以后再去获取数据。

    目前启动时会进行首次数据同步，但是启动时的同步只是获取变更列表，并不会实际同步数据，获取到变更列表后 7s 才会再次发起实际数据同步请求。这段时间内我们会锁定待变更的文档以防止用户编辑后产生冲突，但是这个逻辑目前尚未推广到更通用的场景上，可能还需要和大家讨论一下这里的设计。

  • RenaEmiya •
    订阅者

    嗯确实直接获取挂件块，读挂件块的属性就行

        var node = window.frameElement.parentElement.parentElement;
    var conf = node.getAttribute("custom-conf")
  • shuoying •
    订阅者 支持者 捐赠者 恶龙
    1. 将数据存储在某个挂件本身挂载的 block 的属性上：这种是个人感觉挺好的方法了 😄2. 缺点：目前没有找到啥 api 能在挂件内准确的获取该挂件所在 block 的 id

    可以通过挂件块 DOM 的 data-node-id 属性获得

    const id = window.frameElement.parentElement.parentElement.dataset.nodeId;
  • suka •
    付费者 捐赠者 作者

    感谢大家 了解了并用上了 谢谢大家的回复

    1 回复
  • xiaoshiguang •
    订阅者

    你好用的哪种方案哈，想了解下挂件的存储，有个之前的自己写的插件想改成挂件

    1 回复
  • suka •
    付费者 捐赠者 作者

    用的第 5 种，具体可以参考帖子里面其他人的回帖或者这里：
    https://github.com/suka233/siyuan-calendiary/blob/dev/src/utils/index.ts

请输入回帖内容 ...
suka
站在巨人的肩膀上 深圳
回帖
127
 帖子
7
 积分
1557

近期热议

推荐标签 标签

  • 数据库

    据说 99% 的性能瓶颈都在数据库。

    330 引用 • 614 回帖 • 2 关注
  • Linux

    Linux 是一套免费使用和自由传播的类 Unix 操作系统，是一个基于 POSIX 和 Unix 的多用户、多任务、支持多线程和多 CPU 的操作系统。它能运行主要的 Unix 工具软件、应用程序和网络协议，并支持 32 位和 64 位硬件。Linux 继承了 Unix 以网络为核心的设计思想，是一个性能稳定的多用户网络操作系统。

    915 引用 • 931 回帖 • 1 关注
  • Sphinx

    Sphinx 是一个基于 SQL 的全文检索引擎，可以结合 MySQL、PostgreSQL 做全文搜索，它可以提供比数据库本身更专业的搜索功能，使得应用程序更容易实现专业化的全文检索。

    1 引用 • 180 关注
  • Markdown

    Markdown 是一种轻量级标记语言，用户可使用纯文本编辑器来排版文档，最终通过 Markdown 引擎将文档转换为所需格式（比如 HTML、PDF 等）。

    164 引用 • 1456 回帖
  • OpenShift

    红帽提供的 PaaS 云，支持多种编程语言，为开发人员提供了更为灵活的框架、存储选择。

    14 引用 • 20 回帖 • 607 关注
  • SQLite

    SQLite 是一个进程内的库，实现了自给自足的、无服务器的、零配置的、事务性的 SQL 数据库引擎。SQLite 是全世界使用最为广泛的数据库引擎。

    4 引用 • 7 回帖
  • Flutter

    Flutter 是谷歌的移动 UI 框架，可以快速在 iOS 和 Android 上构建高质量的原生用户界面。 Flutter 可以与现有的代码一起工作，它正在被越来越多的开发者和组织使用，并且 Flutter 是完全免费、开源的。

    39 引用 • 92 回帖 • 8 关注
  • WordPress

    WordPress 是一个使用 PHP 语言开发的博客平台，用户可以在支持 PHP 和 MySQL 数据库的服务器上架设自己的博客。也可以把 WordPress 当作一个内容管理系统（CMS）来使用。WordPress 是一个免费的开源项目，在 GNU 通用公共许可证（GPLv2）下授权发布。

    45 引用 • 113 回帖 • 302 关注
  • Eclipse

    Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台。就其本身而言，它只是一个框架和一组服务，用于通过插件组件构建开发环境。

    75 引用 • 258 回帖 • 628 关注
  • CAP

    CAP 指的是在一个分布式系统中， Consistency（一致性）、 Availability（可用性）、Partition tolerance（分区容错性），三者不可兼得。

    11 引用 • 5 回帖 • 567 关注
  • Facebook

    Facebook 是一个联系朋友的社交工具。大家可以通过它和朋友、同事、同学以及周围的人保持互动交流，分享无限上传的图片，发布链接和视频，更可以增进对朋友的了解。

    4 引用 • 15 回帖 • 455 关注
  • Wide

    Wide 是一款基于 Web 的 Go 语言 IDE。通过浏览器就可以进行 Go 开发，并有代码自动完成、查看表达式、编译反馈、Lint、实时结果输出等功能。

    欢迎访问我们运维的实例： https://wide.b3log.org

    30 引用 • 218 回帖 • 604 关注
  • CSDN

    CSDN (Chinese Software Developer Network) 创立于 1999 年，是中国的 IT 社区和服务平台，为中国的软件开发者和 IT 从业者提供知识传播、职业发展、软件开发等全生命周期服务，满足他们在职业发展中学习及共享知识和信息、建立职业发展社交圈、通过软件开发实现技术商业化等刚性需求。

    14 引用 • 155 回帖 • 1 关注
  • 外包

    有空闲时间是接外包好呢还是学习好呢？

    26 引用 • 232 回帖 • 8 关注
  • HHKB

    HHKB 是富士通的 Happy Hacking 系列电容键盘。电容键盘即无接点静电电容式键盘（Capacitive Keyboard）。

    5 引用 • 74 回帖 • 410 关注
  • Gitea

    Gitea 是一个开源社区驱动的轻量级代码托管解决方案，后端采用 Go 编写，采用 MIT 许可证。

    4 引用 • 16 回帖
  • NGINX

    NGINX 是一个高性能的 HTTP 和反向代理服务器，也是一个 IMAP/POP3/SMTP 代理服务器。 NGINX 是由 Igor Sysoev 为俄罗斯访问量第二的 Rambler.ru 站点开发的，第一个公开版本 0.1.0 发布于 2004 年 10 月 4 日。

    311 引用 • 546 回帖 • 32 关注
  • OnlyOffice
    4 引用 • 18 关注
  • SOHO

    为成为自由职业者在家办公而努力吧！

    7 引用 • 55 回帖 • 90 关注
  • 博客

    记录并分享人生的经历。

    270 引用 • 2386 回帖
  • Shell

    Shell 脚本与 Windows/Dos 下的批处理相似，也就是用各类命令预先放入到一个文件中，方便一次性执行的一个程序文件，主要是方便管理员进行设置或者管理用的。但是它比 Windows 下的批处理更强大，比用其他编程程序编辑的程序效率更高，因为它使用了 Linux/Unix 下的命令。

    122 引用 • 73 回帖
  • Typecho

    Typecho 是一款博客程序，它在 GPLv2 许可证下发行，基于 PHP 构建，可以运行在各种平台上，支持多种数据库（MySQL、PostgreSQL、SQLite）。

    12 引用 • 60 回帖 • 461 关注
  • LaTeX

    LaTeX（音译“拉泰赫”）是一种基于 ΤΕΧ 的排版系统，由美国计算机学家莱斯利·兰伯特（Leslie Lamport）在 20 世纪 80 年代初期开发，利用这种格式，即使使用者没有排版和程序设计的知识也可以充分发挥由 TeX 所提供的强大功能，能在几天，甚至几小时内生成很多具有书籍质量的印刷品。对于生成复杂表格和数学公式，这一点表现得尤为突出。因此它非常适用于生成高印刷质量的科技和数学类文档。

    9 引用 • 32 回帖 • 159 关注
  • Logseq

    Logseq 是一个隐私优先、开源的知识库工具。

    Logseq is a joyful, open-source outliner that works on top of local plain-text Markdown and Org-mode files. Use it to write, organize and share your thoughts, keep your to-do list, and build your own digital garden.

    4 引用 • 55 回帖 • 11 关注
  • DNSPod

    DNSPod 建立于 2006 年 3 月份，是一款免费智能 DNS 产品。 DNSPod 可以为同时有电信、网通、教育网服务器的网站提供智能的解析，让电信用户访问电信的服务器，网通的用户访问网通的服务器，教育网的用户访问教育网的服务器，达到互联互通的效果。

    6 引用 • 26 回帖 • 522 关注
  • Solidity

    Solidity 是一种智能合约高级语言，运行在 [以太坊] 虚拟机（EVM）之上。它的语法接近于 JavaScript，是一种面向对象的语言。

    3 引用 • 18 回帖 • 351 关注
  • 微信

    腾讯公司 2011 年 1 月 21 日推出的一款手机通讯软件。用户可以通过摇一摇、搜索号码、扫描二维码等添加好友和关注公众平台，同时可以将自己看到的精彩内容分享到微信朋友圈。

    129 引用 • 793 回帖 • 1 关注

最新标签