跳转至

Java 创建 CSV 文件：从基础到最佳实践

简介

在数据处理和存储领域，CSV（逗号分隔值）文件是一种常用的文件格式，它以纯文本形式存储表格数据，数据字段之间用逗号分隔。在 Java 中，创建 CSV 文件是一项常见的任务，无论是处理小型数据集还是构建企业级应用程序中的数据导出功能，都可能会用到。本文将深入探讨在 Java 中创建 CSV 文件的相关知识，帮助你全面掌握这一技能。

目录

  1. 基础概念
  2. 使用方法
    • 使用原生 Java 实现
    • 使用 OpenCSV 库实现
    • 使用 Apache Commons CSV 库实现
  3. 常见实践
    • 写入简单数据
    • 处理复杂数据结构
    • 设置文件编码
  4. 最佳实践
    • 性能优化
    • 错误处理
    • 兼容性考虑
  5. 小结
  6. 参考资料

基础概念

CSV 文件是一种简单的文本格式，每行代表表格中的一行数据，列与列之间通过逗号分隔（也可以使用其他分隔符，如制表符等，但逗号最为常见）。文件的第一行通常是表头，用于描述每一列的数据含义。例如，一个简单的 CSV 文件可能如下所示：

姓名,年龄,城市
张三,25,北京
李四,30,上海

在 Java 中创建 CSV 文件，就是通过编写代码将数据按照 CSV 的格式写入到一个文本文件中。

使用方法

使用原生 Java 实现

原生 Java 可以通过 java.io 包中的类来创建和写入 CSV 文件。以下是一个简单的示例：

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

