關(guān)于easyExcel中讀取Excel表頭的實(shí)例說明

更新時(shí)間：2022年06月02日 11:13:15 作者：七國(guó)的天下，我要九十九

EasyExcel是阿里巴巴開源的一個(gè)excel處理框架,以使用簡(jiǎn)單、節(jié)省內(nèi)存著稱,下面這篇文章主要給大家介紹了關(guān)于easyExcel中讀取Excel表頭的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

在使用easyExcel讀取文件時(shí),對(duì)于Excel的表頭,在解析讀取時(shí)分成不同的狀態(tài),需要加以區(qū)分.

1 環(huán)境準(zhǔn)備

準(zhǔn)備一個(gè)可以正常訪問的SpringBoot項(xiàng)目.

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對(duì)象

// 表格對(duì)應(yīng)實(shí)體類
@Data
public class EasyExcelDemo {

    @ExcelProperty("標(biāo)題")
    private String string;
    @ExcelProperty("日期")
    private Date date;
    @ExcelProperty("金額")
    private Double money;
    /**
     * 忽略這個(gè)字段
     */
    @ExcelIgnore
    private String name;
}

// 返回對(duì)象
@Data
public class Resp {
    private List<EasyExcelDemo> importList;

}

3 準(zhǔn)備一個(gè)控制器

@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();

        // 從監(jiān)聽中獲取結(jié)果集
        Resp resp = EasyExcelListener.RESP.get();
        List<EasyExcelDemo> importList = resp.getImportList();
        log.info("導(dǎo)入集合 list = {}", importList);
        // 清除數(shù)據(jù)
        EasyExcelListener.RESP.remove();
    }
    
}

4 準(zhǔn)備一個(gè)監(jiān)聽類

@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("解析到的一條數(shù)據(jù): excelRow = {}", data);
        importList.add(data);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 解析完所有excel行, 保存到數(shù)據(jù)庫或進(jìn)行業(yè)務(wù)處理
        log.info("解析的所有數(shù)據(jù) list = {}", importList);
        Resp resp = new Resp();
        resp.setImportList(importList);
        RESP.set(resp);
    }

    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        log.info("表頭數(shù)據(jù) excelHead= {}", headMap);
    }
}

2 單表頭Excel

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

如上單行表頭, 在讀取時(shí),在EasyExcel讀取時(shí)設(shè)置headRowNumber屬性,表示Excel的表頭的行數(shù),默認(rèn)為1,設(shè)置為1時(shí),表示第一行是表頭,從第二行是表數(shù)據(jù)

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

使用postman上傳excel查看結(jié)果:

讀取到Excel的表頭

讀取到Excel的表數(shù)據(jù)

3 多表頭Excel

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

如上單行表頭, 在讀取時(shí),在EasyExcel讀取時(shí)設(shè)置headRowNumber屬性,表示Excel的表頭的行數(shù),設(shè)置為2時(shí),表示第二和之前行都是表頭.

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查看結(jié)果:

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