Milkdown 编辑器在只读模式下标题 ID 缺失问题解析

Milkdown 是一款基于 ProseMirror 的现代化 WYSIWYG 编辑器框架。最近在使用过程中发现了一个关于标题 ID 生成的有趣现象：当编辑器处于只读模式时，标题节点的 ID 属性会意外丢失。

问题现象

在 Milkdown 编辑器中，标题节点通常会自动生成唯一的 ID 属性，这对于实现文档大纲导航等功能非常有用。然而，当编辑器切换到只读模式（editable: false）时，这些标题节点的 ID 属性会变为空值。

这个问题在以下场景中尤为明显：

1. 使用监听插件（listener-plugin）在编辑器挂载时获取文档大纲
2. 调用类似 getOutlines 的工具函数遍历文档节点
3. 在只读模式下检查标题节点的 attrs.id 属性

技术背景

Milkdown 通过 sync-heading-id-plugin 插件来同步标题 ID。这个插件的核心逻辑是：

1. 监听文档变化
2. 为每个标题节点生成唯一 ID
3. 确保 ID 在文档范围内唯一

在 ProseMirror 架构中，视图（View）的 editable 属性控制编辑器是否可编辑。插件开发者通常会根据这个属性来决定是否执行某些操作。

问题根源

经过代码分析，问题出在 sync-heading-id-plugin 插件的一个条件判断上。该插件在视图不可编辑时（!view.editable）会跳过 ID 生成逻辑。这个设计可能是出于性能考虑，认为只读模式下不需要动态更新 ID。

然而，这种假设在实际应用中存在问题：

1. 只读模式下的文档仍然需要稳定的标题 ID 来实现跳转等功能
2. 大纲导航等功能在只读模式下同样重要
3. ID 应该是文档结构的一部分，不应随编辑状态改变

解决方案

针对这个问题，开发者可以考虑以下几种解决方案：

1. 修改插件逻辑：移除对 view.editable 的检查，确保在任何模式下都生成 ID

   // 修改前的代码
   if (!view.editable) return
   
   // 修改后的代码
   // 直接执行ID生成逻辑
   

2. 预生成ID：在文档加载时确保所有标题都有ID，不依赖实时生成

3. 自定义插件：继承或重写默认的标题ID同步逻辑

最佳实践建议

1. 保持ID稳定性：标题ID应该被视为文档内容的一部分，而不是编辑状态的附属物

2. 考虑只读场景：任何编辑器功能都应该在可编辑和只读模式下表现一致

3. 性能优化：如果确实需要优化，可以考虑其他方式如节流或缓存，而不是完全禁用功能

总结

这个案例提醒我们，在开发编辑器功能时，需要充分考虑各种使用场景。看似合理的性能优化可能会影响功能的完整性。对于Milkdown这样的开源项目，理解其内部插件机制有助于开发者更好地定制和扩展功能。