Hocuspocus v3.1.0发布：协同编辑框架的重大升级

Hocuspocus是一个基于WebSocket的实时协同编辑框架，专为Tiptap编辑器设计。它提供了文档同步、用户状态管理、权限控制等核心功能，使开发者能够轻松构建多人协作的富文本编辑体验。

架构重构与核心改进

本次发布的v3.1.0版本是Hocuspocus框架的一次重大升级，主要围绕架构优化和功能增强展开：

1. 连接管理重构

   • 分离了HocuspocusProvider和HocuspocusProviderWebsocket的连接逻辑
   • 新的设计允许Provider在不关闭WebSocket连接的情况下动态附加/分离
   • 开发者可以在一个地方建立WebSocket连接，然后根据需要让多个Provider共享这个连接

2. 服务端架构调整

   • 将Hocuspocus核心逻辑与Web服务器实现解耦
   • 这种分离使得框架可以更灵活地适配不同的Web服务器实现
   • 开发者现在可以更自由地选择底层Web服务器技术栈

3. Tiptap Cloud集成

   • 将TiptapCollabProvider迁移到了@tiptap-cloud/provider包
   • 这一变化为未来与Tiptap Cloud服务的深度集成奠定了基础

兼容性与升级建议

虽然Hocuspocus v3.1.0在设计上做了重大调整，但团队确保了良好的向后兼容性：

• Hocuspocus服务端v3可以与客户端v2协同工作
• 反过来，客户端v3也可以与服务端v2配合使用
• 不过官方推荐同时升级客户端和服务端以获得最佳体验

需要注意的是，这个版本要求使用Tiptap v3作为基础编辑器框架。Tiptap v3带来了许多性能优化和新特性，与Hocuspocus v3的改进相得益彰。

开发者体验优化

1. 参数传递简化

   • 移除了专门的parameters参数
   • 现在所有参数都通过URL传递，使接口更加统一

2. 连接管理API改进

   • 移除了容易引起混淆的connect方法
   • 采用更直观的创建/销毁模式管理Provider生命周期

3. 新增beforeSync钩子

   • 提供了在文档同步前进行预处理的能力
   • 开发者可以在这个阶段修改文档内容或执行验证逻辑

性能与稳定性增强

1. 内存泄漏修复

   • 解决了Direct Connection模式下的内存泄漏问题
   • 提升了长时间运行时的稳定性

2. 连接处理优化

   • 改进了在快速断开连接情况下的处理逻辑
   • 减少了异常情况下可能出现的资源泄漏

3. 心跳机制重构

   • 将ping-pong逻辑从Connection移到ClientConnection
   • 使连接状态管理更加清晰可靠

技术生态适配

1. Web服务器示例

   • 新增了基于Hono框架的集成示例
   • 展示了如何将Hocuspocus与不同的Web框架结合

2. 依赖更新

   • 升级了多个核心依赖，包括Koa、Vite和Next.js
   • 确保框架能够利用最新依赖版本的安全性和性能改进

总结

Hocuspocus v3.1.0标志着这个协同编辑框架进入了一个更加成熟和灵活的发展阶段。通过架构重构和API优化，它不仅提供了更好的开发体验，也为未来的功能扩展打下了坚实基础。对于正在使用或考虑采用协同编辑功能的开发者来说，这个版本值得认真评估和升级。