GrapesJS 排序器(Sorter)模块的重构与优化

背景与问题分析

GrapesJS 是一个强大的 Web 页面构建器框架，其中的 Sorter 模块负责处理元素在画布中的拖放排序功能。在项目迭代过程中，开发团队发现原有实现存在几个关键问题：

1. 代码耦合度高：Sorter 类与特定模型实现(如 Component 或 Layers)紧密耦合，缺乏灵活性
2. 功能边界模糊：排序逻辑与拖放验证逻辑混杂在一起，职责不清晰
3. 维护困难：随着功能增加，代码变得难以理解和扩展

重构方案设计

1. 抽象化树结构依赖

重构后的 Sorter 不再直接依赖具体模型，而是通过配置项接收一个通用的 canMove 函数。这个函数负责判断源元素是否可以移动到目标位置：

export interface SorterOptions {
  container?: HTMLElement;
  canMove: (targetModel: Model<any>, srcModel: Model<any>, index: number) => Boolean;
  // 其他配置项...
}

这种设计带来了几个优势：

• 可复用性：同一 Sorter 实例可适用于不同场景
• 灵活性：不同场景可以自定义移动验证逻辑
• 可测试性：canMove 函数可以单独测试

2. 功能模块拆分

将原先庞大的 Sorter 类拆分为两个核心模块：

DropLocationDeterminer(位置确定器)

• 职责：计算元素应该放置的位置
• 输入：鼠标移动数据、被拖拽元素、树结构、canMove 函数
• 输出：最佳放置位置的索引

DragAndDropHandler(拖放处理器)

• 职责：管理拖放过程中的视觉元素
• 功能：
  • 创建和管理占位符
  • 处理拖拽辅助元素
  • 确保元素正确显示和定位

3. 集成现有验证逻辑

重构充分利用了项目中已有的 ComponentManager.canMove 方法，避免了代码重复并确保验证逻辑的一致性。特别增加了对主 Symbol 不能放入自身实例的检查，解决了特定场景下的边界问题。

实现细节与最佳实践

在实际实现中，团队遵循了几个关键原则：

1. 依赖倒置原则：高层模块不依赖低层模块，二者都依赖抽象
2. 单一职责原则：每个类/模块只做一件事并做好
3. 开闭原则：通过扩展而非修改来增加新功能

对于 StyleManager 中的 Layers 排序，配置如下：

new utils.Sorter({
  container: this.el,
  canMove: (targetModel, srcModel, index) => {
    return targetModel.view === this.el // 仅当目标是容器时才允许放置
  },
  em,
})

对于组件排序，则直接复用现有的验证逻辑：

new utils.Sorter({
  container: this.el,
  canMove: editor.Components.canMove,
  em,
})

重构效果评估

此次重构带来了显著的改进：

1. 代码质量提升：模块职责更清晰，耦合度降低
2. 维护成本降低：新增功能或修改现有功能更加容易
3. 性能优化：分离的模块使得性能调优更有针对性
4. 扩展性增强：支持更多场景的拖放排序需求

总结

GrapesJS 的 Sorter 模块重构展示了如何通过合理的抽象和模块划分来改进复杂交互组件的设计。这种模式不仅适用于拖放排序场景，也为项目中其他类似功能的开发提供了参考范例。关键在于识别核心职责、建立清晰边界，并通过配置化提高灵活性。