乐趣区

关于springboot:Spring-Boot-EasyExcel导入导出简直太好用了

jiezi

背景

老我的项目次要采纳的 POI 框架来进行 Excel 数据的导入和导出，但常常会呈现 OOM 的状况，导致整个服务不可用。后续逐渐转移到 EasyExcel，几乎不能太好用了。

EasyExcel 是阿里巴巴开源插件之一，次要解决了 poi 框架应用简单，sax 解析模式不容易操作，数据量大起来容易 OOM，解决了 POI 并发造成的报错。次要解决形式：通过解压文件的形式加载，一行一行地加载，并且摈弃款式字体等不重要的数据，升高内存的占用。

在之前专门写过一篇文章《EasyExcel 太不便易用了，强烈推荐！》，介绍 EasyExcel 性能的根本应用。明天这篇文章，咱们基于 SpringBoot 来实现一下 EasyExcel 的集成，更加不便大家在实践中的间接应用。

SpringBoot 我的项目集成

依赖集成

创立一个根底的 SpringBoot 我的项目，比方这里采纳 SpringBoot 2.7.2 版本。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

EasyExcel 在 SpringBoot 的集成十分不便，只需引入对应的 pom 依赖即可。在上述 dependencies 中增加 EasyExcel 的依赖：

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

EasyExcel 目前稳固最新版本 2.2.11。如果想查看开源我的项目或最新版本，可在 GitHub 上取得：https://github.com/alibaba/ea…。

为了不便和简化代码编写，这里同时引入了 Lombok 的依赖，后续代码中也会应用对应的注解。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.22</version>
</dependency>

上面正式开始业务相干代码的编写。如果你想间接取得残缺源码，对照源码浏览本篇文章，可在公号「程序新视界」内回“1007”取得残缺源码。

实体类实现

这里创立一个 Member，会员的实体类，并在实体类中填写根底的个人信息。

@Data
public class Member {

    /**
     * EasyExcel 应用：导出时疏忽该字段
     */
    @ExcelIgnore
    private Integer id;

    @ExcelProperty("用户名")
    @ColumnWidth(20)
    private String username;

    /**
     * EasyExcel 应用：日期的格式化
     */
    @ColumnWidth(20)
    @ExcelProperty("出生日期")
    @DateTimeFormat("yyyy-MM-dd")
    private Date birthday;

    /**
     * EasyExcel 应用：自定义转换器
     */
    @ColumnWidth(10)
    @ExcelProperty(value = "性别", converter = GenderConverter.class)
    private Integer gender;

}

为了尽量多的演示 EasyExcel 的相干性能，在上述实体类中应用了其常见的一些注解：

  • @ExcelIgnore：疏忽掉该字段；
  • @ExcelProperty(“ 用户名 ”)：设置该列的名称为”用户名“；
  • @ColumnWidth(20)：设置表格列的宽度为 20；
  • @DateTimeFormat(“yyyy-MM-dd”)：依照指定的格局对日期进行格式化；
  • @ExcelProperty(value = “ 性别 ”, converter = GenderConverter.class)：自定义内容转换器，相似枚举的实现，将“男”、“女”转换成“0”、“1”的数值。

GenderConverter 转换器的代码实现如下：

public class GenderConverter implements Converter<Integer> {

    private static final String MAN = "男";
    private static final String WOMAN = "女";


    @Override
    public Class<?> supportJavaTypeKey() {
        // 实体类中对象属性类型
        return Integer.class;
    }

    @Override
    public CellDataTypeEnum supportExcelTypeKey() {
        // Excel 中对应的 CellData 属性类型
        return CellDataTypeEnum.STRING;
    }

    @Override
    public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty,
                                     GlobalConfiguration globalConfiguration) {
        // 从 Cell 中读取数据
        String gender = cellData.getStringValue();
        // 判断 Excel 中的值，将其转换为预期的数值
        if (MAN.equals(gender)) {return 0;} else if (WOMAN.equals(gender)) {return 1;}
        return null;
    }

    @Override
    public CellData<?> convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty,
                                          GlobalConfiguration globalConfiguration) {
        // 判断实体类中获取的值，转换为 Excel 预期的值，并封装为 CellData 对象
        if (integer == null) {return new CellData<>("");
        } else if (integer == 0) {return new CellData<>(MAN);
        } else if (integer == 1) {return new CellData<>(WOMAN);
        }
        return new CellData<>("");
    }
}

