登录 注册

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

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

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

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

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

  • 思源笔记

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

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

    28446 引用 • 119790 回帖
  • Q&A

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

    11155 引用 • 50666 回帖 • 52 关注
1 引用
挂件开发的文档在哪里 • Undii
深圳 位置
20 悬赏
1 关注
2 收藏
1 引用
8 回帖
2
883 240 62 187 11 16 364

相关帖子

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
站在巨人的肩膀上 深圳
回帖
164
 帖子
9
 积分
1506

近期热议

推荐标签 标签

  • 前端

    前端技术一般分为前端设计和前端开发，前端设计可以理解为网站的视觉设计，前端开发则是网站的前台代码实现，包括 HTML、CSS 以及 JavaScript 等。

    248 引用 • 1342 回帖
  • Thymeleaf

    Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎。类似 Velocity、 FreeMarker 等，它也可以轻易的与 Spring 等 Web 框架进行集成作为 Web 应用的模板引擎。与其它模板引擎相比，Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面，而不需要启动整个 Web 应用。

    11 引用 • 19 回帖 • 413 关注
  • 倾城之链
    23 引用 • 66 回帖 • 189 关注
  • BND

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

    107 引用 • 1281 回帖 • 36 关注
  • Webswing

    Webswing 是一个能将任何 Swing 应用通过纯 HTML5 运行在浏览器中的 Web 服务器，详细介绍请看 将 Java Swing 应用变成 Web 应用 。

    1 引用 • 15 回帖 • 669 关注
  • GraphQL

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

    4 引用 • 3 回帖 • 11 关注
  • CAP

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

    12 引用 • 5 回帖 • 660 关注
  • webpack

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

    43 引用 • 130 回帖 • 259 关注
  • Spark

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

    74 引用 • 46 回帖 • 563 关注
  • Latke

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

    71 引用 • 535 回帖 • 847 关注
  • Vue.js

    Vue.js（读音 /vju ː/，类似于 view）是一个构建数据驱动的 Web 界面库。Vue.js 的目标是通过尽可能简单的 API 实现响应的数据绑定和组合的视图组件。

    269 引用 • 666 回帖 • 1 关注
  • Solidity

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

    3 引用 • 18 回帖 • 458 关注
  • Log4j

    Log4j 是 Apache 开源的一款使用广泛的 Java 日志组件。

    20 引用 • 18 回帖 • 60 关注
  • 链滴

    链滴是一个记录生活的地方。

    记录生活，连接点滴

    203 引用 • 4025 回帖
  • Angular

    Angular 是 AngularJS 的新版本。

    26 引用 • 66 回帖 • 578 关注
  • Unity

    Unity 是由 Unity Technologies 开发的一个让开发者可以轻松创建诸如 2D、3D 多平台的综合型游戏开发工具，是一个全面整合的专业游戏引擎。

    27 引用 • 7 回帖 • 92 关注
  • Shell

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

    126 引用 • 83 回帖 • 1 关注
  • 单点登录

    单点登录（Single Sign On）是目前比较流行的企业业务整合的解决方案之一。SSO 的定义是在多个应用系统中，用户只需要登录一次就可以访问所有相互信任的应用系统。

    9 引用 • 25 回帖 • 8 关注
  • OkHttp

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

    16 引用 • 6 回帖 • 98 关注
  • DevOps

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

    59 引用 • 25 回帖 • 5 关注
  • Elasticsearch

    Elasticsearch 是一个基于 Lucene 的搜索服务器。它提供了一个分布式多用户能力的全文搜索引擎，基于 RESTful 接口。Elasticsearch 是用 Java 开发的，并作为 Apache 许可条款下的开放源码发布，是当前流行的企业级搜索引擎。设计用于云计算中，能够达到实时搜索，稳定，可靠，快速，安装使用方便。

    117 引用 • 99 回帖 • 190 关注
  • Markdown

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

    173 引用 • 1559 回帖
  • Wide

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

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

    30 引用 • 218 回帖 • 664 关注
  • Node.js

    Node.js 是一个基于 Chrome JavaScript 运行时建立的平台， 用于方便地搭建响应速度快、易于扩展的网络应用。Node.js 使用事件驱动， 非阻塞 I/O 模型而得以轻量和高效。

    139 引用 • 269 回帖 • 1 关注
  • Notion

    Notion - The all-in-one workspace for your notes, tasks, wikis, and databases.

    10 引用 • 80 回帖 • 1 关注
  • sts
    2 引用 • 2 回帖 • 260 关注
  • GitBook

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

    3 引用 • 8 回帖

最新标签