使用Hutool进行CSV文件生成与解析

最新推荐文章于 2025-11-14 15:21:49 发布

原创

最新推荐文章于 2025-11-14 15:21:49 发布 · 1.4w 阅读

31 ·

CC 4.0 BY-SA版权

文章标签：

#csv #hutool #CsvWriter #CsvReader #csv读写

文章介绍了如何使用Hutool和ApacheCommonsCSV这两个Java库来生成和解析CSV文件，包括设置数据分隔符、编码、换行符等，并提供了生成和解析CSV的示例代码。Hutool提供了CsvUtil工具类简化操作，而ApacheCommonsCSV则通过CSVFormat、CSVParser和CSVPrinter类实现文件的读写。文章强调了在处理CSV时注意的点，如分隔符、编码和表头设置。

文章目录

前言

CSV文件通常是指逗号分隔值（Comma-Separated Values）文件，是一种常见的电子表格文件格式。其基本格式是一行代表一条记录，每个字段之间用逗号进行分隔，通常使用纯文本文件存储。

在实际开发中，CSV文件被广泛应用于数据交换、数据导入导出等方面。例如，我们可以使用CSV文件导出数据库中的数据，将数据共享给其他系统，或者从其他系统中导入数据到数据库中。

由于CSV文件的格式简单且易于阅读，且不需要使用特殊的软件即可打开，可以用txt软件打开也可以使用Excel软件打开，因此在实际应用中非常方便。但是，当CSV文件的数据量较大时，手动进行处理就会变得非常繁琐。这时候，使用CSV工具类就变得非常必要了。

CSV工具类可以帮助我们简化CSV文件的读写操作，提高开发效率。在Java中，常用的CSV工具类有org.apache.commons.csv和Hutool等。使用这些工具类，我们可以轻松地生成CSV文件、读取CSV文件中的数据，并进行相应的操作。因此，了解并使用CSV工具类对于Java开发者来说是非常有必要的。

如下为一个CSV文件的样例:

Name,Age
Tom,18
Jack,20
Lucy,22

在Java中有许多办法生成和解析CSV文件的工具类，例如:apache下的Commons和Hutool，现将使用上述两种工具类生成和解析CSV文件总结下来。

commons与Hutool处理CSV

apache.commons下提供了CSVFormat用来设置CSV格式，如分隔符、换行符，编码等;CSVParser类用于解析CSV文件，CSVParser类提供了parse方法，可以解析CSV文件并返回一个CSVRecord对象的迭代器，CSVRecord对象代表了一行记录；CSVPrinter类用于生成CSV文件，CSVPrinter类提供了printRecord方法，可以将CSVRecord对象输出到CSV文件中；CSVRecord类代表了一行记录，可以通过get方法获取每一列的值。

Hutool下提供了CsvConfig类定义CSV文件格式，使用CsvWriteConfig类和CsvReadeConfig分别设置写和读CSV文件格式提供了CsvUtil工具类，可以帮助开发者方便地生成CSV文件。提供了CsvWriter和CsvReader来进行生成CSV文件和CSV文件读取。

生成和解析CSV文件主要有以下几点需要注意：

数据分割符

一般情况下使用英文状态下的逗号作为分隔符，但是可以进行更换，例如使用英文状态下的竖线作为分隔符或者更复杂，因为CSV分隔符没有统一的标准，默认为逗号。
文件编码

生成和读取CSV文件时都需要关注好文件编码，不然当使用CSV文件时可能因为文件编码问题出问题
换行符

因为Windows系操作系统和Linux系的操作系统系统的换行符不一样，而换行符作为一条数据的结束新数据的开始从而有很重要的作用
是否需要CSV表头

表头的意思是设置每个数据的含义，例如上面的Name,age。如果生成的CSV文件会被其它系统使用，则需要告知是否需要生成表头。
注释符号和文本包装符

在CSV文件中默认使用#作为注释的开始，使用双引号作为文本包装符

使用Hutool生成和解析CSV文件

使用Hutool生成CSV文件

Hutool下的CsvWriter默认使用逗号作为数据分割符，使用‘/r/n’也即CRLF作为换行符，使用‘#’号作为注释的开始使用双引号作为文本包装符，默认使用UTF-8生成CSV文件；

Hutool生成CSV文件配置

使用CsvWriteConfig进行设置，CsvWriteConfig类继承自CsvConfig，扩展了一些方法，通过添加一个setCsvWriterConfig方法，当默认CSV默认配置不足以满足需要时可以进行设置，代码如下：

/**
 * 设置Csv写文件配置
 * @return CsvWriteConfig
 */
public static CsvWriteConfig setCsvWriterConfig(){
     
     
    CsvWriteConfig csvWriteConfig = new CsvWriteConfig();
    //设置 文本分隔符，文本包装符，默认双引号'"'
    // csvWriteConfig.setTextDelimiter('\t');
    // 字段分割符号，默认为逗号
    csvWriteConfig.setFieldSeparator('|');
    // 设置注释符号
    // csvWriteConfig.setCommentCharacter('#');
    // 设置是否始终使用文本分隔符，文本包装符，默认false
    // csvWriteConfig.setAlwaysDelimitText(true);
    // 换行符默认为CharUtil.CR, CharUtil.LF
    // csvWriteConfig.setLineDelimiter(lineDelimiter);
    // 设置标题行的别名,如果不设置则表头为id,name,gender
    Map<String, String> headerAlias = new LinkedHashMap<>();
    headerAlias.put("id", "序号");
    headerAlias.put("name", "姓名");
    headerAlias.put("gender", "性别");
    csvWriteConfig.setHeaderAlias(headerAlias);
    return csvWriteConfig;
}

生成CSV文件

先添加一个User对象，将User对象写入到CSV, 生成CSV文件的方式很多，可以使用不使用上面的配置使用默认配置写入CSV文件，也可以自定义配置同时使用英文状态下的竖线作为数据分割符生成CSV文件。

User对象代码如下：

/**
 * 用户
 * @author zlc
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class User implements Serializable {
     
     

    /**
     * id
     */
    private Integer id;

    /**
     * 姓名
     */
    private String name;

    /**
     * 性别
     */
    private String gender;
}

添加生成User列表方法用于提供数据来源，代码如下：

/**
 * 生成User列表
 * @return List<User>
 */
public static List<User> generateUserList(){
     
     
    List<User> dataList = new ArrayList<>();
    dataList.add(new User(1, "张三", "男"));
    dataList.add(new User(2, "李四", "女"));
    dataList.add(new User(3, "王五", "男"))