欢迎来到本站
0

Excel 导入导出

2023.07.28 | along | 178次围观

Excel 导入导出

项目的 yudao-spring-boot-starter-excel (opens new window)技术组件,基于 EasyExcel 实现 Excel 的读写操作,可用于实现最常见的 Excel 导入导出等功能。

EasyExcel 的介绍?

EasyExcel 是阿里开源的 Excel 工具库,具有简单易用、低内存、高性能的特点。

在尽可用节约内存的情况下,支持百万行的 Excel 读写操作。例如说,仅使用 64M 内存,20 秒完成 75M(46 万行 25 列)Excel 的读取。并且,还有极速模式能更快,但是内存占用会在100M 多一点。

EasyExcel

#1. Excel 导出

以 [系统管理 -> 岗位管理] 菜单为例子,讲解它 Excel 导出的实现。

系统管理 -> 岗位管理

#1.1 后端导入实现

在 PostController (opens new window)类中,定义 /admin-api/system/post/export 导出接口。代码如下:

导出 Excel 接口

  • ① 将从数据库中查询出来的列表,转换成对应的 PostExcelVO 列表。

  • ② 将 PostExcelVO 列表,转换成 Excel 文件,返回给前端。

#1.1.1 PostExcelVO 类

创建 PostExcelVO (opens new window)类,岗位 Excel 导出的 VO 类。它有两个作用,代码如下:

PostExcelVO 代码

① 每个字段上的 @ExcelProperty (opens new window)注解,声明 Excel Head 头部的名字。

② 每个字段的,就是它对应的 Excel Row 行的数据值。

因此,最终 Excel 导出的效果如下:

PostExcelVO 效果

另外,在上述代码的红线部分,@ExcelProperty 注解的 converter 属性是 DictConvert 转换器,通过它将 status = 1 转换成“开启”列,status = 0 转换成”禁用”列。稍后,我们会在 「3. 字段转换器」 小节来详细讲讲。

#1.1.2 ExcelUtils 写入

ExcelUtils 的 #write(...) (opens new window)方法,将列表以 Excel 响应给前端。代码如下图:

write 方法

#1.2 前端导入实现

在 post/index.vue (opens new window)界面,定义 #handleExport() 操作,代码如下图:

handleExport 方法

#2. Excel 导入

以 [系统管理 -> 用户管理] 菜单为例子,讲解它 Excel 导出的实现。

系统管理 -> 用户管理

#2.1 后端导入实现

在 UserController (opens new window)类中,定义 /admin-api/system/user/import 导入接口。代码如下:

导入 Excel 接口

将前端上传的 Excel 文件,读取成 UserImportExcelVO 列表。

#2.1.1 UserImportExcelVO 类

创建 UserImportExcelVO (opens new window)类,用户 Excel 导入的 VO 类。它的作用和 Excel 导入是一样的,代码如下:

UserImportExcelVO 代码

对应使用的 Excel 导入文件如下:

UserImportExcelVO 文件

#2.1.2 ExcelUtils 读取

ExcelUtils 的 #read(...) (opens new window)方法,读取 Excel 文件成列表。代码如下图:

read 方法

#2.2 前端导入实现

在 user/index.vue (opens new window)界面,定义 Excel 导入的功能,代码如下图:

Excel 导入的功能

#3. 字段转换器

EasyExcel 定义了 Converter (opens new window)接口,用于实现字段的转换。它有两个核心方法:

① #convertToJavaData(...) 方法:将 Excel Row 对应表格的值,转换成 Java 内存中的值。例如说,Excel 的“状态”列,将“状态”列转换成 status = 1,”禁用”列转换成 status = 0

② #convertToExcelData(...) 方法:恰好相反,将 Java 内存中的值,转换成 Excel Row 对应表格的值。例如说,Excel 的“状态”列,将 status = 1 转换成“开启”列,status = 0 转换成”禁用”列。

#3.1 DictConvert 实现

以项目中提供的 DictConvert (opens new window)举例子,它实现 Converter 接口,提供字典数据的转换。代码如下:

DictConvert 实现

实现的代码比较简单,自己看看就可以明白。

#3.1 DictConvert 使用示例

在需要转换的字段上,声明注解 @ExcelProperty 的 converter 属性是 DictConvert 转换器,注解 @DictFormat (opens new window)为对应的字典数据的类型。示例如下:

DictConvert 使用示例

