Apache Commons CSV 基本使用

訾博ZiBo

发布于 2025-01-06 19:41:22

20200

代码可运行

文章被收录于专栏：全栈开发工程师全栈开发工程师

运行总次数：0

代码可运行

Apache Commons CSV 基本使用

一、概述

1、简介

Apache Commons CSV是Apache软件基金会的一个开源项目，它提供了用于读取和写入CSV（逗号分隔值）文件的Java库。CSV是一种常见的文本文件格式，用于存储以逗号为分隔符的表格数据。

Apache Commons CSV提供了简单而灵活的API，使您能够轻松地处理CSV文件。它支持自定义分隔符、引用字符和转义字符，可以处理包含换行符和特殊字符的字段，并提供了方便的方法来读取和写入CSV数据。

2、主要特点

读取和写入CSV文件：您可以使用该库来读取现有的CSV文件，并从中提取数据。您还可以使用它来创建新的CSV文件并将数据写入其中。
自定义格式选项：您可以定义CSV文件中的分隔符、引用字符和转义字符。这使您能够适应各种CSV文件的格式要求。
处理换行符和特殊字符：Apache Commons CSV支持处理包含换行符和特殊字符（如分隔符本身）的字段。它可以正确解析这些字段，并提供一致的访问方式。
灵活的数据访问：您可以使用索引或列名来访问CSV文件中的数据。该库提供了一种简单的方式来迭代和访问CSV文件的每一行和每个字段。
异常处理：Apache Commons CSV提供了有用的错误处理和异常处理机制。它可以检测和报告CSV文件中的格式错误，并提供相应的异常类型供您处理。

3、官方资料

主页地址：

https://commons.apache.org/proper/commons-csv/

文档：

https://commons.apache.org/proper/commons-csv/apidocs/index.html

二、基本使用

1、引入依赖

<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-csv -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-csv</artifactId>
    <version>1.10.0</version>
</dependency>

2、读取 `.csv` 文件

文件内容

文件编码是 UTF-8

读取文件

文件路径：C:\Users\Administrator\Desktop\hello.csv

package com.zibo;

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.nio.charset.StandardCharsets;
import java.util.List;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;
import org.apache.commons.csv.CSVRecord;

/**
 * @author zibo
 * @date 2023/6/10 19:25
 * @slogan 慢慢学，不要停。
 */
public class Hello {

    public static void main(String[] args) {
        try (Reader in = new FileReader("C:\\Users\\Administrator\\Desktop\\hello.csv", StandardCharsets.UTF_8)) {
            // 读取文件：CSVFormat.EXCEL 表示使用Excel风格的 CSV 格式进行解析
            CSVParser records = CSVFormat.EXCEL.parse(in);
            // 读取所有行
            List<CSVRecord> list = records.getRecords();
            // 遍历每一行
            for (CSVRecord record : list) {
                // 输出每一行的大小
                System.out.println(record.size());
                // 遍历每一行的每一列
                for (int i = 0; i < record.size(); i++) {
                    System.out.println(record.get(i));
                }
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

}

3、写入文件

写入文件

package com.zibo;

import java.io.FileWriter;
import java.io.IOException;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVPrinter;

public class CSVWriterExample {

    public static void main(String[] args) {
        try (FileWriter writer = new FileWriter("C:\\Users\\Administrator\\Desktop\\study.csv");
            CSVPrinter csvPrinter = new CSVPrinter(writer, CSVFormat.DEFAULT)) {
            csvPrinter.printRecord("第一行第一列", "第一行第二列");
            csvPrinter.printRecord("第二行第一列", "第二行第二列");
            csvPrinter.flush();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}