EasyExcel读取第一行数据，读取表头_easyexcel读取表头

在EasyExcel中默认是不会去读取表头数据的

我们在编写EasyExcel解析类的时候，继承了AnalysisEventListener类

看一下该类的结构，可以看到它有invokeHeadMap这个方法

直接覆写这个方法，就可以得到表头数据了

public class ExcelService extends AnalysisEventListener<Map<Integer, String>> {

    private static final Logger LOGGER = LoggerFactory.getLogger(ExcelService.class);
    List<Map<Integer, String>> list = new ArrayList<Map<Integer, String>>();

    @Override
    public void invoke(Map<Integer, String> data, AnalysisContext context) {
        LOGGER.info("解析到的数据: {}", data);
        list.add(data);
    }

    @Override
    public void invokeHeadMap(Map headMap, AnalysisContext context) {
        LOGGER.info("解析到的表头数据: {}", headMap);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        saveData();
    }

    /**
     * 如果有必要，存储到数据库
     */
    private void saveData() {
        LOGGER.info("{}条数据，开始存储数据库！", list.size());
        LOGGER.info("存储数据库成功！");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

测试

@Test
void contextLoads() {
    String fileName = "test1.xlsx";
    // 这里 只要，然后读取第一个sheet 同步读取会自动finish
    EasyExcel.read(fileName, new ExcelService()).sheet().doRead();
}
1
2
3
4
5
6

看到好像有挺多人要做这个需求的，然后都说看不懂我上面的案例，这里就再更新一版完整的代码

准备的 Excel 文件数据（第一行是 Header，其他的是数据）

依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>3.1.3</version>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
1
2
3
4
5
6
7
8
9
10

定义一个实体类，用于解析 excel 数据

package com.max.excel.model;

import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class UserExcel {

    @ExcelIgnore
    private Integer id;
    @ExcelProperty(index = 0, value = "姓名")
    private String name;
    @ExcelProperty(index = 1, value = "年龄")
    private Integer age;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

定义一个监听器，用来读取 Excel 数据

package com.max.excel.listener;

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.max.excel.model.UserExcel;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@Slf4j
@Component
public class UserExcelListener extends AnalysisEventListener<UserExcel> {

    // 定义一个全局的读取header的map，方便其他地方使用改数据，当然要是你存进数据库那就更方便取了
    private final Map<Integer, String> userHeaderMap = new HashMap<>();
    // excel主数据
    private List<UserExcel> userExcelList = new ArrayList<>();

    // excel的主数据是在这个生命周期读取的
    @Override
    public void invoke(UserExcel userExcel, AnalysisContext analysisContext) {
        userExcelList.add(userExcel);
    }

    // 解析完excel需要干的事情
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        log.info("已解析完所有数据!");
    }

    // excel头部数据
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        // 存到全局的map中
        userHeaderMap.putAll(headMap);
    }

    public List<UserExcel> getUserExcelList() {
        return userExcelList;
    }

    public void setUserExcelList(List<UserExcel> userExcelList) {
        this.userExcelList = userExcelList;
    }

    public Map<Integer, String> getUserHeaderMap() {
        return userHeaderMap;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

测试

package com.max.excel;

import com.alibaba.excel.EasyExcel;
import com.max.excel.listener.UserExcelListener;
import com.max.excel.model.UserExcel;
import lombok.extern.slf4j.Slf4j;

import java.io.File;
import java.util.Collections;
import java.util.Optional;

@Slf4j
public class Test {

    public static void main(String[] args) {
        String file = "t.xls";
        String reFile = "t.xls";
        UserExcelListener listener = new UserExcelListener();

        // 读取
        EasyExcel.read(new File(file), UserExcel.class, listener).sheet(0).doRead();

        // 读取转成的Java对象
        log.info("===========Excel Header数据===========");
        Optional.ofNullable(listener.getUserHeaderMap())
                        .orElse(Collections.emptyMap())
                                .forEach((k, v) -> {
                                    System.out.println(v);
                                });

        log.info("===========Excel数据===========");
        Optional.ofNullable(listener.getUserExcelList())
                .orElse(Collections.emptyList())
                .forEach(System.out::println);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

最终结果