登录 注册

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

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

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

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

  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 支撑。如果大家有什么好的解决方案，欢迎讨论指导，如果我的描述大家有疑惑，也欢迎指出~谢谢大家看到这里，感谢

  • 思源笔记

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

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

    25407 引用 • 105042 回帖
  • Q&A

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

    9720 引用 • 44226 回帖 • 89 关注
1 引用
挂件开发的文档在哪里 • Undii
深圳 位置
20 悬赏
1 关注
2 收藏
1 引用
8 回帖
2
805 232 59 154 8 16 333

相关帖子

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 • via macOS

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

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

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

请输入回帖内容 ...
suka
站在巨人的肩膀上 深圳
回帖
164
 帖子
9
 积分
1481

近期热议

推荐标签 标签

  • JVM

    JVM（Java Virtual Machine）Java 虚拟机是一个微型操作系统，有自己的硬件构架体系，还有相应的指令系统。能够识别 Java 独特的 .class 文件（字节码），能够将这些文件中的信息读取出来，使得 Java 程序只需要生成 Java 虚拟机上的字节码后就能在不同操作系统平台上进行运行。

    180 引用 • 120 回帖
  • Latke

    Latke 是一款以 JSON 为主的 Java Web 框架。

    71 引用 • 535 回帖 • 830 关注
  • Ant-Design

    Ant Design 是服务于企业级产品的设计体系，基于确定和自然的设计价值观上的模块化解决方案，让设计者和开发者专注于更好的用户体验。

    17 引用 • 23 回帖 • 1 关注
  • 生活

    生活是指人类生存过程中的各项活动的总和，范畴较广，一般指为幸福的意义而存在。生活实际上是对人生的一种诠释。生活包括人类在社会中与自己息息相关的日常活动和心理影射。

    230 引用 • 1454 回帖 • 1 关注
  • DevOps

    DevOps（Development 和 Operations 的组合词）是一组过程、方法与系统的统称，用于促进开发（应用程序/软件工程）、技术运营和质量保障（QA）部门之间的沟通、协作与整合。

    58 引用 • 25 回帖 • 2 关注
  • OkHttp

    OkHttp 是一款 HTTP & HTTP/2 客户端库，专为 Android 和 Java 应用打造。

    16 引用 • 6 回帖 • 85 关注
  • ngrok

    ngrok 是一个反向代理，通过在公共的端点和本地运行的 Web 服务器之间建立一个安全的通道。

    7 引用 • 63 回帖 • 648 关注
  • 百度

    百度（Nasdaq：BIDU）是全球最大的中文搜索引擎、最大的中文网站。2000 年 1 月由李彦宏创立于北京中关村，致力于向人们提供“简单，可依赖”的信息获取方式。“百度”二字源于中国宋朝词人辛弃疾的《青玉案·元夕》词句“众里寻他千百度”，象征着百度对中文信息检索技术的执著追求。

    63 引用 • 785 回帖 • 94 关注
  • RemNote
    2 引用 • 16 回帖 • 11 关注
  • 招聘

    哪里都缺人，哪里都不缺人。

    188 引用 • 1057 回帖
  • 倾城之链
    23 引用 • 66 回帖 • 167 关注
  • CongSec

    本标签主要用于分享网络空间安全专业的学习笔记

    1 引用 • 1 回帖 • 31 关注
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言，是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    3200 引用 • 8216 回帖
  • OAuth

    OAuth 协议为用户资源的授权提供了一个安全的、开放而又简易的标准。与以往的授权方式不同之处是 oAuth 的授权不会使第三方触及到用户的帐号信息（如用户名与密码），即第三方无需使用用户的用户名与密码就可以申请获得该用户资源的授权，因此 oAuth 是安全的。oAuth 是 Open Authorization 的简写。

    36 引用 • 103 回帖 • 28 关注
  • jQuery

    jQuery 是一套跨浏览器的 JavaScript 库，强化 HTML 与 JavaScript 之间的操作。由 John Resig 在 2006 年 1 月的 BarCamp NYC 上释出第一个版本。全球约有 28% 的网站使用 jQuery，是非常受欢迎的 JavaScript 库。

    63 引用 • 134 回帖 • 734 关注
  • JSON

    JSON （JavaScript Object Notation）是一种轻量级的数据交换格式。易于人类阅读和编写。同时也易于机器解析和生成。

    52 引用 • 190 回帖 • 1 关注
  • GAE

    Google App Engine（GAE）是 Google 管理的数据中心中用于 WEB 应用程序的开发和托管的平台。2008 年 4 月 发布第一个测试版本。目前支持 Python、Java 和 Go 开发部署。全球已有数十万的开发者在其上开发了众多的应用。

    14 引用 • 42 回帖 • 812 关注
  • Oracle

    Oracle（甲骨文）公司，全称甲骨文股份有限公司（甲骨文软件系统有限公司），是全球最大的企业级软件公司，总部位于美国加利福尼亚州的红木滩。1989 年正式进入中国市场。2013 年，甲骨文已超越 IBM，成为继 Microsoft 后全球第二大软件公司。

    107 引用 • 127 回帖 • 339 关注
  • 开源

    Open Source, Open Mind, Open Sight, Open Future!

    411 引用 • 3588 回帖 • 1 关注
  • Sym

    Sym 是一款用 Java 实现的现代化社区（论坛/BBS/社交网络/博客）系统平台。

    下一代的社区系统，为未来而构建

    524 引用 • 4601 回帖 • 707 关注
  • 服务

    提供一个服务绝不仅仅是简单的把硬件和软件累加在一起，它包括了服务的可靠性、服务的标准化、以及对服务的监控、维护、技术支持等。

    41 引用 • 24 回帖 • 2 关注
  • sts
    2 引用 • 2 回帖 • 228 关注
  • Ruby

    Ruby 是一种开源的面向对象程序设计的服务器端脚本语言，在 20 世纪 90 年代中期由日本的松本行弘（まつもとゆきひろ/Yukihiro Matsumoto）设计并开发。在 Ruby 社区，松本也被称为马茨（Matz）。

    7 引用 • 31 回帖 • 248 关注
  • FFmpeg

    FFmpeg 是一套可以用来记录、转换数字音频、视频，并能将其转化为流的开源计算机程序。

    23 引用 • 32 回帖
  • BookxNote

    BookxNote 是一款全新的电子书学习工具，助力您的学习与思考，让您的大脑更高效的记忆。

    笔记整理交给我，一心只读圣贤书。

    1 引用 • 1 回帖
  • GitLab

    GitLab 是利用 Ruby 一个开源的版本管理系统，实现一个自托管的 Git 项目仓库，可通过 Web 界面操作公开或私有项目。

    46 引用 • 72 回帖
  • 反馈

    Communication channel for makers and users.

    121 引用 • 907 回帖 • 272 关注

最新标签