不同版本中，convertToJavaData 和 convertToExcelData 的办法参数有所不同，对应的值的获取形式也不同，大家在应用时留神对照本人的版本即可。

业务逻辑实现

为不便验证性能，DAO 层的逻辑便不再实现，间接通过 Service 层来封装数据，先来看导出性能的业务类实现。

MemberService 实现

定义 MemberService 接口：

public interface MemberService {

    /**
     * 获取所有的成员信息
     * @return 成员信息列表
     */
    List<Member> getAllMember();}

定义 MemberServiceImpl 实现类：

@Service("memberService")
public class MemberServiceImpl implements MemberService {


    @Override
    public List<Member> getAllMember() {
        // 这里结构一些测试数据，具体业务场景可从数据库等其余中央获取
        List<Member> list = new ArrayList<>();
        Member member = new Member();
        member.setUsername("张三");
        member.setBirthday(getDate(1990, 10, 11));
        member.setGender(0);
        list.add(member);

        Member member1 = new Member();
        member1.setUsername("王红");
        member1.setBirthday(getDate(1999, 3, 29));
        member1.setGender(1);
        list.add(member1);

        Member member2 = new Member();
        member2.setUsername("李四");
        member2.setBirthday(getDate(2000, 2, 9));
        member2.setGender(0);
        list.add(member2);

        return list;
    }

    private Date getDate(int year, int month, int day) {Calendar calendar = Calendar.getInstance();
        calendar.set(year, month, day);
        return calendar.getTime();}
}

其中数据采纳模仿的静态数据，返回 Member 列表。

简略导出实现

在 Controller 层的实现一个简略的导出实现：

    /**
     * 一般导出形式
     */
    @RequestMapping("/export1")
    public void exportMembers1(HttpServletResponse response) throws IOException {List<Member> members = memberService.getAllMember();

        // 设置文本内省
        response.setContentType("application/vnd.ms-excel");
        // 设置字符编码
        response.setCharacterEncoding("utf-8");
        // 设置响应头
        response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
        EasyExcel.write(response.getOutputStream(), Member.class).sheet("成员列表").doWrite(members);
    }

这个实现形式非常简单间接，应用 EasyExcel 的 write 办法将查问到的数据进行解决，以流的模式写出即可。

在浏览器拜访对应的链接，可下载到如下 Excel 内容：

如果咱们须要将导出的 Excel 进行一些格式化的解决，这就须要用到导出策略的实现了。

自定义导入实现

在 EasyExcel 执行 write 办法之后，取得 ExcelWriterBuilder 类，通过该类的 registerWriteHandler 办法能够设置一些解决策略。

这里先实现一个通用的格局策略工具类 CommonCellStyleStrategy：

public class CommonCellStyleStrategy {

