關於easyExcel中讀取Excel表頭的範例說明

2022-06-02 14:05:33

前言

在使用easyExcel讀取檔案時,對於Excel的表頭,在解析讀取時分成不同的狀態,需要加以區分.

1 環境準備

準備一個可以正常存取的SpringBoot專案.

1 新增pom

        <!-- https://mvnrepository.com/artifact/com.alibaba/easyexcel -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>3.0.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

2 新增dto物件

// 表格對應實體類
@Data
public class EasyExcelDemo {

    @ExcelProperty("標題")
    private String string;
    @ExcelProperty("日期")
    private Date date;
    @ExcelProperty("金額")
    private Double money;
    /**
     * 忽略這個欄位
     */
    @ExcelIgnore
    private String name;
}

// 返回物件
@Data
public class Resp {
    private List<EasyExcelDemo> importList;

}

3 準備一個控制器

@RestController
@RequestMapping("/easyExcel")
@Slf4j
public class EasyExcelController {
    
    @PostMapping("/upload")
    public void upload(@RequestParam("file") MultipartFile file) throws IOException {
    	// 讀取Excel    
        EasyExcel.read(file.getInputStream(), EasyExcelDemo.class,
                new EasyExcelListener()).sheet().headRowNumber(1).doRead();

        // 從監聽中獲取結果集
        Resp resp = EasyExcelListener.RESP.get();
        List<EasyExcelDemo> importList = resp.getImportList();
        log.info("匯入集合 list = {}", importList);
        // 清除資料
        EasyExcelListener.RESP.remove();
    }
    
}

4 準備一個監聽類

@Slf4j
public class EasyExcelListener extends AnalysisEventListener<EasyExcelDemo> {

    public static List<EasyExcelDemo> importList = new ArrayList<>();
    public static final ThreadLocal<Resp> RESP = new ThreadLocal<>();

    @Override
    public void invoke(EasyExcelDemo data, AnalysisContext context) {
        log.info("解析到的一條資料: excelRow = {}", data);
        importList.add(data);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 解析完所有excel行, 儲存到資料庫或進行業務處理
        log.info("解析的所有資料 list = {}", importList);
        Resp resp = new Resp();
        resp.setImportList(importList);
        RESP.set(resp);
    }

    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        log.info("表頭資料 excelHead= {}", headMap);
    }
}

2 單表頭Excel

單表頭Excel, 即Excel的表頭只有一行.

如上單行表頭, 在讀取時,在EasyExcel讀取時設定headRowNumber屬性,表示Excel的表頭的行數,預設為1,設定為1時,表示第一行是表頭,從第二行是表資料

 EasyExcel.read(file.getInputStream(), EasyExcelDemo.class,
                new EasyExcelListener()).sheet().headRowNumber(1).doRead();

使用postman上傳excel檢視結果:

讀取到Excel的表頭

讀取到Excel的表資料

3 多表頭Excel

多表頭Excel, 即Excel的表頭有多行.

如上單行表頭, 在讀取時,在EasyExcel讀取時設定headRowNumber屬性,表示Excel的表頭的行數,設定為2時,表示第二和之前行都是表頭.

EasyExcel.read(file.getInputStream(), EasyExcelDemo.class, new EasyExcelListener()).sheet().headRowNumber(2).doRead(); EasyExcel.read(file.getInputStream(), EasyExcelDemo.class,
                new EasyExcelListener()).sheet().headRowNumber(2).doRead();

使用postman上傳excel檢視結果:

讀取到Excel的表頭, 讀取到第一行