Java读取Excel保持列顺序技巧

在Java中读取Excel文件时，如何保持列的原始顺序至关重要，尤其是在后续需要按原顺序写回Excel的场景下。传统的HashMap无法保证元素的插入顺序，因此本文重点介绍如何利用LinkedHashMap这一实用方法来解决此问题。LinkedHashMap继承自HashMap，但它通过维护一个双向链表，能够记录元素的插入顺序，从而确保从Excel读取数据并存储为List

理解Map的顺序特性

在Java集合框架中，Map接口有多种实现类，它们在键值对的存储和检索方式上有所不同，尤其是在顺序性方面：

• HashMap: 这是最常用的Map实现，它提供了O(1)的平均时间复杂度进行插入、删除和查找操作。然而，HashMap不保证任何迭代顺序，其元素的顺序可能随时间变化，甚至在相同的元素集上，不同的JVM实现或运行环境都可能产生不同的顺序。因此，如果需要保持插入顺序，HashMap不是一个合适的选择。
• LinkedHashMap: LinkedHashMap继承自HashMap，并额外维护了一个双向链表来记录元素的插入顺序。这意味着当你遍历LinkedHashMap时，元素的顺序将与它们被插入时的顺序完全一致。这对于需要保留原始数据顺序的场景（如Excel列顺序）非常有用。
• TreeMap: TreeMap实现了SortedMap接口，它根据键的自然顺序（对于字符串是字母顺序）或者在创建TreeMap时提供的Comparator进行排序。虽然TreeMap也提供有序性，但它的顺序是基于键的排序规则，而非插入顺序。因此，如果你的目标是保持Excel的原始列顺序（即从左到右的物理顺序），LinkedHashMap通常是更直接和合适的选择。

解决方案：使用LinkedHashMap保持列顺序

为了确保从Excel读取数据并存储为List>时能够保持原始的列顺序，我们需要将存储每行数据的HashMap替换为LinkedHashMap。LinkedHashMap会按照键值对被插入的顺序来维护内部结构，从而完美地解决了列顺序混淆的问题。

以下是修改后的Java代码示例：

import org.apache.poi.ss.usermodel.*;
import java.util.*;
import java.util.stream.Collectors;

public class ExcelReaderWithOrder {

    /**
     * 从Excel工作表中读取数据，并以List>的形式返回，
     * 其中Map内部的键值对顺序与Excel列的物理顺序保持一致。
     *
     * @param sheet 要读取的Excel工作表对象
     * @return 包含Excel数据的List，每个Map代表一行，键为列名，值为单元格内容
     */
    public static List> readExcelSheet(Sheet sheet) {
        Iterator rows = sheet.iterator();

        // 如果工作表为空，则返回空列表
        if (!rows.hasNext()) {
            return Collections.emptyList();
        }

        // 读取第一行作为表头，提取列名
        Row header = rows.next();
        List keys = new ArrayList<>();
        for (Cell cell : header) {
            String value = cell.getStringCellValue();
            // 仅添加非空的列名，遇到空列名则停止，假定后续无有效列
            if (!value.isEmpty()) {
                keys.add(value);
            } else {
                break;
            }
        }

        List> result = new ArrayList<>();

        // 遍历剩余的行数据
        while (rows.hasNext()) {
            Row row = rows.next();
            // 关键改动：使用LinkedHashMap来保证列的插入顺序
            Map rowMap = new LinkedHashMap<>(); 

            // 遍历表头定义的列，填充当前行的数据
            for (int i = 0; i < keys.size(); ++i) {
                // 获取单元格，如果单元格不存在则创建为空白单元格
                Cell cell = row.getCell(i, Row.MissingCellPolicy.CREATE_NULL_AS_BLANK);
                String value;
                // 将单元格内容转换为字符串
                value = cell.toString(); 
                rowMap.put(keys.get(i), value);
            }

            // 仅添加非空行到结果列表
            // 判断条件：如果所有值都不是空字符串，则认为该行有效
            if (!rowMap.values().stream().allMatch(String::isEmpty)) {
                result.add(rowMap);
            }
        }

        return result;
    }

    public static void main(String[] args) {
        // 示例用法：假设你有一个Workbook对象
        // Workbook workbook = new XSSFWorkbook("your_excel_file.xlsx");
        // Sheet sheet = workbook.getSheetAt(0); // 获取第一个工作表
        // List> data = readExcelSheet(sheet);
        // System.out.println(data);

        // 模拟一个Sheet对象和数据进行测试
        // 实际应用中需要引入Apache POI库并加载真实的Excel文件
        // 这里仅为演示LinkedHashMap效果
        System.out.println("--- 模拟Excel数据读取 ---");
        // 模拟表头
        List mockHeaders = Arrays.asList("column 1", "column2");
        // 模拟数据行
        List> mockRows = new ArrayList<>();
        mockRows.add(Arrays.asList("value1", "value2"));
        mockRows.add(Arrays.asList("value3", "value4"));

        // 手动构建预期结果，以验证LinkedHashMap的顺序
        List> expectedOutput = new ArrayList<>();
        Map row1 = new LinkedHashMap<>();
        row1.put("column 1", "value1");
        row1.put("column2", "value2");
        expectedOutput.add(row1);

        Map row2 = new LinkedHashMap<>();
        row2.put("column 1", "value3");
        row2.put("column2", "value4");
        expectedOutput.add(row2);

        System.out.println("预期输出 (LinkedHashMap):");
        expectedOutput.forEach(map -> {
            map.forEach((key, value) -> System.out.println("  " + key + " -> " + value));
        });
        System.out.println("\n实际模拟代码运行效果 (如果使用LinkedHashMap，效果将与预期一致):");
        // 在实际的readExcelSheet方法中，如果将HashMap改为LinkedHashMap，
        // 那么输出的Map内部顺序将是"column 1", "column2"
        // 这里的main方法只是演示，readExcelSheet需要真实的POI Sheet对象
    }
}

代码解析：

核心的改动在于将 Map rowMap = new HashMap<>(); 替换为 Map rowMap = new LinkedHashMap<>();。通过这一简单的更改，rowMap将自动维护键值对的插入顺序，即按照Excel表头中列的从左到右顺序。

注意事项

1. 依赖管理: 上述代码使用了Apache POI库来处理Excel文件。在实际项目中，你需要确保项目中已正确引入Apache POI的依赖（例如，在Maven项目中添加poi和poi-ooxml依赖）。
2. 单元格类型处理: 示例代码中使用了cell.toString()来获取单元格的值。这会将所有单元格内容统一转换为字符串。在实际应用中，如果Excel单元格包含数字、日期、布尔值等不同类型的数据，你可能需要根据cell.getCellType()来判断单元格类型，并使用更具体的方法（如getNumericCellValue()、getDateCellValue()等）来获取数据，以避免数据转换错误或精度丢失。
3. 空列名处理: 代码中在读取表头时，如果遇到空字符串的列名，会立即停止读取后续列。这假定Excel表头是连续的，且空列名意味着没有更多的有效列。根据实际的Excel文件结构，你可能需要调整这个逻辑。
4. 空行过滤: 代码中通过!rowMap.values().stream().allMatch(String::isEmpty)来过滤掉所有单元格都为空的行。这有助于清理数据，避免处理不必要的空白行。
5. 错误处理: 在实际的生产环境中，需要考虑更多的错误处理机制，例如文件不存在、文件格式错误、权限问题等。

总结

当从Excel文件中读取数据并希望保留原始的列顺序时，LinkedHashMap是Java中一个非常有效的解决方案。它通过维护插入顺序的特性，确保了Map中键值对的顺序与Excel工作表中的列顺序保持一致。这对于后续的数据处理、数据校验或将数据写回Excel等操作都至关重要。理解不同Map实现类的特性，并根据具体需求选择合适的工具，是高效和健壮编程的关键。

今天关于《Java读取Excel保持列顺序技巧》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！