    /**
     * 设置单元格款式(仅用于示例)
     *
     * @return 款式策略
     */
    public static HorizontalCellStyleStrategy getHorizontalCellStyleStrategy() {
        // 表头策略
        WriteCellStyle headerCellStyle = new WriteCellStyle();
        // 表头程度对齐居中
        headerCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
        // 背景色
        headerCellStyle.setFillForegroundColor(IndexedColors.SKY_BLUE.getIndex());
        WriteFont headerFont = new WriteFont();
        headerFont.setFontHeightInPoints((short) 15);
        headerCellStyle.setWriteFont(headerFont);
        // 主动换行
        headerCellStyle.setWrapped(Boolean.FALSE);

        // 内容策略
        WriteCellStyle contentCellStyle = new WriteCellStyle();
        // 设置数据容许的数据格式, 这里 49 代表所有能够都容许设置
        contentCellStyle.setDataFormat((short) 49);
        // 设置背景色: 须要指定 FillPatternType 为 FillPatternType.SOLID_FOREGROUND 不然无奈显示背景色彩. 头默认了 FillPatternType 所以能够不指定
        contentCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);
        contentCellStyle.setFillForegroundColor(IndexedColors.GREY_40_PERCENT.getIndex());
        // 设置内容靠左对齐
        contentCellStyle.setHorizontalAlignment(HorizontalAlignment.LEFT);
        // 设置字体
        WriteFont contentFont = new WriteFont();
        contentFont.setFontHeightInPoints((short) 12);
        contentCellStyle.setWriteFont(contentFont);
        // 设置主动换行
        contentCellStyle.setWrapped(Boolean.FALSE);
        // 设置边框款式和色彩
        contentCellStyle.setBorderLeft(BorderStyle.MEDIUM);
        contentCellStyle.setBorderTop(BorderStyle.MEDIUM);
        contentCellStyle.setBorderRight(BorderStyle.MEDIUM);
        contentCellStyle.setBorderBottom(BorderStyle.MEDIUM);
        contentCellStyle.setTopBorderColor(IndexedColors.RED.getIndex());
        contentCellStyle.setBottomBorderColor(IndexedColors.GREEN.getIndex());
        contentCellStyle.setLeftBorderColor(IndexedColors.YELLOW.getIndex());
        contentCellStyle.setRightBorderColor(IndexedColors.ORANGE.getIndex());

        // 将格局退出单元格款式策略
        return new HorizontalCellStyleStrategy(headerCellStyle, contentCellStyle);
    }
}

该类中示例设置了 Excel 的根底格局。

再来实现一个精细化管制单元格内容 CellWriteHandler 的实现类：

/**
 * 实现 CellWriteHandler 接口, 实现对单元格款式的准确管制
 *
 * @author sec
 * @version 1.0
 * @date 2022/7/31
 **/
public class CustomCellWriteHandler implements CellWriteHandler {

    /**
     * 创立单元格之前的操作
     */
    @Override
    public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
                                 Head head, Integer integer, Integer integer1, Boolean aBoolean) { }

    /**
     * 创立单元格之后的操作
     */
    @Override
    public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell,
                                Head head, Integer integer, Boolean aBoolean) { }

    /**
     * 单元格内容转换之后的操作
     */
    @Override
    public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
                                       CellData cellData, Cell cell, Head head, Integer integer, Boolean aBoolean) { }

    /**
     * 单元格解决后 (已写入值) 的操作
     */
    @Override
    public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
                                 List<CellData> list, Cell cell, Head head, Integer integer, Boolean isHead) {

        // 设置超链接
        if (isHead && cell.getRowIndex() == 0 && cell.getColumnIndex() == 0) {CreationHelper helper = writeSheetHolder.getSheet().getWorkbook().getCreationHelper();
            Hyperlink hyperlink = helper.createHyperlink(HyperlinkType.URL);
            hyperlink.setAddress("https://github.com/alibaba/easyexcel");
            cell.setHyperlink(hyperlink);
        }

        // 准确设置单元格格局
        boolean bool = isHead && cell.getRowIndex() == 1;
        if (bool) {
            // 获取工作簿
            Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
            CellStyle cellStyle = workbook.createCellStyle();

            Font cellFont = workbook.createFont();
            cellFont.setBold(Boolean.TRUE);
            cellFont.setFontHeightInPoints((short) 14);
            cellFont.setColor(IndexedColors.SEA_GREEN.getIndex());
            cellStyle.setFont(cellFont);
            cell.setCellStyle(cellStyle);
        }
    }
}

在这里，对单元格表头的第 0 个 Cell 设置了一个超链接。

通过下面的定义两个策略实现，在导出 Excel 能够应用上述两个策略实现：

    /**
     * 基于策略及拦截器导出
     */
    @RequestMapping("/export2")
    public void exportMembers2(HttpServletResponse response) throws IOException {List<Member> members = memberService.getAllMember();

        // 设置文本内省
        response.setContentType("application/vnd.ms-excel");
        // 设置字符编码
        response.setCharacterEncoding("utf-8");
        // 设置响应头
        response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
        EasyExcel.write(response.getOutputStream(), Member.class).sheet("成员列表")
                // 注册通用格局策略
                .registerWriteHandler(CommonCellStyleStrategy.getHorizontalCellStyleStrategy())
                // 设置自定义格局策略
                .registerWriteHandler(new CustomCellWriteHandler())
                .doWrite(members);
    }