#4. 更多 EasyExcel 注解

基于 《EasyExcel 中的注解 》 (opens new window)文章,整理相关注解。

#4.1 @ExcelProperty

这是最常用的一个注解,注解中有三个参数 valueindexconverter 分别代表列明、列序号、数据转换方式。value 和 index 只能二选一,通常不用设置 converter

最佳实践

public class ImeiEncrypt {
    
    @ExcelProperty(value = "imei")
    private String imei;}

#4.2 @ColumnWith

用于设置列宽度的注解,注解中只有一个参数 valuevalue 的单位是字符长度,最大可以设置 255 个字符,因为一个 Excel 单元格最大可以写入的字符个数,就是 255 个字符。

最佳实践

public class ImeiEncrypt {
    
    @ColumnWidth(value = 18)
    private String imei;}

#4.3 @ContentFontStyle

用于设置单元格内容字体格式的注解。参数如下:

参数含义
fontName字体名称
fontHeightInPoints字体高度
italic是否斜体
strikeout是否设置删除水平线
color字体颜色
typeOffset偏移量
underline下划线
bold是否加粗
charset编码格式

#4.4 @ContentLoopMerge

用于设置合并单元格的注解。参数如下:

参数含义
eachRow
columnExtend

#4.5 @ContentRowHeight

用于设置行高。参数如下:

参数含义
value行高,-1代表自动行高

#4.6 @ContentStyle

设置内容格式注解。参数如下:

参数含义
dataFormat日期格式
hidden设置单元格使用此样式隐藏
locked设置单元格使用此样式锁定
quotePrefix在单元格前面增加`符号,数字或公式将以字符串形式展示
horizontalAlignment设置是否水平居中
wrapped设置文本是否应换行。将此标志设置为true通过在多行上显示使单元格中的所有内容可见
verticalAlignment设置是否垂直居中
rotation设置单元格中文本旋转角度。03版本的Excel旋转角度区间为-90°~90°,07版本的Excel旋转角度区间为0°~180°
indent设置单元格中缩进文本的空格数
borderLeft设置左边框的样式
borderRight设置右边框样式
borderTop设置上边框样式
borderBottom设置下边框样式
leftBorderColor设置左边框颜色
rightBorderColor设置右边框颜色
topBorderColor设置上边框颜色
bottomBorderColor设置下边框颜色
fillPatternType设置填充类型
fillBackgroundColor设置背景色
fillForegroundColor设置前景色
shrinkToFit设置自动单元格自动大小

#4.7 @HeadFontStyle

用于定制标题字体格式。参数如下:

参数含义
fontName设置字体名称
fontHeightInPoints设置字体高度
italic设置字体是否斜体
strikeout是否设置删除线
color设置字体颜色
typeOffset设置偏移量
underline设置下划线
charset设置字体编码
bold设置字体是否家畜

#4.8 @HeadRowHeight

设置标题行行高。参数如下:

参数含义
value设置行高,-1代表自动行高

#4.9 @HeadStyle

设置标题样式。参数如下:

参数含义
dataFormat日期格式
hidden设置单元格使用此样式隐藏
locked设置单元格使用此样式锁定
quotePrefix在单元格前面增加`符号,数字或公式将以字符串形式展示
horizontalAlignment设置是否水平居中
wrapped设置文本是否应换行。将此标志设置为true通过在多行上显示使单元格中的所有内容可见
verticalAlignment设置是否垂直居中
rotation设置单元格中文本旋转角度。03版本的Excel旋转角度区间为-90°~90°,07版本的Excel旋转角度区间为0°~180°
indent设置单元格中缩进文本的空格数
borderLeft设置左边框的样式
borderRight设置右边框样式
borderTop设置上边框样式
borderBottom设置下边框样式
leftBorderColor设置左边框颜色
rightBorderColor设置右边框颜色
topBorderColor设置上边框颜色
bottomBorderColor设置下边框颜色
fillPatternType设置填充类型
fillBackgroundColor设置背景色
fillForegroundColor设置前景色
shrinkToFit设置自动单元格自动大小

#4.10 @ExcelIgnore

不将该字段转换成 Excel。

#4.11 @ExcelIgnoreUnannotated

没有注解的字段都不转换


版权声明

本文仅代表作者观点,不代表xx立场。
本文系作者授权xxx发表,未经许可,不得转载。

分享:

扫一扫在手机阅读、分享本文

发表评论