public class CreateCSVWithJava {
    public static void main(String[] args) {
        String csvFilePath = "example.csv";
        String headers = "姓名,年龄,城市";
        String dataRow1 = "张三,25,北京";
        String dataRow2 = "李四,30,上海";

        try (BufferedWriter writer = new BufferedWriter(new FileWriter(csvFilePath))) {
            writer.write(headers);
            writer.newLine();
            writer.write(dataRow1);
            writer.newLine();
            writer.write(dataRow2);
            writer.newLine();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

使用 OpenCSV 库实现

OpenCSV 是一个专门用于处理 CSV 文件的 Java 库，使用它可以更方便地处理复杂的 CSV 操作。首先，需要在项目中添加 OpenCSV 的依赖。如果使用 Maven，可以在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>com.opencsv</groupId>
    <artifactId>opencsv</artifactId>
    <version>5.7.1</version>
</dependency>

以下是使用 OpenCSV 创建 CSV 文件的示例：

import com.opencsv.CSVWriter;

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

public class CreateCSVWithOpenCSV {
    public static void main(String[] args) {
        String csvFilePath = "example.csv";
        String[] headers = {"姓名", "年龄", "城市"};
        String[] dataRow1 = {"张三", "25", "北京"};
        String[] dataRow2 = {"李四", "30", "上海"};

        try (CSVWriter writer = new CSVWriter(new FileWriter(csvFilePath))) {
            writer.writeNext(headers);
            writer.writeNext(dataRow1);
            writer.writeNext(dataRow2);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

使用 Apache Commons CSV 库实现

Apache Commons CSV 也是一个强大的 CSV 处理库。同样，先添加 Maven 依赖：

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

示例代码如下：

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

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

public class CreateCSVWithApacheCommonsCSV {
    public static void main(String[] args) {
        String csvFilePath = "example.csv";
        String[] headers = {"姓名", "年龄", "城市"};
        String[] dataRow1 = {"张三", "25", "北京"};
        String[] dataRow2 = {"李四", "30", "上海"};

        try (FileWriter writer = new FileWriter(csvFilePath);
             CSVPrinter csvPrinter = new CSVPrinter(writer, CSVFormat.DEFAULT.withHeader(headers))) {

            csvPrinter.printRecord(dataRow1);
            csvPrinter.printRecord(dataRow2);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

常见实践

写入简单数据

上述示例中已经展示了如何写入简单的字符串数据。如果数据来自对象，例如一个 Person 类：

class Person {
    private String name;
    private int age;
    private String city;

    public Person(String name, int age, String city) {
        this.name = name;
        this.age = age;
        this.city = city;
    }

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    public String getCity() {
        return city;
    }
}

使用 OpenCSV 写入数据的示例：

import com.opencsv.CSVWriter;

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

public class WriteObjectData {
    public static void main(String[] args) {
        String csvFilePath = "example.csv";
        String[] headers = {"姓名", "年龄", "城市"};

        Person person1 = new Person("张三", 25, "北京");
        Person person2 = new Person("李四", 30, "上海");

        try (CSVWriter writer = new CSVWriter(new FileWriter(csvFilePath))) {
            writer.writeNext(headers);
            writer.writeNext(new String[]{person1.getName(), String.valueOf(person1.getAge()), person1.getCity()});
            writer.writeNext(new String[]{person2.getName(), String.valueOf(person2.getAge()), person2.getCity()});
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

处理复杂数据结构

如果数据结构更为复杂，例如包含嵌套对象或列表，可以将其转换为合适的字符串表示后再写入 CSV 文件。例如，一个包含多个联系人的 ContactList 类：

import java.util.ArrayList;
import java.util.List;

class Contact {
    private String name;
    private List<String> phoneNumbers;

    public Contact(String name, List<String> phoneNumbers) {
        this.name = name;
        this.phoneNumbers = phoneNumbers;
    }

    public String getName() {
        return name;
    }

    public List<String> getPhoneNumbers() {
        return phoneNumbers;
    }
}

class ContactList {
    private List<Contact> contacts;

    public ContactList() {
        contacts = new ArrayList<>();
    }

    public void addContact(Contact contact) {
        contacts.add(contact);
    }

    public List<Contact> getContacts() {
        return contacts;
    }
}

使用 Apache Commons CSV 写入数据的示例：

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

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

public class WriteComplexData {
    public static void main(String[] args) {
        String csvFilePath = "example.csv";
        String[] headers = {"姓名", "电话号码"};

        ContactList contactList = new ContactList();
        Contact contact1 = new Contact("张三", List.of("1234567890", "0987654321"));
        Contact contact2 = new Contact("李四", List.of("2468135790"));
        contactList.addContact(contact1);
        contactList.addContact(contact2);

        try (FileWriter writer = new FileWriter(csvFilePath);
             CSVPrinter csvPrinter = new CSVPrinter(writer, CSVFormat.DEFAULT.withHeader(headers))) {

            for (Contact contact : contactList.getContacts()) {
                String phoneNumbersStr = String.join(",", contact.getPhoneNumbers());
                csvPrinter.printRecord(contact.getName(), phoneNumbersStr);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

设置文件编码

在写入 CSV 文件时，可以设置文件的编码。例如，使用原生 Java 写入 UTF - 8 编码的文件：

import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;

public class SetEncoding {
    public static void main(String[] args) {
        String csvFilePath = "example.csv";
        String headers = "姓名,年龄,城市";
        String dataRow1 = "张三,25,北京";
        String dataRow2 = "李四,30,上海";

        try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(new FileWriter(csvFilePath), StandardCharsets.UTF_8))) {
            writer.write(headers);
            writer.newLine();
            writer.write(dataRow1);
            writer.newLine();
            writer.write(dataRow2);
            writer.newLine();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

最佳实践

性能优化

  • 批量写入：尽量减少写入文件的次数，将数据批量处理后一次性写入，以减少磁盘 I/O 操作。例如，使用 CSVWriter 的 writeAll 方法（OpenCSV）或 printRecords 方法（Apache Commons CSV）。
  • 缓冲区大小：合理设置缓冲区大小，避免频繁的小数据写入。可以通过 BufferedWriter 的构造函数来设置缓冲区大小。

错误处理

  • 异常捕获：在写入文件的过程中，要妥善处理可能出现的异常，如 IOException。可以在捕获异常后记录日志，并向用户提供友好的错误提示。
  • 文件存在性检查：在写入文件之前，先检查文件是否已经存在。如果存在，可以选择覆盖、追加或提示用户。

兼容性考虑

  • 分隔符选择：不同的系统或应用程序对 CSV 文件的分隔符可能有不同的要求。可以考虑使用配置文件或用户输入来指定分隔符，以提高兼容性。
  • 引用字符：对于包含特殊字符的数据，需要正确使用引用字符（如双引号）来确保数据的完整性。OpenCSV 和 Apache Commons CSV 都提供了设置引用字符的方法。

小结

在 Java 中创建 CSV 文件有多种方式，原生 Java 提供了基本的文件写入功能，而 OpenCSV 和 Apache Commons CSV 等库则提供了更便捷、功能更强大的方式来处理 CSV 文件。在实际应用中，需要根据项目的需求和复杂度选择合适的方法，并遵循最佳实践来确保代码的性能、稳定性和兼容性。通过掌握这些知识和技巧，你可以在 Java 开发中高效地处理 CSV 文件相关的任务。

参考资料