OpenCSV CSV到JavaBean

OpenCSV CSV到JavaBean转换详解

基础概念

OpenCSV是一个流行的Java库，用于处理CSV(逗号分隔值)文件。它提供了将CSV数据映射到Java对象(JavaBean)的功能，这种功能通常称为"数据绑定"或"对象映射"。

核心优势

简单易用：API设计简洁，几行代码即可完成CSV到对象的转换
高性能：处理大型CSV文件时效率较高
灵活性：支持自定义映射规则和转换器
注解支持：通过注解简化配置
错误处理：提供良好的异常处理机制

主要类型和方法

OpenCSV提供了两种主要方式将CSV映射到JavaBean：

基于注解的映射：使用@CsvBindByName等注解
基于列位置的映射：使用@CsvBindByPosition注解
编程式映射：使用HeaderColumnNameTranslateMappingStrategy或ColumnPositionMappingStrategy

应用场景

导入/导出数据
数据迁移
报表生成
批量数据处理
与外部系统集成

示例代码

1. 定义JavaBean

public class Employee {
    @CsvBindByName(column = "ID")
    private int id;
    
    @CsvBindByName(column = "Name")
    private String name;
    
    @CsvBindByName(column = "Age")
    private int age;
    
    @CsvBindByName(column = "Salary")
    private double salary;
    
    // 必须有无参构造函数
    public Employee() {}
    
    // getter和setter方法
    // ...
}

2. 读取CSV到JavaBean列表

try (Reader reader = new FileReader("employees.csv")) {
    CsvToBean<Employee> csvToBean = new CsvToBeanBuilder<Employee>(reader)
        .withType(Employee.class)
        .withIgnoreLeadingWhiteSpace(true)
        .build();
    
    List<Employee> employees = csvToBean.parse();
    
    for (Employee emp : employees) {
        System.out.println(emp);
    }
} catch (IOException e) {
    e.printStackTrace();
}

3. 写入JavaBean到CSV

List<Employee> employees = new ArrayList<>();
// 添加Employee对象到列表...

try (Writer writer = new FileWriter("output.csv")) {
    StatefulBeanToCsv<Employee> beanToCsv = new StatefulBeanToCsvBuilder<Employee>(writer)
        .withQuotechar(CSVWriter.NO_QUOTE_CHARACTER)
        .build();
    
    beanToCsv.write(employees);
} catch (IOException | CsvRequiredFieldEmptyException | CsvDataTypeMismatchException e) {
    e.printStackTrace();
}

常见问题及解决方案

1. 字段映射失败

原因：列名不匹配或字段类型不兼容解决：

检查注解中的列名是否与CSV文件中的列名完全一致
确保JavaBean中的字段类型与CSV数据兼容
使用自定义转换器处理特殊格式

@CsvCustomBindByName(column = "Date", converter = LocalDateConverter.class)
private LocalDate hireDate;

2. 空值处理

原因：CSV中存在空值而JavaBean字段是基本类型解决：

使用包装类(Integer, Double等)代替基本类型
设置默认值

@CsvBindByName(column = "Age", required = false)
private Integer age;  // 使用Integer而不是int

3. 性能问题

原因：处理大型CSV文件时内存不足解决：

使用流式处理
分批处理数据

CsvToBean<Employee> csvToBean = new CsvToBeanBuilder<Employee>(reader)
    .withType(Employee.class)
    .withBatchSize(1000)  // 分批处理
    .build();

4. 特殊字符处理

原因：CSV中包含引号、逗号等特殊字符解决：

配置适当的引号字符和转义字符

StatefulBeanToCsv<Employee> beanToCsv = new StatefulBeanToCsvBuilder<Employee>(writer)
    .withQuotechar(CSVWriter.DEFAULT_QUOTE_CHARACTER)
    .withEscapechar(CSVWriter.DEFAULT_ESCAPE_CHARACTER)
    .build();

高级用法

自定义转换器

public class LocalDateConverter extends AbstractBeanField<LocalDate> {
    @Override
    protected Object convert(String value) {
        return LocalDate.parse(value, DateTimeFormatter.ofPattern("yyyy/MM/dd"));
    }
}

处理不同分隔符

CSVReader reader = new CSVReaderBuilder(new FileReader("data.tsv"))
    .withCSVParser(new CSVParserBuilder().withSeparator('\t').build())
    .build();

OpenCSV提供了强大而灵活的CSV处理能力，通过合理配置可以满足大多数CSV处理需求。