关注程序员7歌,一起用技术改变世界
在我们实际开发中经常会遇到Excel的导入与导出功能,而目前Excel操作工具也是数不甚数啊,但是7歌用过很多,还是觉得最近发现的tool-excel好用,让你实现一语句代码就能完成Excel功能。
首先我们提供安装依赖:
cn.gjingtools-excel1.1.0
我们先来了解一下tool-excel的注解:
1、@Excel
该注解是使用在类上,表明此类是用来绑定excel的,参数如下:
value:说明excel的文件名,优先级低于方法传入的文件名
type:说明excel的文档类型,默认为XLS
style:说明导出excel的样式
2、@ExcelField
该注解是使用在字段上,表明这是Excel的列表头,参数如下:
value:说明列表头名
pattern:说明时间的转换格式(时间才需要指定)
width:说明列表头的宽度
3、@DateValid
该注解是使用在时间字段的时间校验,表明我这个列表头下指定行数的单元格要进行数据校验,XLSX类型文档不支持,参数如下:
validClass:校验器
ClassboxLastRow:数据校验最多校验多少行,默认是正文第一行
pattern:校验的时间格式,默认yyyy-MM-dd
operatorType:操作类型,默认OperatorType.BETWEEN
expr1:表达式1,默认1970-01-01
expr2:表达式2,默认2999-01-01
showErrorBox:是否弹出错误框,默认true
showPromptBox:是否立即弹出,默认true
allowEmpty:是否允许空值,默认true
rank:提示框级别,默认Rank.WARING警告级别
errorTitle:错误框标题
errorContent:详细错误内容
4、@ExplicitValid
该注解是用来明确范围内容校验的,参数如下:
alidClass:校验器
Classcombobox:范围值,数组类型
boxLastRow:数据校验最多校验多少行,默认是该列表头下的正文第一行
showErrorBox:是否弹出错误框,默认true
rank:提示框级别,默认Rank.WARING警告级别
showPromptBox:是否立即弹出,默认true
errorTitle:错误框标题
errorContent:详细错误内容
5、@NumericValid
该注解用于数据类型的校验,使用在Excel字段上,参数如下:
validClass:校验器
ClassboxLastRow:数据校验最多校验多少行,默认是该列表头下的正文第一行
operatorType:操作类型,默认OperatorType.EQUAL
validationType:校验类型,必填
expr1:表达式1,在表达式2前面,必填
expr2:表达式2,在操作类型为BETWEEN和NOT_BETWEEN情况下必填
showErrorBox:是否弹出错误框,默认true
showPromptBox:是否立即弹出,默认true
allowEmpty:是否允许空值,默认true
rank:提示框级别,默认Rank.WARING警告级别
errorTitle:错误框标题
errorContent:详细错误内容
6、@ExcelEnumConvert
该注解是用于枚举转换,使用在枚举的Excel字段上,参数如下:
convert:实现了EnumConvert接口的类Class
那么我们来看一下tool-excel的具体使用方法:
1、Excel操作实体类:
@Excel(value = "教师评价信息",type = Type.XLS)public class TeacherEvalExcel implements Serializable {private static final long serialVersionUID = -6458620790191821524L;/*** 教师姓名*/@ExcelField("教师姓名")private String teacherName;/*** 当前任教年级*/@ExcelField("当前任教年级")private String gradeNames;/*** 任教科目*/@ExcelField("任教科目")private String courseNames;/*** 评价指标*/@ExcelField("评价指标")private String evalName;/*** 评价项目*/@ExcelField("评价项目")private String evalItemName;/*** 所属学年学期*/@ExcelField("所属学年学期")private String semesterName;/*** 录入时间*/@ExcelField("录入时间")private String inputTime;}
从上面的实体看出,我们加入了@Excel,@ExcelField就可以啦。
2、使用tool-excel实现excel导出功能
/*** 导出教师评价信息* @param pageParamVo* @return* @author zqk*/@PostMapping("/exportExcel")public void exportExcel(@RequestBody PageParamVo pageParamVo){ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletResponse response = servletRequestAttributes.getResponse();PageVo pager = pageParamVo.getPager();pager.setPageSize(-1L);List teacherEvalExcels = teacherEvalService.exportExcelData(new Page<>(pager.getCurrent(), pager.getSize()),pageParamVo.getContent());ExcelFactory.createWriter("教师评价息", TeacherEvalExcel.class, response, teacherEvalExcels).write();}
从上面的代码可以看出,我们实现excel导出就使用了一句代码:
ExcelFactory.createWriter("教师评价息", TeacherEvalExcel.class, response, teacherEvalExcels).write();
如果我们需要导出excel模版,那么我们在wirite()方法里面传入null即可。
3、使用tool-excel实现excel导入功能
/*** 导入教师评价信息* @param file* @return* @throws IOException* @author zqk*/@PostMapping("/importExcel")public Result importExcel(MultipartFile file) throws IOException {List users = ExcelFactory.createReader(file.getInputStream(), TeacherEval.class).read();teacherEvalService.saveTeacherEval(users);return Result.ok("导入成功");}
以上就是使用tool-excel操作excel的方法,接下来我么看看其他注解使用;
4、数据校验的使用:
在导出模板时,我们可以对用户填写的内容进行数据格式校验,如下:
/*** 对数据的前十行进行校验,必须输入大于3的数字*/@ExcelField("用户名")@NumericValid(validationType = ValidType.TEXT_LENGTH, expr1 = "3", operatorType = OperatorType.GREATER_OR_EQUAL,boxLastRow = 10)private String userName;@ExcelField(value = "创建时间",pattern = "yyyy-MM-dd")/*** 时间只能输入在2019-10-11至2019-10-30范围的时间*/@DateValid(expr1 = "2019-10-12",expr2 = "2019-10-30")private Date createTime;
好了,以上就是使用工具导出Excel数据信息,今天就给大家介绍到这里吧,大家有什么不懂
的可以私信我~~❤️❤️