登录 注册

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

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

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

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

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

  • 思源笔记

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

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

    25885 引用 • 107238 回帖
  • Q&A

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

    9940 引用 • 45133 回帖 • 76 关注
1 引用
挂件开发的文档在哪里 • Undii
深圳 位置
20 悬赏
1 关注
2 收藏
1 引用
8 回帖
2
830 232 59 170 8 16 342

相关帖子

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

欢迎来到这里！

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

注册 关于
请输入回帖内容 ...
  • 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;
​
  • 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 更新了该回帖
  • soltus • • 1
    捐赠者

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

  • 查看全部回帖
suka
站在巨人的肩膀上 深圳
回帖
164
 帖子
9
 积分
1481

近期热议

推荐标签 标签

  • Spark

    Spark 是 UC Berkeley AMP lab 所开源的类 Hadoop MapReduce 的通用并行框架。Spark 拥有 Hadoop MapReduce 所具有的优点；但不同于 MapReduce 的是 Job 中间输出结果可以保存在内存中，从而不再需要读写 HDFS，因此 Spark 能更好地适用于数据挖掘与机器学习等需要迭代的 MapReduce 的算法。

    74 引用 • 46 回帖 • 568 关注
  • 房星科技

    房星网，我们不和没有钱的程序员谈理想，我们要让程序员又有理想又有钱。我们有雄厚的房地产行业线下资源，遍布昆明全城的 100 家门店、四千地产经纪人是我们坚实的后盾。

    6 引用 • 141 回帖 • 599 关注
  • H2

    H2 是一个开源的嵌入式数据库引擎，采用 Java 语言编写，不受平台的限制，同时 H2 提供了一个十分方便的 web 控制台用于操作和管理数据库内容。H2 还提供兼容模式，可以兼容一些主流的数据库，因此采用 H2 作为开发期的数据库非常方便。

    11 引用 • 54 回帖 • 674 关注
  • 安装

    你若安好，便是晴天。

    132 引用 • 1184 回帖
  • 游戏

    沉迷游戏伤身，强撸灰飞烟灭。

    184 引用 • 824 回帖 • 1 关注
  • 服务器

    服务器，也称伺服器，是提供计算服务的设备。由于服务器需要响应服务请求，并进行处理，因此一般来说服务器应具备承担服务并且保障服务的能力。

    125 引用 • 585 回帖 • 1 关注
  • 学习

    “梦想从学习开始，事业从实践起步” —— 习近平

    172 引用 • 534 回帖
  • JWT

    JWT（JSON Web Token）是一种用于双方之间传递信息的简洁的、安全的表述性声明规范。JWT 作为一个开放的标准（RFC 7519），定义了一种简洁的，自包含的方法用于通信双方之间以 JSON 的形式安全的传递信息。

    20 引用 • 15 回帖 • 25 关注
  • frp

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

    17 引用 • 7 回帖 • 2 关注
  • 微服务

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

    96 引用 • 155 回帖
  • 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.

    7 引用 • 69 回帖 • 4 关注
  • CloudFoundry

    Cloud Foundry 是 VMware 推出的业界第一个开源 PaaS 云平台，它支持多种框架、语言、运行时环境、云平台及应用服务，使开发人员能够在几秒钟内进行应用程序的部署和扩展，无需担心任何基础架构的问题。

    5 引用 • 18 回帖 • 187 关注
  • 知乎

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

    10 引用 • 66 回帖
  • 酷鸟浏览器

    安全 · 稳定 · 快速
    为跨境从业人员提供专业的跨境浏览器

    3 引用 • 59 回帖 • 48 关注
  • 生活

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

    229 引用 • 1432 回帖
  • 智能合约

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

    1 引用 • 11 回帖 • 2 关注
  • 工具

    子曰：“工欲善其事，必先利其器。”

    298 引用 • 763 回帖
  • 数据库

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

    345 引用 • 751 回帖
  • 架构

    我们平时所说的“架构”主要是指软件架构，这是有关软件整体结构与组件的抽象描述，用于指导软件系统各个方面的设计。另外还有“业务架构”、“网络架构”、“硬件架构”等细分领域。

    142 引用 • 442 回帖 • 2 关注
  • CentOS

    CentOS（Community Enterprise Operating System）是 Linux 发行版之一，它是来自于 Red Hat Enterprise Linux 依照开放源代码规定释出的源代码所编译而成。由于出自同样的源代码，因此有些要求高度稳定的服务器以 CentOS 替代商业版的 Red Hat Enterprise Linux 使用。两者的不同在于 CentOS 并不包含封闭源代码软件。

    240 引用 • 224 回帖 • 1 关注
  • 以太坊

    以太坊（Ethereum）并不是一个机构，而是一款能够在区块链上实现智能合约、开源的底层系统。以太坊是一个平台和一种编程语言 Solidity，使开发人员能够建立和发布下一代去中心化应用。 以太坊可以用来编程、分散、担保和交易任何事物：投票、域名、金融交易所、众筹、公司管理、合同和知识产权等等。

    34 引用 • 367 回帖
  • 印象笔记
    3 引用 • 16 回帖
  • Java

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

    3201 引用 • 8216 回帖 • 1 关注
  • 互联网

    互联网（Internet），又称网际网络，或音译因特网、英特网。互联网始于 1969 年美国的阿帕网，是网络与网络之间所串连成的庞大网络，这些网络以一组通用的协议相连，形成逻辑上的单一巨大国际网络。

    98 引用 • 367 回帖
  • BND

    BND（Baidu Netdisk Downloader）是一款图形界面的百度网盘不限速下载器，支持 Windows、Linux 和 Mac，详细介绍请看这里。

    107 引用 • 1281 回帖 • 34 关注
  • PWA

    PWA（Progressive Web App）是 Google 在 2015 年提出、2016 年 6 月开始推广的项目。它结合了一系列现代 Web 技术，在网页应用中实现和原生应用相近的用户体验。

    14 引用 • 69 回帖 • 183 关注
  • Anytype
    3 引用 • 31 回帖 • 24 关注

最新标签