• Spring Boot + EasyExcel导入导出，简直太好用了！

    背景

    老项目主要采用的POI框架来进行Excel数据的导入和导出，但经常会出现OOM的情况，导致整个服务不可用。后续逐步转移到EasyExcel，简直不能太好用了。

    EasyExcel是阿里巴巴开源插件之一，主要解决了poi框架使用复杂，sax解析模式不容易操作，数据量大起来容易OOM，解决了POI并发造成的报错。主要解决方式：通过解压文件的方式加载，一行一行地加载，并且抛弃样式字体等不重要的数据，降低内存的占用。

    今天这篇文章，我们基于SpringBoot来实现一下EasyExcel的集成，更加方便大家在实践中的直接使用。

    SpringBoot项目集成

    依赖集成

    创建一个基础的SpringBoot项目，比如这里采用SpringBoot 2.7.2版本。

    1. <dependencies>
    2.  <dependency>
    3.   <groupId>org.springframework.bootgroupId>
    4.   <artifactId>spring-boot-starter-webartifactId>
    5.  dependency>
    6.  
    7.  <dependency>
    8.   <groupId>org.springframework.bootgroupId>
    9.   <artifactId>spring-boot-starter-testartifactId>
    10.   <scope>testscope>
    11.  dependency>
    12. dependencies>

    EasyExcel在SpringBoot的集成非常方便，只需引入对应的pom依赖即可。在上述dependencies中添加EasyExcel的依赖：

    1. <dependency>
    2.   <groupId>com.alibabagroupId>
    3.   <artifactId>easyexcelartifactId>
    4.   <version>2.2.11version>
    5. dependency>

    EasyExcel目前稳定最新版本2.2.11。如果想查看开源项目或最新版本，可在GitHub上获得：https://github.com/alibaba/easyexcel。

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

    1. <dependency>
    2.  <groupId>org.projectlombokgroupId>
    3.  <artifactId>lombokartifactId>
    4.  <version>1.18.22version>
    5. dependency>

    下面正式开始业务相关代码的编写。如果你想直接获得完整源码，对照源码阅读本篇文章，可在公号「程序新视界」内回“1007”获得完整源码。

    实体类实现

    这里创建一个Member，会员的实体类，并在实体类中填写基础的个人信息。

    1. @Data
    2. public class Member {
    3.  
    4.  /**
    5.   * EasyExcel使用：导出时忽略该字段
    6.   */
    7.  @ExcelIgnore
    8.  private Integer id;
    9.  
    10.  @ExcelProperty("用户名")
    11.  @ColumnWidth(20)
    12.  private String username;
    13.  
    14.  /**
    15.   * EasyExcel使用：日期的格式化
    16.   */
    17.  @ColumnWidth(20)
    18.  @ExcelProperty("出生日期")
    19.  @DateTimeFormat("yyyy-MM-dd")
    20.  private Date birthday;
    21.  
    22.  /**
    23.   * EasyExcel使用：自定义转换器
    24.   */
    25.  @ColumnWidth(10)
    26.  @ExcelProperty(value = "性别", converter = GenderConverter.class)
    27.  private Integer gender;
    28.  
    29. }

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

    • @ExcelIgnore：忽略掉该字段；

    • @ExcelProperty("用户名")：设置该列的名称为”用户名“；

    • @ColumnWidth(20)：设置表格列的宽度为20；

    • @DateTimeFormat("yyyy-MM-dd")：按照指定的格式对日期进行格式化；

    • @ExcelProperty(value = "性别", converter = GenderConverter.class)：自定义内容转换器，类似枚举的实现，将“男”、“女”转换成“0”、“1”的数值。

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

    1. public class GenderConverter implements Converter<Integer> {
    2.  
    3.  private static final String MAN = "男";
    4.  private static final String WOMAN = "女";
    5.  
    6.  
    7.  @Override
    8.  public Class supportJavaTypeKey() {
    9.   // 实体类中对象属性类型
    10.   return Integer.class;
    11.  }
    12.  
    13.  @Override
    14.  public CellDataTypeEnum supportExcelTypeKey() {
    15.   // Excel中对应的CellData属性类型
    16.   return CellDataTypeEnum.STRING;
    17.  }
    18.  
    19.  @Override
    20.  public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty,
    21.                                   GlobalConfiguration globalConfiguration) {
    22.   // 从Cell中读取数据
    23.   String gender = cellData.getStringValue();
    24.   // 判断Excel中的值，将其转换为预期的数值
    25.   if (MAN.equals(gender)) {
    26.    return 0;
    27.   } else if (WOMAN.equals(gender)) {
    28.    return 1;
    29.   }
    30.   return null;
    31.  }
    32.  
    33.  @Override
    34.  public CellData convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty,
    35.                                        GlobalConfiguration globalConfiguration) {
    36.   // 判断实体类中获取的值，转换为Excel预期的值，并封装为CellData对象
    37.   if (integer == null) {
    38.    return new CellData<>("");
    39.   } else if (integer == 0) {
    40.    return new CellData<>(MAN);
    41.   } else if (integer == 1) {
    42.    return new CellData<>(WOMAN);
    43.   }
    44.   return new CellData<>("");
    45.  }
    46. }

    不同版本中，convertToJavaData和convertToExcelData的方法参数有所不同，对应的值的获取方式也不同，大家在使用时注意对照自己的版本即可。

    业务逻辑实现

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

    MemberService实现

    定义MemberService接口：

    1. public interface MemberService {
    2.  
    3.  /**
    4.   * 获取所有的成员信息
    5.   * @return 成员信息列表
    6.   */
    7.  List getAllMember();
    8.  
    9. }

    定义MemberServiceImpl实现类：

    1. @Service("memberService")
    2. public class MemberServiceImpl implements MemberService {
    3.  
    4.  
    5.  @Override
    6.  public List getAllMember() {
    7.   // 这里构造一些测试数据，具体业务场景可从数据库等其他地方获取
    8.   List list = new ArrayList<>();
    9.   Member member = new Member();
    10.   member.setUsername("张三");
    11.   member.setBirthday(getDate(1990, 10, 11));
    12.   member.setGender(0);
    13.   list.add(member);
    14.  
    15.   Member member1 = new Member();
    16.   member1.setUsername("王红");
    17.   member1.setBirthday(getDate(1999, 3, 29));
    18.   member1.setGender(1);
    19.   list.add(member1);
    20.  
    21.   Member member2 = new Member();
    22.   member2.setUsername("李四");
    23.   member2.setBirthday(getDate(2000, 2, 9));
    24.   member2.setGender(0);
    25.   list.add(member2);
    26.  
    27.   return list;
    28.  }
    29.  
    30.  private Date getDate(int year, int month, int day) {
    31.   Calendar calendar = Calendar.getInstance();
    32.   calendar.set(year, month, day);
    33.   return calendar.getTime();
    34.  }
    35. }

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

    简单导出实现

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

    1.  /**
    2.   * 普通导出方式
    3.   */
    4.  @RequestMapping("/export1")
    5.  public void exportMembers1(HttpServletResponse response) throws IOException {
    6.   List members = memberService.getAllMember();
    7.  
    8.   // 设置文本内省
    9.   response.setContentType("application/vnd.ms-excel");
    10.   // 设置字符编码
    11.   response.setCharacterEncoding("utf-8");
    12.   // 设置响应头
    13.   response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
    14.   EasyExcel.write(response.getOutputStream(), Member.class).sheet("成员列表").doWrite(members);
    15.  }

    这个实现方式非常简单直接，使用EasyExcel的write方法将查询到的数据进行处理，以流的形式写出即可。

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

    简单导出

    如果我们需要将导出的Excel进行一些格式化的处理，这就需要用到导出策略的实现了。

    自定义导入实现

    在EasyExcel执行write方法之后，获得ExcelWriterBuilder类，通过该类的registerWriteHandler方法可以设置一些处理策略。

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

    1. public class CommonCellStyleStrategy {
    2.  
    3.  /**
    4.   * 设置单元格样式(仅用于示例)
    5.   *
    6.   * @return 样式策略
    7.   */
    8.  public static HorizontalCellStyleStrategy getHorizontalCellStyleStrategy() {
    9.   // 表头策略
    10.   WriteCellStyle headerCellStyle = new WriteCellStyle();
    11.   // 表头水平对齐居中
    12.   headerCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
    13.   // 背景色
    14.   headerCellStyle.setFillForegroundColor(IndexedColors.SKY_BLUE.getIndex());
    15.   WriteFont headerFont = new WriteFont();
    16.   headerFont.setFontHeightInPoints((short) 15);
    17.   headerCellStyle.setWriteFont(headerFont);
    18.   // 自动换行
    19.   headerCellStyle.setWrapped(Boolean.FALSE);
    20.  
    21.   // 内容策略
    22.   WriteCellStyle contentCellStyle = new WriteCellStyle();
    23.   // 设置数据允许的数据格式,这里49代表所有可以都允许设置
    24.   contentCellStyle.setDataFormat((short) 49);
    25.   // 设置背景色: 需要指定 FillPatternType 为FillPatternType.SOLID_FOREGROUND 不然无法显示背景颜色.头默认了 FillPatternType所以可以不指定
    26.   contentCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);
    27.   contentCellStyle.setFillForegroundColor(IndexedColors.GREY_40_PERCENT.getIndex());
    28.   // 设置内容靠左对齐
    29.   contentCellStyle.setHorizontalAlignment(HorizontalAlignment.LEFT);
    30.   // 设置字体
    31.   WriteFont contentFont = new WriteFont();
    32.   contentFont.setFontHeightInPoints((short) 12);
    33.   contentCellStyle.setWriteFont(contentFont);
    34.   // 设置自动换行
    35.   contentCellStyle.setWrapped(Boolean.FALSE);
    36.   // 设置边框样式和颜色
    37.   contentCellStyle.setBorderLeft(BorderStyle.MEDIUM);
    38.   contentCellStyle.setBorderTop(BorderStyle.MEDIUM);
    39.   contentCellStyle.setBorderRight(BorderStyle.MEDIUM);
    40.   contentCellStyle.setBorderBottom(BorderStyle.MEDIUM);
    41.   contentCellStyle.setTopBorderColor(IndexedColors.RED.getIndex());
    42.   contentCellStyle.setBottomBorderColor(IndexedColors.GREEN.getIndex());
    43.   contentCellStyle.setLeftBorderColor(IndexedColors.YELLOW.getIndex());
    44.   contentCellStyle.setRightBorderColor(IndexedColors.ORANGE.getIndex());
    45.  
    46.   // 将格式加入单元格样式策略
    47.   return new HorizontalCellStyleStrategy(headerCellStyle, contentCellStyle);
    48.  }
    49. }

    该类中示例设置了Excel的基础格式。

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

    1. /**
    2.  * 实现CellWriteHandler接口, 实现对单元格样式的精确控制
    3.  *
    4.  * @author sec
    5.  * @version 1.0
    6.  * @date 2022/7/31
    7.  **/
    8. public class CustomCellWriteHandler implements CellWriteHandler {
    9.  
    10.  /**
    11.   * 创建单元格之前的操作
    12.   */
    13.  @Override
    14.  public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
    15.                               Head head, Integer integer, Integer integer1, Boolean aBoolean) {
    16.  
    17.  }
    18.  
    19.  /**
    20.   * 创建单元格之后的操作
    21.   */
    22.  @Override
    23.  public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell,
    24.                              Head head, Integer integer, Boolean aBoolean) {
    25.  
    26.  }
    27.  
    28.  /**
    29.   * 单元格内容转换之后的操作
    30.   */
    31.  @Override
    32.  public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
    33.                                     CellData cellData, Cell cell, Head head, Integer integer, Boolean aBoolean) {
    34.  
    35.  }
    36.  
    37.  /**
    38.   * 单元格处理后(已写入值)的操作
    39.   */
    40.  @Override
    41.  public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
    42.                               List list, Cell cell, Head head, Integer integer, Boolean isHead) {
    43.  
    44.   // 设置超链接
    45.   if (isHead && cell.getRowIndex() == 0 && cell.getColumnIndex() == 0) {
    46.    CreationHelper helper = writeSheetHolder.getSheet().getWorkbook().getCreationHelper();
    47.    Hyperlink hyperlink = helper.createHyperlink(HyperlinkType.URL);
    48.    hyperlink.setAddress("https://github.com/alibaba/easyexcel");
    49.    cell.setHyperlink(hyperlink);
    50.   }
    51.  
    52.   // 精确设置单元格格式
    53.   boolean bool = isHead && cell.getRowIndex() == 1;
    54.   if (bool) {
    55.    // 获取工作簿
    56.    Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
    57.    CellStyle cellStyle = workbook.createCellStyle();
    58.  
    59.    Font cellFont = workbook.createFont();
    60.    cellFont.setBold(Boolean.TRUE);
    61.    cellFont.setFontHeightInPoints((short) 14);
    62.    cellFont.setColor(IndexedColors.SEA_GREEN.getIndex());
    63.    cellStyle.setFont(cellFont);
    64.    cell.setCellStyle(cellStyle);
    65.   }
    66.  }
    67. }

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

    通过上面的定义两个策略实现，在导出Excel可以使用上述两个策略实现：

    1.  /**
    2.   * 基于策略及拦截器导出
    3.   */
    4.  @RequestMapping("/export2")
    5.  public void exportMembers2(HttpServletResponse response) throws IOException {
    6.   List members = memberService.getAllMember();
    7.  
    8.   // 设置文本内省
    9.   response.setContentType("application/vnd.ms-excel");
    10.   // 设置字符编码
    11.   response.setCharacterEncoding("utf-8");
    12.   // 设置响应头
    13.   response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
    14.   EasyExcel.write(response.getOutputStream(), Member.class).sheet("成员列表")
    15.     // 注册通用格式策略
    16.     .registerWriteHandler(CommonCellStyleStrategy.getHorizontalCellStyleStrategy())
    17.     // 设置自定义格式策略
    18.     .registerWriteHandler(new CustomCellWriteHandler())
    19.     .doWrite(members);
    20.  }

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

    附带格式的Excel

    可以看出，导出的Excel已经附带了具体的格式。其中表头“用户名”上也携带了对应的超链接。其他更精细化的控制，大家可以在策略类中做进一步的控制。

    同步获取结果导入实现

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

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

    1.  /**
    2.   * 从Excel导入会员列表
    3.   */
    4.  @RequestMapping(value = "/import1", method = RequestMethod.POST)
    5.  @ResponseBody
    6.  public void importMemberList(@RequestPart("file") MultipartFile file) throws IOException {
    7.   List list = EasyExcel.read(file.getInputStream())
    8.     .head(Member.class)
    9.     .sheet()
    10.     .doReadSync();
    11.   for (Member member : list) {
    12.    System.out.println(member);
    13.   }
    14.  }

    注意，在上述代码中，最终调用的是doReadSync()方法。

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

    PostMan导入

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

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

    说明上传成功，并且解析成功。

    基于监听导入实现

    上面示例中是基于同步获取结果列表的形式进行导入，还有一种实现方式是基于监听器的形式来实现。这种形式可以达到边解析边处理业务逻辑的效果。

    定义Listener：

    1. public class MemberExcelListener extends AnalysisEventListener<Member> {
    2.  
    3.  @Override
    4.  public void invoke(Member member, AnalysisContext analysisContext) {
    5.   // do something
    6.   System.out.println("读取Member=" + member);
    7.   // do something
    8.  }
    9.  
    10.  @Override
    11.  public void doAfterAllAnalysed(AnalysisContext analysisContext) {
    12.   // do something
    13.   System.out.println("读取Excel完毕");
    14.   // do something
    15.  }
    16. }

    在MemberExcelListener中可以针对每条数据进行对应的业务逻辑处理。

    对外接口实现如下：

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

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

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

    说明解析成功，并且在解析的过程中，进行了业务逻辑的处理。

    小结

    本篇文章基于SpringBoot集成EasyExcel的实现展开，为大家讲解了EasyExcel在实践中的具体运用。大家可根据需要，进行变通处理。同时，基于自定义转换器、自定义策略、自定义监听器等形式达到灵活适用于各种场景。希望本篇文章能给大家带来帮助。

    如果本文对你有帮助，别忘记给我个3连 ，点赞，转发，评论，

    学习更多JAVA知识与技巧，关注博主学习JAVA 课件，源码，安装包，还有最新大厂面试资料等等等

    咱们下期见。

    收藏 等于白嫖，点赞才是真情。

  • 相关阅读:
    指针巩固习题
    【教3妹学mysql】复杂的深度分页问题优化
    STM32_project:led_beep
    ISP Pipeline
    C#:实现BinaryInsertionSorter折半插入排序算法(附完整源码)
    30天精通Nodejs--第二天：模块系统与npm
    JAVA毕业设计129—基于Java+Springboot+thymeleaf的物业管理系统(源代码+数据库)
    【CVPR2022】用于域适应语义分割的域无关先验
    如何在Vue中实现拖拽上传文件
    指针进阶&&数组进阶【详解】
  • 原文地址：https://blog.csdn.net/uuqaz/article/details/126249519