Java 如何快速,优雅的实现导出Excel

时间:2021-07-15 00:03:52

前言:

春节假期刚刚过去,大家是不是已经开始了搬砖生活啦,嘻嘻 o(∩_∩)o ,可我还在休假中呢 !

好啦,咱们言归正传,开始聊聊正文。做过后端管理系统的同学,大概率都会收到过实现 导出Excel 的功能需求,因为这个功能在后台管理系统中是个必备功能。

那大家是怎么实现这个功能的呢?

  • 使用Apache提供POI组件实现;
  • 使用现成的、简便的第三方工具库(避免重复造*)

Hutool 工具库中的Excel工具类
EasyExcel 阿里开源的基于Java的简单、省内存的读写Excel工具库

接下来咱们来聊聊使用 Hutool、EasyExcel 工具库实现导出Excel。

使用第三方库实现导出Excel

业界有句话:不重复造*。 使用工具类可以减少日常繁琐的编码,减少重复的编码时间,提高开发效率。 作为程序员,应该多善于利用工具减少代码冗余,美化自己的代码。

使用 Hutool 工具库实现导出Excel:

1、首先添加依赖
在pom.xml中添加上依赖:

  1. <!--hutool 导出 Excel 工具组件-->
  2. <dependency>
  3.   <groupId>cn.hutool</groupId>
  4.   <artifactId>hutool-all</artifactId>
  5.   <version>5.1.0</version>
  6. </dependency>
  7.  
  8. <!--POI组件-->
  9. <dependency>
  10.   <groupId>org.apache.poi</groupId>
  11.   <artifactId>poi-ooxml</artifactId>
  12.   <version>4.1.0</version>
  13. </dependency>

上面除了引入了 hutool 依赖之外,还引入了 poi-ooxml 依赖,这个包会自动关联引入poi包,且可以很好的支持Office2007+的文档格式 。

2、然后使用工具类实现导出Excel

  1. import cn.hutool.core.collection.CollUtil;
  2. import cn.hutool.poi.excel.ExcelUtil;
  3. import cn.hutool.poi.excel.ExcelWriter;
  4. import cn.hutool.poi.excel.StyleSet;
  5. import org.apache.poi.ss.usermodel.CellStyle;
  6. import org.apache.poi.ss.usermodel.Font;
  7.  
  8. import java.util.ArrayList;
  9. import java.util.Date;
  10. import java.util.LinkedHashMap;
  11. import java.util.List;
  12. import java.util.Map;
  13.  
  14. /**
  15.  * @PACKAGE_NAME: com.lyl.excel
  16.  * @ClassName: HutoolExcelUtils
  17.  * @Description: 使用 Hutool 中的工具类实现 Excel的导出
  18.  * @Date: 2021-02-18 16:24
  19.  * @Author: [木子雷] 公众号
  20.  **/
  21. public class HutoolExcelUtils {
  22.  
  23.     /**
  24.      * 导出Excel
  25.      *
  26.      * @param args
  27.      */
  28.     public static void main(String[] args) {
  29.  
  30.         ArrayList<Map<String, Object>> rows = CollUtil.newArrayList(data());
  31.         ExcelWriter writer = null;
  32.  
  33.         try {
  34.             String path = "E:/QQPCmgr/Desktop/";
  35.  
  36.             String excelName = "Hutool" + System.currentTimeMillis() + ".xlsx";
  37.             // 通过工具类创建writer,固定的文件输出路径
  38.             writer = ExcelUtil.getWriter(path + excelName);
  39.  
  40.             // 定义第一行合并单元格样式
  41.             CellStyle headCellStyle = writer.getHeadCellStyle();
  42.             // 设置内容字体
  43.             Font font = writer.createFont();
  44.             // 字体加粗
  45.             font.setBold(true);
  46.             // 字体颜色
  47.             font.setColor(Font.COLOR_RED);
  48.             headCellStyle.setFont(font);
  49.  
  50.             // 设置第 0 列的单元格的宽度,列数从零开始计算
  51.             writer.setColumnWidth(0, 20);
  52.             writer.setColumnWidth(1, 20);
  53.             writer.setColumnWidth(2, 20);
  54.  
  55.             // 定义数据行的样式
  56.             StyleSet style = writer.getStyleSet();
  57.             // 设置单元格文本内容自动换行
  58.             style.setWrapText();
  59.  
  60.             // 合并单元格后的标题行(第一行),使用默认标题样式
  61.             writer.merge(rows.get(0).size() - 1, "导出测试:TEST");
  62.             // 一次性写出内容,使用默认样式,强制输出标题
  63.             writer.write(rows, true);
  64.  
  65.         } catch (Exception e) {
  66.             e.printStackTrace();
  67.         } finally {
  68.             if (writer != null) {
  69.                 // 记住关闭 writer,释放内存
  70.                 writer.close();
  71.             }
  72.         }
  73.     }
  74.  
  75.     /**
  76.      * 构造 导出的数据
  77.      *
  78.      * @return
  79.      */
  80.     public static List<Map<String, Object>> data() {
  81.         // 导出的数据
  82.         ArrayList<Map<String, Object>> rows = new ArrayList<>();
  83.  
  84.         for (int i = 0; i < 10; i++) {
  85.             Map<String, Object> row = new LinkedHashMap<>();
  86.  
  87.             row.put("字符串标题", "字符串" + i);
  88.             row.put("日期标题", new Date());
  89.             row.put("数字标题", 0.56);
  90.             rows.add(row);
  91.         }
  92.         return rows;
  93.     }
  94.  
  95. }

注意:

  • 记得修改代码中导出Excel的路径 path
  • 导出Excel的样式是可以灵活变化的,可以自行进行设置

3、导出Excel的样式如下

Java 如何快速,优雅的实现导出Excel

4、注意事项

  • 在导出大数据量时,可能会出现内存溢出的问题,不要担心,Hutool也为我们提供了 BigExcelWriter 来避免大数据量输出时可能会出现的内存溢出问题。
  • 上面的例子中,只实现了部分的样式设置,Hutool还提供了许多其它的样式,大家可以自行去尝试;并且 Hutool 也支持写出到 Web客户端下载 。

官方文档地址: Hutool 操作 Excel

使用 EasyExcel 工具库实现导出Excel:

EasyExcel是一个基于Java的简单、省内存的读写Excel的 阿里开源 项目;正如它在GitHub中项目代码介绍的那样:一个快速、简单避免OOM的java处理Excel工具。

测试得知 64M内存1分钟内读取75M(46W行25列)的Excel ;除此之外还有 急速模式 能更快,但是内存占用会在100M多一点 。

1、首先添加依赖

  1. <!--  阿里开源的 excel 工具类库 -->
  2. <dependency>
  3.   <groupId>com.alibaba</groupId>
  4.   <artifactId>easyexcel</artifactId>
  5.   <version>2.2.6</version>
  6. </dependency>

注意: 此依赖不能和 poi-ooxml 依赖在一起用,否则运行时会报 类找不到 的异常。

2、然后使用工具类实现导出Excel
①、导出的数据模版类:

  1. import com.alibaba.excel.annotation.ExcelIgnore;
  2. import com.alibaba.excel.annotation.ExcelProperty;
  3. import com.alibaba.excel.annotation.write.style.ColumnWidth;
  4. import com.alibaba.excel.annotation.write.style.ContentFontStyle;
  5. import com.alibaba.excel.annotation.write.style.ContentRowHeight;
  6. import com.alibaba.excel.annotation.write.style.ContentStyle;
  7. import com.alibaba.excel.annotation.write.style.HeadFontStyle;
  8. import com.alibaba.excel.annotation.write.style.HeadRowHeight;
  9. import com.alibaba.excel.annotation.write.style.HeadStyle;
  10. import org.apache.poi.ss.usermodel.FillPatternType;
  11.  
  12. import java.util.Date;
  13.  
  14. /**
  15.  * @PACKAGE_NAME: com.lyl.excel
  16.  * @ClassName: DemoData
  17.  * @Description:  使用 EasyExcel 导出数据时的数据模版
  18.  * @Date: 2021-01-27 17:46
  19.  * @Author: [木子雷] 公众号
  20.  **/
  21.  
  22. // 标题行 背景设置成红色 IndexedColors.RED.getIndex()
  23. @HeadStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 10)
  24. // 标题行 字体设置成20
  25. @HeadFontStyle(fontHeightInPoints = 20)
  26. @ContentRowHeight(25)// 文本内容行的高度
  27. @HeadRowHeight(30)// 标题行的高度
  28. @ColumnWidth(20)// 全局的列宽
  29. public class DemoData {
  30.  
  31.     // 字符串的列内容 背景设置成天蓝 IndexedColors.SKY_BLUE.getIndex()
  32.     @ContentStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 40)
  33.     // 字符串的列内容 字体设置成20
  34.     @ContentFontStyle(fontHeightInPoints = 20)
  35.     @ExcelProperty({"导出测试:TEST", "字符串标题"})
  36.     private String string;
  37.  
  38.     @ColumnWidth(30)
  39.     @ExcelProperty({"导出测试:TEST", "日期标题"})
  40.     private Date date;
  41.  
  42.     @ExcelProperty({"导出测试:TEST", "数字标题"})
  43.     private Double doubleData;
  44.  
  45.     /**
  46.      * 忽略这个字段
  47.      */
  48.     @ExcelIgnore
  49.     private String ignore;
  50.  
  51.     public String getString() {
  52.         return string;
  53.     }
  54.  
  55.     public void setString(String string) {
  56.         this.string = string;
  57.     }
  58.  
  59.     public Date getDate() {
  60.         return date;
  61.     }
  62.  
  63.     public void setDate(Date date) {
  64.         this.date = date;
  65.     }
  66.  
  67.     public Double getDoubleData() {
  68.         return doubleData;
  69.     }
  70.  
  71.     public void setDoubleData(Double doubleData) {
  72.         this.doubleData = doubleData;
  73.     }
  74.  
  75.     public String getIgnore() {
  76.         return ignore;
  77.     }
  78.  
  79.     public void setIgnore(String ignore) {
  80.         this.ignore = ignore;
  81.     }
  82. }

注意: 这个数据模版类中使用了大量的 自定义注解 ,通过使用注解可以使代码变得更加的优雅、简洁 。

关于项目中自定义注解的实际使用可以参考:自定义注解的魅力你到底懂不懂

②、实现数据导出到Excel:

  1. import com.alibaba.excel.EasyExcel;
  2.  
  3. import java.util.ArrayList;
  4. import java.util.Date;
  5. import java.util.List;
  6.  
  7. /**
  8.  * @PACKAGE_NAME: com.lyl.excel
  9.  * @ClassName: EasyExcelUtils
  10.  * @Description: 阿里巴巴 开源的  easyexcel 工具
  11.  * @Date: 2021-01-20 16:58
  12.  * @Author: [木子雷] 公众号
  13.  **/
  14. public class EasyExcelUtils {
  15.  
  16.     public static void main(String[] args) {
  17.         // 导出Excel的路径
  18.         String path = "E:/QQPCmgr/Desktop/";
  19.  
  20.         // 导出Excel路径 + 文件名称
  21.         String filename = path + "EasyExcel" + System.currentTimeMillis() + ".xlsx";
  22.  
  23.         /**
  24.          * 导出excel
  25.          * filename:导出excel全路径
  26.          * DemoData.class:导出excel时的 数据模版
  27.          * 模板:指的是导出excel的sheet页
  28.          * data():构造的DemoData.class数据模版的数据集合 
  29.          */
  30.         EasyExcel.write(filename, DemoData.class).sheet("模板").doWrite(data());
  31.     }
  32.  
  33.     /**
  34.      * 构造 导出的数据
  35.      *
  36.      * @return
  37.      */
  38.     private static List<DemoData> data() {
  39.         List<DemoData> list = new ArrayList<DemoData>();
  40.         for (int i = 0; i < 10; i++) {
  41.             DemoData data = new DemoData();
  42.             data.setString("字符串" + i);
  43.             data.setDate(new Date());
  44.             data.setDoubleData(0.56);
  45.             list.add(data);
  46.         }
  47.         return list;
  48.     }
  49. }

注意:

记得修改代码中导出Excel的路径 path

  • 导出Excel的样式是可以灵活变化的,可以自行进行设置

3、导出Excel的样式如下

Java 如何快速,优雅的实现导出Excel

4、EasyExcel 导出Excel扩展:

上面导出Excel的例子中,只实现了其中一部分功能,还有很多功能由于篇幅原因没法一一展示出来,在这就简单说下支持的其它功能:

  • 通过设置 只导出模版数据中的指定列数据
  • 通过设置 将模版数据中的列数据导出到Excel中指定的列上
  • 可以将导出的数据分多个批次导入到同一个Excel中,避免大数据量时的内存溢出问题
  • 导出数据的自定义格式转换,例如:日志、数字的格式转换等
  • 支持将图片导出到Excel中
  • 支持根据已有的Excel模版样式 将数据导出Excel
  • 支持单元格合并、表格方式导出、自动列宽、设置单元格下拉、超链接等、以及插入批注
  • 除了上面的导出Excel功能之外,EasyExcel还支持 读取Excel数据、Web客户端的上传、下载等 ;

官方文档地址: 阿里开源 EasyExcel

项目代码地址: alibaba/easyexcel

EasyExcel项目代码拉取下来后,可以直接去单元测试包下,查看已提供的功能测试使用方法:

Java 如何快速,优雅的实现导出Excel

以上就是Java 如何快速,优雅的实现导出Excel的详细内容,更多关于Java 实现导出Excel的资料请关注服务器之家其它相关文章!

原文链接:https://leishen6.github.io/2021/02/19/exportExcel/