如何在Apache POI中获取数据透视字段项并实现多项目选删？

使用Apache POI创建Excel数据透视表后，需要访问特定数据透视字段的显式项列表（默认状态为全选），并通过编程方式选择或移除列表中的部分项目。希望找到Apache POI的规范实现方案，也接受Aspose的替代方案。当前已实现一个临时解决方法，但需要大量修改底层XML结构，希望避免这种操作。

Apache POI 5.x及以上版本提供了更友好的API，可以直接通过操作数据透视表的缓存字段和项属性来实现筛选，无需手动修改底层XML。核心思路是：启用字段的多选模式，遍历缓存项并设置对应项的隐藏状态。

import org.apache.poi.xssf.usermodel.XSSFPivotTable;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTPivotField;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTItem;

import java.util.List;

public void setPivotFieldFilter(XSSFPivotTable pivotTable, String fieldName, List<String> keepValues) {
    // 获取目标字段的索引
    int fieldIndex = pivotTable.findColumnIndex(fieldName);
    if (fieldIndex == -1) {
        throw new IllegalArgumentException("指定字段不存在: " + fieldName);
    }

    CTPivotField pivotField = pivotTable.getCTPivotTableDefinition()
            .getPivotFields().getPivotFieldArray(fieldIndex);
    // 启用字段的多选模式
    pivotField.setMultipleItemSelectionAllowed(true);

    // 获取字段对应的缓存项集合
    var cacheField = pivotTable.getPivotCacheDefinition().getCTPivotCacheDefinition()
            .getCacheFields().getCacheFieldArray(fieldIndex);
    var sharedItems = cacheField.getSharedItems();

    // 遍历所有项，设置隐藏状态：不在保留列表中的项标记为隐藏
    for (int i = 0; i < sharedItems.sizeOfSArray(); i++) {
        String itemValue = sharedItems.getSArray(i).getV();
        CTItem item = pivotField.getItems().getItemArray(i);
        
        // 取消默认全选的T属性，绑定到缓存项的索引
        item.unsetT();
        item.setX((long) i);
        
        // 设置隐藏属性：不在keepValues中的项隐藏
        item.setH(!keepValues.contains(itemValue));
    }
}

关键说明 #

• 先启用MultipleItemSelectionAllowed，确保支持多选筛选
• 取消项的T属性（默认全选时为"default"），通过X属性绑定到缓存项的索引
• 通过setH(true)标记不需要显示的项，实现筛选效果
• 该方案无需手动添加虚拟项，避免了底层XML的复杂修改，兼容性更好

Aspose.Cells的API封装更为完善，无需接触底层结构，直接通过PivotField和PivotItem的可见性设置即可实现筛选，代码更简洁易维护。

import com.aspose.cells.PivotField;
import com.aspose.cells.PivotTable;
import com.aspose.cells.Workbook;
import com.aspose.cells.Worksheet;

import java.util.List;

public void setPivotFieldFilter(Workbook workbook, String pivotSheetName, String pivotTableName, String fieldName, List<String> keepValues) throws Exception {
    Worksheet pivotSheet = workbook.getWorksheets().get(pivotSheetName);
    PivotTable pivotTable = pivotSheet.getPivotTables().get(pivotTableName);

    PivotField pivotField = pivotTable.getPivotFields().get(fieldName);
    // 启用多选模式
    pivotField.setMultipleItemSelectionAllowed(true);

    // 先清除所有选中状态，再勾选需要保留的项
    pivotField.clearAll();
    for (String value : keepValues) {
        pivotField.getPivotItems().get(value).setVisible(true);
    }

    // 刷新并计算透视表数据
    pivotTable.refreshData();
    pivotTable.calculateData();
}

关键说明 #

• 直接通过PivotItem.setVisible()控制项的显示/隐藏
• 调用clearAll()重置所有选中状态，再精确选择需要保留的项
• 最后刷新透视表确保数据生效，操作逻辑直观清晰

你当前的临时方案通过手动添加虚拟项并修改XML结构实现筛选，但存在以下不足：

• 需要手动维护虚拟项，容易引发Excel兼容性问题
• 直接操作底层XML，后续POI版本更新可能导致代码失效
• 代码可读性差，长期维护成本高

上述两种规范方案均避免了直接修改底层XML结构，更符合API设计规范，稳定性和可维护性更强。

内容的提问来源于stack exchange，提问作者GVA32156