当前位置: 首页 > 工具软件 > EasyPoi > 使用案例 >

easypoi的常用注解

逑何平
2023-12-01

easypoi的常用注解

常用注解

@Excel注解

@Excel注解是作用到Filed上面,是对Excel一列的一个描述,这个注解是必须要的注解,其属性如下:

属性类型默认值功能
nameStringnull对应Excel的列名
orderNumString“0”列的排序
formatString” “时间格式化,相当于同时设置exportFormat和importFormat
exportFormatString" "导出时的时间格式
importFormatString" "导入时的时间格式
typeint1导出类型:1是文本(默认),2是图片,3是函数,10是数字
replaceString[]{}值的替换,replace = {"男_1", "女_2"}将值为1的替换为男
needMergebooleanfalse是否需要纵向合并单元格(用于list创建的多个row)
numFormatString" "数字格式化,使用对象DecimalFormat
suffixString" "文字后缀
widthdouble10列宽
heightdouble10行高,后期打算统一使用@ExcelTarget的height,这个会被废弃
savePathString“/upload/”导入文件保存路径,默认是”target/classes/upload/类名“
isStatisticsbooleanfalse自动统计数据,在行尾进行统计,会吞没异常
isImportFieldbooleanfalse导入Excel时,对Excel中的字段进行校验,如果没有该字段,导入失败
isColumnHiddenbooleanfalse导出隐藏列
databaseFormatString“yyyyMMddHHmmss”导出时间设置,如果字段是data类型则不需要设置,数据库如果是String类型,这个需要设置这个数据库格式,用来转换时间格式输出
isWrapbooleantrue是否换行及支持\n
mergeRelyint[]{}合并单元格依赖关系,比如第二列合并是基于第一列
imageTypeint1导出类型1:冲file读取,2:从数据库中读取,默认是文件,导入也是一样

@ExcelCollection 注解

@ExcelCollection 注解表示一个集合,主要针对一对多的导出
比如一个老师对应多个科目,科目就可以用集合表示,作用在一个类型是List的属性上面,属性如下:

属性类型默认值功能
nameStringnull对应集合的列名
orderNumString“0”排序
typeClassArrayList.class导入时创建对象时使用

@ExcelTarget注解

作用于最外层的对象,描述这个对象的id,以便支持一个对象可以针对不同导出做出不同处理

@ExcelEntity注解

@ExcelEntity注解表示一个继续深入导出的实体,是作用一个类型为实体的属性上面

ImportParams参数

属性类型默认值功能
titleRowsint0表格标题行数
headRowsint1表头行数
startRowsint0字段值与列标题之间的距离
keyIndexint0主键
startSheetIndexint0开始读取的sheet位置
sheetNumint1上传表格需要读取的sheet数量
needSavebooleanfalse是否需要保存上传的Excel
needVerfiybooleanfalse是否需要校验上传的Excel
verifyHanlderIExcelVerifyHandlernull校验处理接口自定义校验
importFieldsString[]null导入时校验数据模板,是不是正确的Excel
 类似资料: