JAVA：Apache Commons 高效处理 CSV 文件的技术指南-拾荒的小海螺

1、简述

在 Java 开发中，CSV（Comma-Separated Values，逗号分隔值）是一种常见的数据存储格式，广泛用于数据交换和简单的存储任务。Apache Commons CSV 是 Apache 提供的一个轻量级库，专注于简化 CSV 文件的解析和生成，支持多种 CSV 格式，如 Excel、RFC 4180、MySQL 等。

本文将介绍 Commons CSV 的核心功能，并通过多个详细的使用示例展示其在 CSV 文件解析和生成中的强大功能。

2、为什么选择 Commons CSV？

轻量级：无需庞大的依赖，功能集中。
支持多种格式：兼容 Excel、RFC 4180、Tab 分隔等格式。
简单易用：API 设计清晰，易于上手。
灵活性高：支持自定义分隔符、自定义换行符等多种配置。

在使用 Commons CSV之前，需要添加其依赖。以下是 Commons CSV 的 Maven 依赖：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-csv</artifactId>
    <version>1.10.0</version>
</dependency>

3、使用样例

Spring Boot 集成 Commons CSV 常见的使用样例，以下举例供参考：

3.1 写入 CSV 文件

Commons CSV 同样支持轻松生成 CSV 文件：

package com.lm.csv.example;

import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVPrinter;

import java.io.FileWriter;
import java.io.IOException;

public class CsvWriterExample {
    public static void main(String[] args) throws IOException {
        // 创建 CSV 文件
        try (FileWriter writer = new FileWriter("e:\\csv\\output.csv");
             CSVPrinter printer = new CSVPrinter(writer, CSVFormat.DEFAULT
                     .withHeader("ID", "Name", "Age", "Email"))) {

            printer.printRecord("1", "Alice", "25", "alice@example.com");
            printer.printRecord("2", "Bob", "30", "bob@example.com");
            printer.printRecord("3", "Charlie", "35", "charlie@example.com");
        }
    }
}

3.2 使用自定义分隔符

如果需要自定义分隔符（例如分号 :），可以通过配置实现：

package com.lm.csv.example;

import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVPrinter;

import java.io.FileWriter;

public class CustomDelimiterExample {
    public static void main(String[] args) throws Exception {
        try (FileWriter writer = new FileWriter("e:\\csv\\custom_delimiter.csv");
             CSVPrinter printer = new CSVPrinter(writer, CSVFormat.DEFAULT
                     .withHeader("ID", "Name", "Age", "Email")
                     .withDelimiter(':'))) {

            printer.printRecord("1", "Diana", "40", "diana@example.com");
            printer.printRecord("2", "Eve", "22", "eve@example.com");
        }
    }
}

3.3 解析嵌套引号或特殊字符

CSV 文件中可能包含嵌套引号或特殊字符（如换行符），Commons CSV 能轻松解析：

package com.lm.csv.example;

import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;

import java.io.StringReader;

public class SpecialCharacterExample {
    public static void main(String[] args) throws Exception {
        String csvData = "ID,Name,Notes\n" +
                "1,\"John\",\"Loves coding\nand teaching\"\n" +
                "2,\"Jane\",\"Enjoys reading\"";

        try (CSVParser parser = CSVFormat.DEFAULT
                .withFirstRecordAsHeader()
                .parse(new StringReader(csvData))) {

            parser.forEach(record -> {
                String id = record.get("ID");
                String name = record.get("Name");
                String notes = record.get("Notes");

                System.out.printf("ID: %s, Name: %s, Notes: %s%n", id, name, notes);
            });
        }
    }
}

3.4 使用枚举映射字段

对于字段定义明确的 CSV 文件，可以使用枚举来避免硬编码字段名称：

package com.lm.csv.example;

import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;
import org.apache.commons.csv.CSVRecord;

import java.io.FileReader;

public class EnumFieldExample {
    enum Header {
        ID, Name, Age, Email
    }

    public static void main(String[] args) throws Exception {
        try (FileReader reader = new FileReader("e:\\csv\\output.csv");
             CSVParser parser = CSVFormat.DEFAULT
                     .withFirstRecordAsHeader()
                     .parse(reader)) {

            for (CSVRecord record : parser) {
                String id = record.get(Header.ID);
                String name = record.get(Header.Name);
                String age = record.get(Header.Age);
                String email = record.get(Header.Email);

                System.out.printf("ID: %s, Name: %s, Age: %s, Email: %s%n", id, name, age, email);
            }
        }
    }
}

4、总结

Apache Commons CSV 是处理 CSV 文件的高效工具，无论是解析复杂的 CSV 数据还是生成自定义格式的 CSV 文件，都能提供简洁高效的解决方案。

优点：

轻量级且易于使用。
丰富的功能支持，如自定义分隔符、多格式支持。
提供全面的 CSV 文件读取和写入功能。

适用场景：

数据导入和导出。
数据转换和清洗。
作为应用程序中的轻量级数据库。
通过本文的示例，希望你能够快速掌握 Commons CSV 的使用方法，并灵活应用于实际项目中！

目录CONTENT

JAVA：Apache Commons 高效处理 CSV 文件的技术指南