通过浏览器，拜访上述接口，导出的 Excel 格局如下：

能够看出，导出的 Excel 曾经附带了具体的格局。其中表头“用户名”上也携带了对应的超链接。其余更精细化的管制，大家能够在策略类中做进一步的管制。

同步获取后果导入实现

所谓的同步获取后果导入，就是执行导入操作时，将导入内容解析封装成一个后果列表返回给业务，业务代码再对列表中的数据进行集中的解决。

先来看同步导入的实现形式。

    /**
     * 从 Excel 导入会员列表
     */
    @RequestMapping(value = "/import1", method = RequestMethod.POST)
    @ResponseBody
    public void importMemberList(@RequestPart("file") MultipartFile file) throws IOException {List<Member> list = EasyExcel.read(file.getInputStream())
                .head(Member.class)
                .sheet()
                .doReadSync();
        for (Member member : list) {System.out.println(member);
        }
    }

留神，在上述代码中，最终调用的是 doReadSync()办法。

这里间接用 PostMan 进行相应的文件上传申请：

执行导入申请，会发现控制台打印出对应的解析对象：

Member(id=null, username= 张三, birthday=Sun Nov 11 00:00:00 CST 1990, gender=0)
Member(id=null, username= 王红, birthday=Thu Apr 29 00:00:00 CST 1999, gender=1)
Member(id=null, username= 李四, birthday=Thu Mar 09 00:00:00 CST 2000, gender=0)

阐明上传胜利，并且解析胜利。

基于监听导入实现

下面示例中是基于同步获取后果列表的模式进行导入，还有一种实现形式是基于监听器的模式来实现。这种模式能够达到边解析边解决业务逻辑的成果。

定义 Listener：

public class MemberExcelListener extends AnalysisEventListener<Member> {

    @Override
    public void invoke(Member member, AnalysisContext analysisContext) {
        // do something
        System.out.println("读取 Member=" + member);
        // do something
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        // do something
        System.out.println("读取 Excel 结束");
        // do something
    }
}

在 MemberExcelListener 中能够针对每条数据进行对应的业务逻辑解决。

对外接口实现如下：

    /**
     * 基于 Listener 形式从 Excel 导入会员列表
     */
    @RequestMapping(value = "/import2", method = RequestMethod.POST)
    @ResponseBody
    public void importMemberList2(@RequestPart("file") MultipartFile file) throws IOException {
        // 形式一：同步读取，将解析后果返回，比方返回 List<Member>，业务再进行相应的数据集中处理
        // 形式二：对照 doReadSync()办法的是最初调用 doRead()办法，不进行后果返回，而是在 MemberExcelListener 中进行一条条数据的解决；// 此处示例为形式二
        EasyExcel.read(file.getInputStream(), Member.class, new MemberExcelListener()).sheet().doRead();
    }

这里采纳了 doRead()办法进行读取操作。在 PostMan 中再次上传 Excel，打印日志如下：

读取 Member=Member(id=null, username= 张三, birthday=Sun Nov 11 00:00:00 CST 1990, gender=0)
读取 Member=Member(id=null, username= 王红, birthday=Thu Apr 29 00:00:00 CST 1999, gender=1)
读取 Member=Member(id=null, username= 李四, birthday=Thu Mar 09 00:00:00 CST 2000, gender=0)
读取 Excel 结束

阐明解析胜利，并且在解析的过程中，进行了业务逻辑的解决。

小结

本篇文章基于 SpringBoot 集成 EasyExcel 的实现开展，为大家解说了 EasyExcel 在实践中的具体使用。大家可依据须要，进行变通处理。同时，基于自定义转换器、自定义策略、自定义监听器等模式达到灵便实用于各种场景。心愿本篇文章能给大家带来帮忙。

博主简介：《SpringBoot 技术底细》技术图书作者，热爱钻研技术，写技术干货文章。

公众号：「程序新视界」，博主的公众号，欢送关注~

技术交换：请分割博主微信号：zhuan2quan

退出移动版