登录 注册

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

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

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

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

1 引用
挂件开发的文档在哪里 • Undii
深圳 位置
20 悬赏
1 关注
1 收藏
1 引用
8 回帖
2
386 190 26 3 3 6 157

相关帖子

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

欢迎来到这里！

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

注册 关于
请输入回帖内容 ...
  • 1995hanjian •
    订阅者

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

        var node = window.frameElement.parentElement.parentElement;
    var conf = node.getAttribute("custom-conf")
  • 其他回帖
  • soltus • • 1
    捐赠者 订阅者

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

  • 88250 •
    订阅者

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

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

  • 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 更新了该回帖
  • 查看全部回帖
suka
深圳
回帖
22
 帖子
3
 积分
1380

近期热议

推荐标签 标签

  • 星云链

    星云链是一个开源公链，业内简单的将其称为区块链上的谷歌。其实它不仅仅是区块链搜索引擎，一个公链的所有功能，它基本都有，比如你可以用它来开发部署你的去中心化的 APP，你可以在上面编写智能合约，发送交易等等。3 分钟快速接入星云链 (NAS) 测试网

    3 引用 • 16 回帖 • 32 关注
  • 服务

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

    42 引用 • 24 回帖
  • frp

    frp 是一个可用于内网穿透的高性能的反向代理应用，支持 TCP、UDP、 HTTP 和 HTTPS 协议。

    13 引用 • 5 回帖
  • 数据库

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

    326 引用 • 602 回帖
  • HBase

    HBase 是一个分布式的、面向列的开源数据库，该技术来源于 Fay Chang 所撰写的 Google 论文 “Bigtable：一个结构化数据的分布式存储系统”。就像 Bigtable 利用了 Google 文件系统所提供的分布式数据存储一样，HBase 在 Hadoop 之上提供了类似于 Bigtable 的能力。

    17 引用 • 6 回帖 • 25 关注
  • MySQL

    MySQL 是一个关系型数据库管理系统，由瑞典 MySQL AB 公司开发，目前属于 Oracle 公司。MySQL 是最流行的关系型数据库管理系统之一。

    651 引用 • 530 回帖 • 165 关注
  • 知乎

    知乎是网络问答社区，连接各行各业的用户。用户分享着彼此的知识、经验和见解，为中文互联网源源不断地提供多种多样的信息。

    10 引用 • 66 回帖
  • Bootstrap

    Bootstrap 是 Twitter 推出的一个用于前端开发的开源工具包。它由 Twitter 的设计师 Mark Otto 和 Jacob Thornton 合作开发，是一个 CSS / HTML 框架。

    18 引用 • 33 回帖 • 677 关注
  • RabbitMQ

    RabbitMQ 是一个开源的 AMQP 实现，服务器端用 Erlang 语言编写，支持多种语言客户端，如：Python、Ruby、.NET、Java、C、PHP、ActionScript 等。用于在分布式系统中存储转发消息，在易用性、扩展性、高可用性等方面表现不俗。

    49 引用 • 60 回帖 • 450 关注
  • WiFiDog

    WiFiDog 是一套开源的无线热点认证管理工具，主要功能包括：位置相关的内容递送；用户认证和授权；集中式网络监控。

    1 引用 • 7 回帖 • 511 关注
  • 音乐

    你听到信仰的声音了么？

    58 引用 • 515 回帖
  • 国际化

    i18n（其来源是英文单词 internationalization 的首末字符 i 和 n，18 为中间的字符数）是“国际化”的简称。对程序来说，国际化是指在不修改代码的情况下，能根据不同语言及地区显示相应的界面。

    7 引用 • 26 回帖
  • 智能合约

    智能合约（Smart contract）是一种旨在以信息化方式传播、验证或执行合同的计算机协议。智能合约允许在没有第三方的情况下进行可信交易，这些交易可追踪且不可逆转。智能合约概念于 1994 年由 Nick Szabo 首次提出。

    1 引用 • 11 回帖 • 8 关注
  • 博客

    记录并分享人生的经历。

    262 引用 • 2369 回帖
  • webpack

    webpack 是一个用于前端开发的模块加载器和打包工具，它能把各种资源，例如 JS、CSS（less/sass）、图片等都作为模块来使用和处理。

    41 引用 • 130 回帖 • 321 关注
  • 微服务

    微服务架构是一种架构模式，它提倡将单一应用划分成一组小的服务。服务之间互相协调，互相配合，为用户提供最终价值。每个服务运行在独立的进程中。服务于服务之间才用轻量级的通信机制互相沟通。每个服务都围绕着具体业务构建，能够被独立的部署。

    86 引用 • 155 回帖
  • BAE

    百度应用引擎（Baidu App Engine）提供了 PHP、Java、Python 的执行环境，以及云存储、消息服务、云数据库等全面的云服务。它可以让开发者实现自动地部署和管理应用，并且提供动态扩容和负载均衡的运行环境，让开发者不用考虑高成本的运维工作，只需专注于业务逻辑，大大降低了开发者学习和迁移的成本。

    19 引用 • 75 回帖 • 550 关注
  • 书籍

    宋真宗赵恒曾经说过：“书中自有黄金屋，书中自有颜如玉。”

    73 引用 • 379 回帖
  • Ant-Design

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

    17 引用 • 23 回帖 • 2 关注
  • 招聘

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

    185 引用 • 1050 回帖 • 127 关注
  • JRebel

    JRebel 是一款 Java 虚拟机插件，它使得 Java 程序员能在不进行重部署的情况下，即时看到代码的改变对一个应用程序带来的影响。

    26 引用 • 78 回帖 • 578 关注
  • 思源笔记

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

    融合块、大纲和双向链接，构建你永恒的数字花园。

    117 引用 • 1309 回帖
  • IDEA

    IDEA 全称 IntelliJ IDEA，是一款 Java 语言开发的集成环境，在业界被公认为最好的 Java 开发工具之一。IDEA 是 JetBrains 公司的产品，这家公司总部位于捷克共和国的首都布拉格，开发人员以严谨著称的东欧程序员为主。

    174 引用 • 398 回帖
  • PWL

    组织简介

    用爱发电 (Programming With Love) 是一个以开源精神为核心的民间开源爱好者技术组织，“用爱发电”象征开源与贡献精神，加入组织，代表你将遵守组织的“个人开源爱好者”的各项条款。申请加入：用爱发电组织邀请帖。
    用爱发电组织官网：https://programmingwithlove.stackoverflow.wiki/

    用爱发电组织的核心驱动力：

    • 遵守开源守则，体现开源&贡献精神：以分享为目的，拒绝非法牟利。
    • 自我保护：使用适当的 License 保护自己的原创作品。
    • 尊重他人：不以各种理由、各种漏洞进行未经允许的抄袭、散播、洩露；以礼相待，尊重所有对社区做出贡献的开发者；通过他人的分享习得知识，要留下足迹，表示感谢。
    • 热爱编程、热爱学习：加入组织，热爱编程是首当其要的。我们欢迎热爱讨论、分享、提问的朋友，也同样欢迎默默成就的朋友。
    • 倾听：正确并恳切对待、处理问题与建议，及时修复开源项目的 Bug ，及时与反馈者沟通。不抬杠、不无视、不辱骂。
    • 平视：不诋毁、轻视、嘲讽其他开发者，主动提出建议、施以帮助，以和谐为本。只要他人肯努力，你也可能会被昔日小看的人所超越，所以请保持谦虚。
    • 乐观且活跃：你的努力决定了你的高度。不要放弃，多年后回头俯瞰，才会发现自己已经成就往日所仰望的水平。积极地将项目开源，帮助他人学习、改进，自己也会获得相应的提升、成就与成就感。
    1 引用 • 487 回帖 • 3 关注
  • GitBook

    GitBook 使您的团队可以轻松编写和维护高质量的文档。 分享知识，提高团队的工作效率，让用户满意。

    3 引用 • 8 回帖 • 1 关注
  • PHP

    PHP（Hypertext Preprocessor）是一种开源脚本语言。语法吸收了 C 语言、 Java 和 Perl 的特点，主要适用于 Web 开发领域，据说是世界上最好的编程语言。

    160 引用 • 402 回帖 • 554 关注
  • GraphQL

    GraphQL 是一个用于 API 的查询语言，是一个使用基于类型系统来执行查询的服务端运行时（类型系统由你的数据定义）。GraphQL 并没有和任何特定数据库或者存储引擎绑定，而是依靠你现有的代码和数据支撑。

    4 引用 • 3 回帖 • 17 关注

最新标签