Back to Repositories

Testing Character Encoding Implementation in EasyExcel

This test suite validates character encoding functionality in EasyExcel’s CSV file handling, focusing on UTF-8 and GBK charset support. It ensures proper reading and writing of Chinese characters across different encoding formats.

Test Coverage Overview

The test suite provides comprehensive coverage of character encoding scenarios in EasyExcel.

Key areas tested include:

GBK charset handling for CSV files
UTF-8 charset handling for CSV files
Encoding mismatch scenarios
Chinese character preservation during read/write operations

Implementation Analysis

The testing approach employs JUnit 5 framework with systematic validation of charset handling.

Technical implementation includes:

Separate test cases for different encoding scenarios
Custom ReadListener implementation for validation
Assertion-based verification of character preservation
File-based testing with temporary test files

Technical Details

Testing infrastructure leverages:

JUnit Jupiter API for test execution
Lombok for logging support
Apache Commons Compress utilities
EasyExcel’s core API for read/write operations
Custom file utility for test file management

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Organized test setup with @BeforeAll initialization
Methodical test ordering using @TestMethodOrder
Proper resource management and cleanup
Comprehensive assertion coverage
Clear separation of test data generation and validation logic

alibaba/easyexcel

easyexcel-test/src/test/java/com/alibaba/easyexcel/test/core/charset/CharsetDataTest.java

            
package com.alibaba.easyexcel.test.core.charset;

import java.io.File;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;

import com.alibaba.easyexcel.test.util.TestFileUtil;
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.metadata.data.ReadCellData;
import com.alibaba.excel.read.listener.ReadListener;

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.compress.utils.Lists;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestMethodOrder;

/**
 * charset
 *
 * @author Jiaju Zhuang
 */
@Slf4j
@TestMethodOrder(MethodOrderer.MethodName.class)
public class CharsetDataTest {
    private static final Charset GBK = Charset.forName("GBK");
    private static File fileCsvGbk;
    private static File fileCsvUtf8;
    private static File fileCsvError;

    @BeforeAll
    public static void init() {
        fileCsvGbk = TestFileUtil.createNewFile("charset" + File.separator + "fileCsvGbk.csv");
        fileCsvUtf8 = TestFileUtil.createNewFile("charset" + File.separator + "fileCsvUtf8.csv");
        fileCsvError = TestFileUtil.createNewFile("charset" + File.separator + "fileCsvError.csv");
    }

    @Test
    public void t01ReadAndWriteCsv() {
        readAndWrite(fileCsvGbk, GBK);
        readAndWrite(fileCsvUtf8, StandardCharsets.UTF_8);
    }

    @Test
    public void t02ReadAndWriteCsvError() {
        EasyExcel.write(fileCsvError, CharsetData.class).charset(GBK).sheet().doWrite(data());
        EasyExcel.read(fileCsvError, CharsetData.class, new ReadListener<CharsetData>() {

            private final List<CharsetData> dataList = Lists.newArrayList();

            @Override
            public void invokeHead(Map<Integer, ReadCellData<?>> headMap, AnalysisContext context) {
                String head = headMap.get(0).getStringValue();
                Assertions.assertNotEquals("姓名", head);
            }

            @Override
            public void invoke(CharsetData data, AnalysisContext context) {
                dataList.add(data);
            }

            @Override
            public void doAfterAllAnalysed(AnalysisContext context) {
            }
        }).charset(StandardCharsets.UTF_8).sheet().doRead();
    }

    private void readAndWrite(File file, Charset charset) {
        EasyExcel.write(file, CharsetData.class).charset(charset).sheet().doWrite(data());
        EasyExcel.read(file, CharsetData.class, new ReadListener<CharsetData>() {

            private final List<CharsetData> dataList = Lists.newArrayList();

            @Override
            public void invokeHead(Map<Integer, ReadCellData<?>> headMap, AnalysisContext context) {
                String head = headMap.get(0).getStringValue();
                Assertions.assertEquals("姓名", head);
            }

            @Override
            public void invoke(CharsetData data, AnalysisContext context) {
                dataList.add(data);
            }

            @Override
            public void doAfterAllAnalysed(AnalysisContext context) {
                Assertions.assertEquals(dataList.size(), 10);
                CharsetData charsetData = dataList.get(0);
                Assertions.assertEquals("姓名0", charsetData.getName());
                Assertions.assertEquals(0, (long)charsetData.getAge());
            }
        }).charset(charset).sheet().doRead();
    }

    private List<CharsetData> data() {
        List<CharsetData> list = Lists.newArrayList();
        for (int i = 0; i < 10; i++) {
            CharsetData data = new CharsetData();
            data.setName("姓名" + i);
            data.setAge(i);
            list.add(data);
        }
        return list;
    }
}