能否优化一下 /api/filetree/createDocWithMd 接口

本贴最后更新于 220 天前,其中的信息可能已经物是人非

前两天通过咱的 api 写插件,碰到个问题,这里记录一下,希望 D 大看看如何优化一下。

场景:

我通过/api/filetree/createDocWithMd 接口写入文档,同时需要找到文档内容 blocks 的 ids,保存至 doc 的自定义属性中,以此让两者产生关联。

问题:

通过 api 写入文档后,仅返回了 doc_id,并没有返回任何内容相关的信息,我需要单独通过 sql 接口查,但是呢,可能是因为文档数据和 db 数据同步需要一定时间,马上去查 blocks 就会查不到任何数据,等会再查就没问题。

所以,我的解决方案是延时的循环查询,直到查到数据或超出最大循环次数。

不知道是否有更优的解决方案,或者该 api 接口能否在文档数据和 db 数据全部处理完毕后再返回结果?

可参考相关方法的 143、187 行。

相关帖子

欢迎来到这里!

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

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

    你指的是创建新文档 A 以后,需要把 A 的所有块 ids 查询出来,然后插入到文档 B 的 root 属性中吗?

    2 回复
  • nmtuan
    作者

    我要做的是: 基于 markdown 创建 A 文档,然后把子块的 ids 写入 A 到的 attrs 里。

    我目前的解决方案不是非常好,也仅仅是根据目前 api 和我的能力,想到的一种方案。

    实际场景:

    把浏览器的一个书签以 doc 的方式插入到 siyuan。这是最根本的需求。

    由于 doc 内无法直观的看到 attrs,所以在创建 doc 的时候,把链接地址写入到了文档中,生成了 block。方便浏览文档的时候一键打开网站。

    然后,为了修改浏览器书签的时候,能同时能更新到此 block,我用到的笨办法就是把 blockId 写入到 doc 的 attrs 里。

    这是我目前的实现方式。从头到尾只有一个 doc 和它的一个子 block。

    当然,也还有其它的解决方案,希望 D 大择优考虑。

    方案 1:页面能直观展示 attrs。

    (这样就避免在正文中插入 block 了)

    方案 2:doc 的 title 有 url 属性,就好像有 icon 属性一样,直接在 title 上加超链接。

    (同样不需要在正文插入 block;而且还自带超链接)

    方案 3:能直接为 doc 插入新 block。插入 block 时,可同时写 docId 至 block 的 attrs,从而达到二者关联。

    (另外,希望 1.6.0 的 api/block/insertBlock,不仅可以靠 previousID,也可以靠 docID 作为参数)

    以上是大概的场景,希望对 api 设计有帮助。

    1 回复
    1 操作
    nmtuan 在 2022-01-04 20:29:00 更新了该回帖
  • nmtuan
    作者

    image.png

  • 88250
    订阅者

    我大概明白这个扩展的用例了,你提到的三个方案:

    1. 这个估计要靠挂件,比如提供专门的文档属性挂件。但是这样用户需要设置,有点麻烦
    2. 这个不大合适,因为文档 URL 有点语义不清晰,还是靠属性扩展比较好
    3. 后续会提供文档的 prependBlock(在顶部插入)和 appendBlock(在底部插入)API,我觉得这个方案应该比较好。比如可以通过 prepend 来直接插入新块用来保存网址,老的块也不用删除,作为修改历史继续留着,用户如果要删的话就手动删除。这样就不用考虑关联问题了,浏览器扩展那里只记一下 doc ID 就好

    你感觉呢?

    1 回复
  • nmtuan
    作者

    能有 prependBlock 和 appendBlock 是最好了trollface

    那我就等 api 放出了。

    另外,希望 insertBlock prependBlock appendBlock 增加 attrs 参数,在插入文档的时候可以同时写入属性。

    1 回复
  • 88250 1 评论
    订阅者

    这几个接口的 data 字段支持直接设置块属性的,比如 dataTypemarkdown 时,可以通过 kramdown 语法来设置属性,具体语法格式可以通过文档导出模板进行参考。

    明白,感谢!
    nmtuan
请输入回帖内容 ...

