跳到主要内容

注解

本章节介绍读取 FastExcel 中提供的注解。

实体类注解​

实体类是读写操作的基础。FastExcel 提供了多种注解，帮助开发者轻松定义字段和格式。

@ExcelProperty​

定义 Excel 列名和映射的字段名。 具体参数如下：

名称默认值描述
value空用于匹配 excel 中的头，必须全匹配,如果有多行头，会匹配最后一行头
orderInteger.MAX_VALUE优先级高于 value，会根据 order 的顺序来匹配实体和 excel 中数据的顺序
index-1优先级高于 value 和 order，会根据 index 直接指定到 excel 中具体的哪一列
converter自动选择指定当前字段用什么转换器，默认会自动选择。读的情况下只要实现 cn.idev.excel.converters.Converter#convertToJavaData(com.idev.excel.converters.ReadConverterContext<?>) 方法即可

@ExcelIgnore​

默认所有字段都会和 Excel 去匹配，加了这个注解会忽略该字段。

@ExcelIgnoreUnannotated​

默认不加 @ExcelProperty 的注解的都会参与读写，加了不会参与读写。

@DateTimeFormat​

日期转换，用 String 去接收 excel 日期格式的数据会调用这个注解,参数如下：

名称默认值描述
value空参照 java.text.SimpleDateFormat 书写即可
use1904windowing自动选择excel 中时间是存储 1900 年起的一个双精度浮点数，但是有时候默认开始日期是 1904，所以设置这个值改成默认 1904 年开始

@NumberFormat​

数字转换，用 String 去接收 excel 数字格式的数据会调用这个注解。

名称默认值描述
value空参照 java.text.DecimalFormat 书写即可
roundingModeRoundingMode.HALF_UP格式化的时候设置舍入模式

@ColumnWidth​

指定列宽。