SitePen/dgrid项目：从dojox/grid迁移到dgrid的API对比指南

前言

在现代Web开发中，数据表格组件是展示结构化数据的核心工具。本文将深入分析传统dojox/grid组件与现代化dgrid组件在API设计上的差异，帮助开发者顺利完成技术栈迁移。

核心属性对比

排序功能实现差异

在dojox/grid中，sortInfo属性用于存储排序信息，而dgrid采用了更现代的getter/setter模式：

• 通过grid.get("sort")获取当前排序状态
• 排序参数格式与Store模块的sort方法完全兼容

选择功能演进

选择功能在dgrid中通过Mixin模式实现模块化设计：

• Selector混入提供间接选择功能
• Selection和CellSelection混入支持多种选择模式：
  • none：禁用选择
  • single：单选模式
  • multiple：多选模式
  • extended：扩展选择模式（默认）

列操作功能

列重排序功能在dgrid中通过ColumnReorder扩展实现，相比dojox/grid的columnReordering属性：

• 使用reorderable属性控制单列是否可重排序
• 默认支持拖拽操作，无需额外配置

上下文菜单实现方案

dgrid没有内置的上下文菜单组件，但提供了灵活的事件处理机制：

1. 事件监听配置示例：

// 表头上下文菜单
on(".dgrid-header:contextmenu", function(evt){
    // 阻止默认菜单
    evt.preventDefault();
    
    // 获取当前行信息
    const rowInfo = grid.row(evt);
    
    // 自定义菜单逻辑
    showCustomMenu(evt.pageX, evt.pageY, rowInfo.data);
});

2. 与Dijit菜单集成技巧：

// 使用Dijit菜单的特殊打开方式
menu._scheduleOpen(this, null, { 
    x: evt.pageX, 
    y: evt.pageY 
});

列定义规范对比

dgrid采用更灵活的列定义方式：

基础结构定义

• columns：简单表格结构（数组或对象）
• subRows：多行复杂表格结构
• columnSets：多区域表格结构（需配合ColumnSet混入）

字段处理差异

1. 字段定义：

• 支持传统的field属性
• 支持特殊的"_item"值引用完整数据项
• 对象形式的columns定义时，属性名自动作为字段名

2. 数据获取：

• get方法只接收当前数据项参数
• 不支持fields属性，复杂数据需自定义getter

单元格渲染控制

dgrid提供两种渲染控制方式：

1. formatter：格式化文本内容
2. renderCell：完全控制DOM节点生成

对于需要嵌入Widget的复杂场景，推荐使用renderCell方法。

重要方法迁移指南

数据操作方法

1. 数据获取：

• 替代getItem：通过事件对象的data属性获取

grid.on(".dgrid-row:click", function(evt){
    const rowData = grid.row(evt).data;
});

2. 数据源管理：

• setStore → set("collection", store)
• setQuery → 使用Store的filter功能

选择集操作

替代removeSelectedRows的现代实现：

// 批量删除选中项
Object.keys(grid.selection).forEach(id => {
    grid.collection.remove(id);
});

最佳实践建议

1. 样式控制：

• 使用CSS而非width属性控制列宽
• 通过.field-<name>类选择器定位特定列

2. 安全防护：

• 默认开启HTML转义，防范XSS攻击
• 仅在可信数据场景下关闭转义

3. 性能优化：

• 避免直接操作DOM，利用dgrid的渲染周期
• 大数据集使用分页扩展

总结

从dojox/grid迁移到dgrid不仅是API的变更，更是开发思维的升级。dgrid的模块化设计、现代化的数据绑定机制以及与Dojo Store的深度集成，为开发者提供了更强大、更灵活的数据表格解决方案。通过本文的对比分析，开发者可以更顺利地完成技术迁移，构建更高效的Web应用。