推荐标签 标签

  • 负能量

    上帝为你关上了一扇门,然后就去睡觉了....努力不一定能成功,但不努力一定很轻松 (° ー °〃)

    83 引用 • 1157 回帖 • 523 关注
  • ReactiveX

    ReactiveX 是一个专注于异步编程与控制可观察数据(或者事件)流的 API。它组合了观察者模式,迭代器模式和函数式编程的优秀思想。

    1 引用 • 2 回帖 • 65 关注
  • SSL

    SSL(Secure Sockets Layer 安全套接层),及其继任者传输层安全(Transport Layer Security,TLS)是为网络通信提供安全及数据完整性的一种安全协议。TLS 与 SSL 在传输层对网络连接进行加密。

    65 引用 • 187 回帖 • 526 关注
  • OnlyOffice
    4 引用 • 11 关注
  • 数据库

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

    323 引用 • 602 回帖 • 1 关注
  • webpack

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

    41 引用 • 130 回帖 • 344 关注
  • 阿里巴巴

    阿里巴巴网络技术有限公司(简称:阿里巴巴集团)是以曾担任英语教师的马云为首的 18 人,于 1999 年在中国杭州创立,他们相信互联网能够创造公平的竞争环境,让小企业通过创新与科技扩展业务,并在参与国内或全球市场竞争时处于更有利的位置。

    43 引用 • 221 回帖 • 399 关注
  • V2EX

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

    17 引用 • 236 回帖 • 654 关注
  • 大数据

    大数据(big data)是指无法在一定时间范围内用常规软件工具进行捕捉、管理和处理的数据集合,是需要新处理模式才能具有更强的决策力、洞察发现力和流程优化能力的海量、高增长率和多样化的信息资产。

    84 引用 • 112 回帖
  • RESTful

    一种软件架构设计风格而不是标准,提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制。

    30 引用 • 114 回帖
  • 开源

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

    376 引用 • 3329 回帖 • 144 关注
  • jsDelivr

    jsDelivr 是一个开源的 CDN 服务,可为 npm 包、GitHub 仓库提供免费、快速并且可靠的全球 CDN 加速服务。

    5 引用 • 30 回帖 • 16 关注
  • GitLab

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

    43 引用 • 72 回帖 • 1 关注
  • FreeMarker

    FreeMarker 是一款好用且功能强大的 Java 模版引擎。

    23 引用 • 19 回帖 • 386 关注
  • Flume

    Flume 是一套分布式的、可靠的,可用于有效地收集、聚合和搬运大量日志数据的服务架构。

    9 引用 • 6 回帖 • 556 关注
  • uTools

    uTools 是一个极简、插件化、跨平台的现代桌面软件。通过自由选配丰富的插件,打造你得心应手的工具集合。

    6 引用 • 13 回帖 • 1 关注
  • Eclipse

    Eclipse 是一个开放源代码的、基于 Java 的可扩展开发平台。就其本身而言,它只是一个框架和一组服务,用于通过插件组件构建开发环境。

    75 引用 • 258 回帖 • 674 关注
  • CAP

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

    11 引用 • 5 回帖 • 512 关注
  • 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.

    3 引用 • 62 回帖
  • 脑图

    脑图又叫思维导图,是表达发散性思维的有效图形思维工具 ,它简单却又很有效,是一种实用性的思维工具。

    20 引用 • 57 回帖
  • 笔记

    好记性不如烂笔头。

    290 引用 • 775 回帖
  • Unity

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

    21 引用 • 7 回帖 • 358 关注
  • 电影

    这是一个不能说的秘密。

    118 引用 • 591 回帖
  • Electron

    Electron 基于 Chromium 和 Node.js,让你可以使用 HTML、CSS 和 JavaScript 构建应用。它是一个由 GitHub 及众多贡献者组成的活跃社区共同维护的开源项目,兼容 Mac、Windows 和 Linux,它构建的应用可在这三个操作系统上面运行。

    16 引用 • 142 回帖
  • OpenShift

    红帽提供的 PaaS 云,支持多种编程语言,为开发人员提供了更为灵活的框架、存储选择。

    14 引用 • 20 回帖 • 572 关注
  • LeetCode

    LeetCode(力扣)是一个全球极客挚爱的高质量技术成长平台,想要学习和提升专业能力从这里开始,充足技术干货等你来啃,轻松拿下 Dream Offer!

    209 引用 • 72 回帖 • 1 关注
  • 倾城之链
    17 引用 • 47 回帖 • 33 关注