跳转至

如何在 Java 中读取 CSV 文件

简介

CSV（Comma-Separated Values）是一种常见的文件格式，用于存储表格数据，数据项之间通常用逗号分隔。在 Java 开发中，经常会遇到需要读取 CSV 文件的场景，例如处理数据导入、数据迁移等。本文将详细介绍在 Java 中读取 CSV 文件的基础概念、使用方法、常见实践以及最佳实践，帮助读者深入理解并高效使用 Java 读取 CSV 文件。

目录

  1. 基础概念
  2. 使用方法
    • 使用 Java 标准库读取 CSV
    • 使用第三方库 Apache Commons CSV 读取 CSV
  3. 常见实践
    • 处理 CSV 文件中的表头
    • 处理包含特殊字符的 CSV 文件
  4. 最佳实践
    • 异常处理
    • 资源管理
  5. 小结
  6. 参考资料

基础概念

CSV 文件格式

CSV 文件是一种纯文本文件，其数据以表格形式存储，每行代表一条记录，每个字段之间用逗号分隔。例如：

Name,Age,City
John,25,New York
Jane,30,Los Angeles

在这个例子中，第一行是表头，包含字段名称，后续行是实际的数据记录。

Java 读取 CSV 文件的原理

Java 读取 CSV 文件的基本原理是逐行读取文件内容，然后根据逗号分隔符将每行数据拆分成字段。可以使用 Java 标准库的 BufferedReader 类逐行读取文件，也可以使用第三方库来简化操作。

使用方法

使用 Java 标准库读取 CSV

以下是一个使用 Java 标准库读取 CSV 文件的示例代码：

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;

public class ReadCSVWithStandardLibrary {
    public static void main(String[] args) {
        String csvFile = "data.csv";
        String line;
        String csvSplitBy = ",";

        try (BufferedReader br = new BufferedReader(new FileReader(csvFile))) {
            while ((line = br.readLine()) != null) {
                String[] data = line.split(csvSplitBy);
                for (String field : data) {
                    System.out.print(field + " ");
                }
                System.out.println();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中，我们使用 BufferedReader 逐行读取 CSV 文件，然后使用 split 方法根据逗号分隔符将每行数据拆分成字段。

使用第三方库 Apache Commons CSV 读取 CSV

Apache Commons CSV 是一个流行的第三方库，用于处理 CSV 文件。以下是一个使用 Apache Commons CSV 读取 CSV 文件的示例代码：

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

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

public class ReadCSVWithApacheCommons {
    public static void main(String[] args) {
        String csvFile = "data.csv";

        try (Reader reader = new FileReader(csvFile);
             CSVParser csvParser = new CSVParser(reader, CSVFormat.DEFAULT)) {

            for (CSVRecord csvRecord : csvParser) {
                // Accessing values by column index
                String name = csvRecord.get(0);
                String age = csvRecord.get(1);
                String city = csvRecord.get(2);

                System.out.println("Name: " + name + ", Age: " + age + ", City: " + city);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中，我们使用 CSVParser 解析 CSV 文件，并使用 CSVRecord 访问每行数据的字段。

常见实践

处理 CSV 文件中的表头

在实际应用中，CSV 文件通常包含表头。我们可以使用 Apache Commons CSV 轻松处理表头：

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

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

public class ReadCSVWithHeader {
    public static void main(String[] args) {
        String csvFile = "data.csv";

        try (Reader reader = new FileReader(csvFile);
             CSVParser csvParser = new CSVParser(reader, CSVFormat.DEFAULT.withHeader())) {

            for (CSVRecord csvRecord : csvParser) {
                // Accessing values by column name
                String name = csvRecord.get("Name");
                String age = csvRecord.get("Age");
                String city = csvRecord.get("City");

                System.out.println("Name: " + name + ", Age: " + age + ", City: " + city);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中，我们使用 withHeader() 方法指定 CSV 文件包含表头，并使用列名访问字段。

处理包含特殊字符的 CSV 文件

如果 CSV 文件中包含特殊字符（如逗号、引号等），可以使用 CSVFormat 的 withQuote() 和 withEscape() 方法进行处理：

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

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

public class ReadCSVWithSpecialCharacters {
    public static void main(String[] args) {
        String csvFile = "data.csv";

        try (Reader reader = new FileReader(csvFile);
             CSVParser csvParser = new CSVParser(reader, CSVFormat.DEFAULT
                     .withQuote('"')
                     .withEscape('\\'))) {

            for (CSVRecord csvRecord : csvParser) {
                // Accessing values
                for (String field : csvRecord) {
                    System.out.print(field + " ");
                }
                System.out.println();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中，我们使用 withQuote('"') 和 withEscape('\\') 方法处理包含引号和转义字符的 CSV 文件。

最佳实践

异常处理

在读取 CSV 文件时，可能会出现各种异常，如文件不存在、文件读取错误等。因此，我们应该在代码中进行适当的异常处理：

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

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

public class ReadCSVWithExceptionHandling {
    public static void main(String[] args) {
        String csvFile = "data.csv";

        try (Reader reader = new FileReader(csvFile);
             CSVParser csvParser = new CSVParser(reader, CSVFormat.DEFAULT)) {

            for (CSVRecord csvRecord : csvParser) {
                // Process data
            }
        } catch (IOException e) {
            System.err.println("Error reading CSV file: " + e.getMessage());
        }
    }
}

在这个示例中，我们使用 try-with-resources 语句自动关闭文件资源，并捕获 IOException 异常进行处理。

资源管理

为了避免资源泄漏，我们应该确保在使用完文件资源后及时关闭。使用 try-with-resources 语句可以简化资源管理：

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

import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;

public class ReadCSVWithResourceManagement {
    public static void main(String[] args) {
        String csvFile = "data.csv";

        try (Reader reader = new FileReader(csvFile);
             CSVParser csvParser = new CSVParser(reader, CSVFormat.DEFAULT)) {

            for (CSVRecord csvRecord : csvParser) {
                // Process data
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

在这个示例中，try-with-resources 语句会自动关闭 Reader 和 CSVParser 资源。

小结

本文介绍了在 Java 中读取 CSV 文件的基础概念、使用方法、常见实践以及最佳实践。我们可以使用 Java 标准库或第三方库（如 Apache Commons CSV）来读取 CSV 文件。在实际应用中，我们应该注意处理表头、特殊字符、异常处理和资源管理等问题，以确保代码的健壮性和可靠性。

参考资料