Back to Repositories

Testing CSV File Operations and Data Handling in EasyExcel

This test suite validates CSV file reading and writing functionality in the EasyExcel library, focusing on data conversion, file handling, and integration with Apache Commons CSV. The tests demonstrate both basic and advanced CSV operations with various configuration options.

Test Coverage Overview

The test suite provides comprehensive coverage of CSV operations including:

Basic CSV file writing with header configuration
CSV reading with null value handling
EasyExcel integration for CSV operations
File format detection and validation
Custom data type handling and conversion

Implementation Analysis

The testing approach utilizes JUnit Jupiter framework with modular test methods. Each test focuses on specific CSV functionality, implementing both Apache Commons CSV and EasyExcel APIs for comparison. The implementation demonstrates proper resource handling with automatic closeable streams and configurable CSV formats.

Technical Details

Key technical components include:

JUnit Jupiter test framework
Apache Commons CSV for native CSV operations
EasyExcel API for enhanced CSV handling
Custom CsvData class for data modeling
FileMagic for file type detection
Lombok for logging support

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper resource management with try-with-resources
Separation of concerns between different CSV operations
Comprehensive error handling and validation
Clear test method naming and organization
Efficient data generation for test cases

alibaba/easyexcel

easyexcel-test/src/test/java/com/alibaba/easyexcel/test/temp/csv/CsvReadTest.java

            
package com.alibaba.easyexcel.test.temp.csv;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;

import com.alibaba.easyexcel.test.util.TestFileUtil;
import com.alibaba.excel.EasyExcel;
import com.alibaba.fastjson2.JSON;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVPrinter;
import org.apache.commons.csv.CSVRecord;
import org.apache.poi.poifs.filesystem.FileMagic;
import org.junit.jupiter.api.Test;

@Slf4j
public class CsvReadTest {

    @Test
    public void write() throws Exception {
        Appendable out = new PrintWriter(
            new OutputStreamWriter(new FileOutputStream(TestFileUtil.createNewFile("csvWrite1.csv"))));
        CSVPrinter printer = CSVFormat.DEFAULT.withHeader("userId", "userName")
            .print(out);
        for (int i = 0; i < 10; i++) {
            printer.printRecord("userId" + i, "userName" + i);
        }
        printer.flush();
        printer.close();
    }

    @Test
    public void read1() throws Exception {
        Iterable<CSVRecord> records = CSVFormat.DEFAULT.withNullString("").parse(
            new FileReader("/Users/zhuangjiaju/IdeaProjects/easyexcel/target/test-classes/t1.csv"));
        for (CSVRecord record : records) {
            String lastName = record.get(0);
            String firstName = record.get(1);
            log.info("row:{},{}", lastName, firstName);
        }

    }

    @Test
    public void csvWrite() throws Exception {
        // 写法1
        String fileName = TestFileUtil.getPath() + "simpleWrite" + System.currentTimeMillis() + ".csv";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        // 如果这里想使用03 则 传入excelType参数即可
        EasyExcel.write(fileName, CsvData.class).sheet().doWrite(data());

        // 读
        List<Object> list = EasyExcel.read(fileName).sheet(0).headRowNumber(0).doReadSync();
        log.info("数据：{}", list.size());
        for (Object data : list) {
            log.info("返回数据：{}", JSON.toJSONString(data));
        }
    }

    @Test
    public void writev2() throws Exception {
        // 写法1
        String fileName = TestFileUtil.getPath() + "simpleWrite" + System.currentTimeMillis() + ".csv";
        // 这里 需要指定写用哪个class去写，然后写到第一个sheet，名字为模板 然后文件流会自动关闭
        // 如果这里想使用03 则 传入excelType参数即可
        EasyExcel.write(fileName, CsvData.class).sheet().doWrite(data());

        EasyExcel.read(fileName, CsvData.class, new CsvDataListeer()).sheet().doRead();
    }

    @Test
    public void writeFile() throws Exception {
        FileInputStream fileInputStream = new FileInputStream(new File("/Users/zhuangjiaju/test/test1.csv"));
        FileMagic fileMagic = FileMagic.valueOf(fileInputStream);
        log.info("{}", fileMagic);
    }

    private List<CsvData> data() {
        List<CsvData> list = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            CsvData data = new CsvData();
            data.setString("字符,串" + i);
            //data.setDate(new Date());
            data.setDoubleData(0.56);
            data.setIgnore("忽略" + i);
            list.add(data);
        }
        return list;
    }

    @Test
    public void read() {
        //
        //Iterable<CSVRecord> records = CSVFormat.DEFAULT.withFirstRecordAsHeader().parse(in);
        //for (CSVRecord record : records) {
        //    String lastName = record.get("id");
        //    String firstName = record.get("name");
        //    System.out.println(lastName);
        //    System.out.println(firstName);
        //}

    }
}