MoneyManagerEx中mmListCtrl控件的列排序优化实践

背景介绍

MoneyManagerEx作为一款开源的个人财务管理软件，其交易列表视图使用了基于wxWidgets的mmListCtrl控件。在开发过程中，团队发现当用户在"计划交易"面板中移动列位置后，排序功能会出现异常。这引发了对整个列表控件列管理机制的深入分析和重构。

问题分析

核心问题源于列标识管理混乱，具体表现在：

1. 列标识类型混淆：代码中同时存在三种列标识方式：

   • 物理列序号（Visual Order）：用户实际看到的列位置
   • 逻辑列序号（Logical Number）：控件内部使用的列索引
   • 逻辑列ID（Logical ID）：枚举定义的常量值

2. 排序功能失效：当用户通过拖拽调整列位置后，排序功能无法正确识别要排序的列，因为排序逻辑使用的是物理列序号而非逻辑列ID。

3. 状态保存问题：列顺序、宽度、排序状态等信息分散存储，维护困难。

技术解决方案

1. 列标识系统重构

团队对列标识系统进行了彻底重构：

// 旧实现
enum EColumn { COL_DATE, COL_PAYEE, ... }; // 列ID定义
std::vector<int> m_real_columns; // 列序号到列ID的映射

// 新实现
enum LIST_COL { LIST_COL_DATE, LIST_COL_PAYEE, ... }; // 更清晰的命名
std::map<int, int> m_column_order; // 列序号到列ID的映射

新增了完善的转换方法：

• getColumnId()：列序号→列ID
• getColumnNr()：列ID→列序号
• getColIdFromOrder()：物理列位置→列ID

2. 排序逻辑修正

排序功能现在统一使用逻辑列ID：

// 旧实现：直接使用物理列序号排序
sortTable(m_selected_col); 

// 新实现：转换为逻辑列ID后再排序
int col_id = getColumnId(m_selected_col);
sortTable(col_id);

3. 状态存储优化

将分散的列配置整合为JSON格式统一存储：

{
  "col_nr_id": [0,22,1,2,4,5,6,8,7,10,11,14,21,9,16,17],
  "col_id_width": [25,-1,87,93,70,123,158,41,150,250,100,97,-2,-2,250,-1,100,100,100,100,100,-1,50],
  "col_id_hidden": [0,1,9,21],
  "sort_col_id": [6,8],
  "sort_asc": [false,false]
}

这种结构具有以下优点：

• 所有列配置集中管理
• 扩展性强，易于添加新属性
• 可读性好，便于调试

4. 拖拽交互处理

针对Windows平台特有的拖拽列问题，团队发现：

1. wxListCtrl在拖拽后不会自动更新逻辑列序号
2. 需要手动处理EVT_LIST_COL_DRAGGING事件
3. 通过GetColumnIndexFromOrder()进行物理位置到逻辑位置的转换

解决方案是增加拖拽事件处理逻辑，确保视觉顺序与逻辑顺序同步。

实现细节

列移动处理

正确处理列移动操作需要：

1. 更新列序号到列ID的映射
2. 保持隐藏列状态
3. 维护排序状态

void mmListCtrl::onHeaderMove(wxListEvent& event)
{
    int col_nr = event.GetColumn();
    int new_pos = GetColumnOrder(col_nr);
    
    // 更新列顺序映射
    auto it = m_column_order.find(col_nr);
    if (it != m_column_order.end()) {
        int col_id = it->second;
        m_column_order.erase(it);
        m_column_order[new_pos] = col_id;
    }
    
    event.Skip();
}

跨平台兼容性

考虑到不同平台的差异：

• Windows：需要特殊处理拖拽事件
• macOS：需要测试键盘移动列功能
• Linux：确保GTK版本兼容性

经验总结

1. 标识系统设计：在复杂UI控件中，明确定义不同维度的标识（ID、序号、位置）至关重要。

2. 状态管理：集中式状态管理（如JSON）比分散存储更易于维护。

3. 平台差异：GUI控件的交互行为可能存在平台差异，需要针对性测试。

4. 渐进式重构：大规模重构应分步骤进行，确保每一步都保持功能完整。

这次重构不仅解决了原始bug，还提升了代码的可维护性和扩展性，为MoneyManagerEx未来的功能开发奠定了更好的基础。