AG Grid 中通过API设置默认排序的最佳实践

问题背景

在AG Grid数据表格组件的实际应用中，开发者经常需要保存和恢复用户的表格状态偏好，包括列排序、过滤条件和列顺序等。在AG Grid v21版本中，开发者可以通过setSortModel方法来实现排序状态的设置，但在最新版本(v33.2.1)中，这一API发生了变化。

解决方案

在AG Grid最新版本中，推荐使用applyColumnState方法来设置表格的排序状态。这个方法提供了更强大和灵活的方式来控制列的各种状态，包括排序、可见性、宽度等。

核心API解析

applyColumnState是Grid API的一部分，它允许开发者通过一个配置对象来批量设置列的多种状态。对于排序功能，主要使用其中的sort属性。

具体实现示例

// 假设我们要设置第一列升序排序
gridApi.applyColumnState({
  state: [
    {
      colId: 'make',  // 列ID
      sort: 'asc'     // 排序方向: 'asc'或'desc'
    }
  ],
  defaultState: { sort: null }  // 其他列的默认状态
});

高级用法

1. 多列排序：可以同时设置多个列的排序状态

   gridApi.applyColumnState({
     state: [
       { colId: 'make', sort: 'asc' },
       { colId: 'price', sort: 'desc' }
     ]
   });
   

2. 与保存状态配合使用：通常我们会将用户的状态偏好保存起来

   // 保存状态
   const columnState = gridApi.getColumnState();
   localStorage.setItem('gridState', JSON.stringify(columnState));
   
   // 恢复状态
   const savedState = JSON.parse(localStorage.getItem('gridState'));
   gridApi.applyColumnState({ state: savedState });
   

版本兼容性说明

对于从旧版本迁移到新版本的开发者，需要注意：

1. v21中的setSortModel已被弃用
2. 新版本的API设计更加统一，通过applyColumnState可以处理多种列状态
3. 排序状态的格式也发生了变化，更加简洁直观

最佳实践建议

1. 在组件初始化完成后立即应用保存的状态
2. 考虑添加状态变化的监听器，及时保存用户的最新偏好
3. 对于复杂的应用，可以将表格状态管理抽象为独立的服务
4. 处理异常情况，如列定义发生变化时保存的状态可能失效

通过掌握applyColumnState方法，开发者可以更灵活地控制AG Grid的排序行为，为用户提供更加个性化的表格体验。