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

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

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

想了几种,感觉都有缺点:

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

  • 思源笔记

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

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

    21066 引用 • 82873 回帖 • 7 关注
  • Q&A

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

    7484 引用 • 34026 回帖 • 196 关注

相关帖子

欢迎来到这里!

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

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

    在思源里使用 API 读写文本文件(比如 json),在汐洛分支可以使用 IDB

    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 更新了该回帖
  • localStorage 不会进行数据同步,需要数据同步的场景不要用。正如其他开发者提到的,建议使用文件读写 API,但是需要注意的是数据同步以后再去获取数据。

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

  • RenaEmiya

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

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

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

    const id = window.frameElement.parentElement.parentElement.dataset.nodeId;
    
  • suka

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

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

    1 回复
  • suka

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

请输入回帖内容 ...

推荐标签 标签

  • Thymeleaf

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

    11 引用 • 19 回帖 • 341 关注
  • Vim

    Vim 是类 UNIX 系统文本编辑器 Vi 的加强版本,加入了更多特性来帮助编辑源代码。Vim 的部分增强功能包括文件比较(vimdiff)、语法高亮、全面的帮助系统、本地脚本(Vimscript)和便于选择的可视化模式。

    28 引用 • 66 回帖 • 2 关注
  • Sillot

    Insights(注意当前设置 master 为默认分支)

    汐洛彖夲肜矩阵(Sillot T☳Converbenk Matrix),致力于服务智慧新彖乄,具有彖乄驱动、极致优雅、开发者友好的特点。其中汐洛绞架(Sillot-Gibbet)基于自思源笔记(siyuan-note),前身是思源笔记汐洛版(更早是思源笔记汐洛分支),是智慧新录乄终端(多端融合,移动端优先)。

    主仓库地址:Hi-Windom/Sillot

    文档地址:sillot.db.sc.cn

    注意事项:

    1. ⚠️ 汐洛仍在早期开发阶段,尚不稳定
    2. ⚠️ 汐洛并非面向普通用户设计,使用前请了解风险
    3. ⚠️ 汐洛绞架基于思源笔记,开发者尽最大努力与思源笔记保持兼容,但无法实现 100% 兼容
    29 引用 • 25 回帖 • 71 关注
  • Laravel

    Laravel 是一套简洁、优雅的 PHP Web 开发框架。它采用 MVC 设计,是一款崇尚开发效率的全栈框架。

    20 引用 • 23 回帖 • 720 关注
  • JVM

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

    180 引用 • 120 回帖
  • 外包

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

    26 引用 • 232 回帖
  • Latke

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

    70 引用 • 533 回帖 • 757 关注
  • 京东

    京东是中国最大的自营式电商企业,2015 年第一季度在中国自营式 B2C 电商市场的占有率为 56.3%。2014 年 5 月,京东在美国纳斯达克证券交易所正式挂牌上市(股票代码:JD),是中国第一个成功赴美上市的大型综合型电商平台,与腾讯、百度等中国互联网巨头共同跻身全球前十大互联网公司排行榜。

    14 引用 • 102 回帖 • 390 关注
  • 星云链

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

    3 引用 • 16 回帖 • 1 关注
  • 30Seconds

    📙 前端知识精选集,包含 HTML、CSS、JavaScript、React、Node、安全等方面,每天仅需 30 秒。

    • 精选常见面试题,帮助您准备下一次面试
    • 精选常见交互,帮助您拥有简洁酷炫的站点
    • 精选有用的 React 片段,帮助你获取最佳实践
    • 精选常见代码集,帮助您提高打码效率
    • 整理前端界的最新资讯,邀您一同探索新世界
    488 引用 • 383 回帖 • 1 关注
  • Openfire

    Openfire 是开源的、基于可拓展通讯和表示协议 (XMPP)、采用 Java 编程语言开发的实时协作服务器。Openfire 的效率很高,单台服务器可支持上万并发用户。

    6 引用 • 7 回帖 • 100 关注
  • C

    C 语言是一门通用计算机编程语言,应用广泛。C 语言的设计目标是提供一种能以简易的方式编译、处理低级存储器、产生少量的机器码以及不需要任何运行环境支持便能运行的编程语言。

    83 引用 • 165 回帖
  • 尊园地产

    昆明尊园房地产经纪有限公司,即:Kunming Zunyuan Property Agency Company Limited(简称“尊园地产”)于 2007 年 6 月开始筹备,2007 年 8 月 18 日正式成立,注册资本 200 万元,公司性质为股份经纪有限公司,主营业务为:代租、代售、代办产权过户、办理银行按揭、担保、抵押、评估等。

    1 引用 • 22 回帖 • 732 关注
  • DNSPod

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

    6 引用 • 26 回帖 • 518 关注
  • 安装

    你若安好,便是晴天。

    131 引用 • 1184 回帖
  • 大疆创新

    深圳市大疆创新科技有限公司(DJI-Innovations,简称 DJI),成立于 2006 年,是全球领先的无人飞行器控制系统及无人机解决方案的研发和生产商,客户遍布全球 100 多个国家。通过持续的创新,大疆致力于为无人机工业、行业用户以及专业航拍应用提供性能最强、体验最佳的革命性智能飞控产品和解决方案。

    2 引用 • 14 回帖
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis,2010 年这个项目由 Apache 软件基金会迁移到了 google code,并且改名为 MyBatis ,2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 393 关注
  • 链滴

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

    记录生活,连接点滴

    149 引用 • 3772 回帖 • 1 关注
  • 面试

    面试造航母,上班拧螺丝。多面试,少加班。

    325 引用 • 1395 回帖 • 1 关注
  • V2EX

    V2EX 是创意工作者们的社区。这里目前汇聚了超过 400,000 名主要来自互联网行业、游戏行业和媒体行业的创意工作者。V2EX 希望能够成为创意工作者们的生活和事业的一部分。

    17 引用 • 236 回帖 • 350 关注
  • Redis

    Redis 是一个开源的使用 ANSI C 语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value 数据库,并提供多种语言的 API。从 2010 年 3 月 15 日起,Redis 的开发工作由 VMware 主持。从 2013 年 5 月开始,Redis 的开发由 Pivotal 赞助。

    285 引用 • 248 回帖 • 105 关注
  • SendCloud

    SendCloud 由搜狐武汉研发中心孵化的项目,是致力于为开发者提供高质量的触发邮件服务的云端邮件发送平台,为开发者提供便利的 API 接口来调用服务,让邮件准确迅速到达用户收件箱并获得强大的追踪数据。

    2 引用 • 8 回帖 • 466 关注
  • 安全

    安全永远都不是一个小问题。

    200 引用 • 816 回帖 • 1 关注
  • GitBook

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

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

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

    116 引用 • 99 回帖 • 241 关注
  • Shell

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

    122 引用 • 73 回帖
  • Oracle

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

    104 引用 • 126 回帖 • 426 关注