因为项目的原因需要用到POI来操作Excel 文档,以前都是直接使用POI来操作的,但是最近听到easypoi的存在,所以自己简单的尝试了下! 别说,他还真的挺好用的
Easypoi介绍
Easypoi 为谁而开发
都可以使用easypoi
Easypoi的目标是什么 Easypoi的目标不是替代poi,而是让一个不懂导入导出的快速使用poi完成Excel和word的各种操作,而不是看很多api才可以完成这样工作
为什么会写Easypoi
以前的以前(岁月真TMD的快)我虽然写了不少代码但还是很少写poi,然后跳到一家公司之后就和业务人员聊上了,来这个需要个报表,这个报表样式是这样的,这个表头是这样的,就这样我写了大量的poi代码,每次都是大量的篇幅,copy to copy,无聊的一逼,然后加入了jeecg,jeecg中有一个小的工具类,虽然我也不知道是谁写的,然是可以用注解搞定最简单的导出,突然豁然开朗,我可以完善,让我从报表的苦海当中脱离出来,这样我花了一周的时间做了第一个版本支持导入导出放到了jeecg,发现还是不错的,慢慢的用的人越来越多,我就把这块独立出来了,再然后有人提出了模板,然后就加入了模板功能,提出了word的需求,加入了word的功能,后来工作忙了虽然没再参与jeecg,但还是一直维持这easypoi的更新,根据见识的增长也不断的重构这代码,直到现在
独特的功能
使用
如果不使用spring mvc的便捷福利,直接引入easypoi-base 就可以了,easypoi-annotation
如果使用maven,请使用如下坐标
cn.afterturn
easypoi-base
3.1.0
cn.afterturn
easypoi-web
3.1.0
cn.afterturn
easypoi-annotation
3.1.0
注解
注解介绍
easypoi起因就是Excel的导入导出,最初的模板是实体和Excel的对应,model--row,filed--col 这样利用注解我们可以和容易做到excel到导入导出 经过一段时间发展,现在注解有5个类分别是
@Excel
这个是必须使用的注解,如果需求简单只使用这一个注解也是可以的,涵盖了常用的Excel需求,需要大家熟悉这个功能,主要分为基础,图片处理,时间处理,合并处理几块,name_id是上面讲的id用法,这里就不累言了
属性 | 类型 | 默认值 | 功能 |
---|---|---|---|
name |
String |
null |
列名,支持name_id |
needMerge |
boolean |
fasle |
是否需要纵向合并单元格(用于含有list中,单个的单元格,合并list创建的多个row) |
orderNum |
String |
"0" |
列的排序,支持name_id |
replace |
String[] |
{} |
值得替换 导出是{a_id,b_id} 导入反过来 |
savePath |
String |
"upload" |
导入文件保存路径,如果是图片可以填写,默认是upload/className/ IconEntity这个类对应的就是upload/Icon/ |
type |
int |
1 |
导出类型 1 是文本 2 是图片,3 是函数,10 是数字 默认是文本 |
width |
double |
10 |
列宽 |
height |
double |
10 |
列高,后期打算统一使用@ExcelTarget的height,这个会被废弃,注意 |
isStatistics |
boolean |
fasle |
自动统计数据,在追加一行统计,把所有数据都和输出 这个处理会吞没异常,请注意这一点 |
isHyperlink |
boolean |
false |
超链接,如果是需要实现接口返回对象 |
isImportField |
boolean |
true |
校验字段,看看这个字段是不是导入的Excel中有,如果没有说明是错误的Excel,读取失败,支持name_id |
exportFormat |
String |
"" |
导出的时间格式,以这个是否为空来判断是否需要格式化日期 |
importFormat |
String |
"" |
导入的时间格式,以这个是否为空来判断是否需要格式化日期 |
format |
String |
"" |
时间格式,相当于同时设置了exportFormat 和 importFormat |
databaseFormat |
String |
"yyyyMMddHHmmss" |
导出时间设置,如果字段是Date类型则不需要设置 数据库如果是string 类型,这个需要设置这个数据库格式,用以转换时间格式输出 |
numFormat |
String |
"" |
数字格式化,参数是Pattern,使用的对象是DecimalFormat |
imageType |
int |
1 |
导出类型 1 从file读取 2 是从数据库中读取 默认是文件 同样导入也是一样的 |
suffix |
String |
"" |
文字后缀,如% 90 变成90% |
isWrap |
boolean |
true |
是否换行 即支持\n |
mergeRely |
int[] |
{} |
合并单元格依赖关系,比如第二列合并是基于第一列 则{0}就可以了 |
mergeVertical |
boolean |
fasle |
纵向合并内容相同的单元格 |
fixedIndex |
int |
-1 |
对应excel的列,忽略名字 |
isColumnHidden |
boolean |
false |
导出隐藏列 |
@ExcelTarget
限定一个到处实体的注解,以及一些通用设置,作用于最外面的实体
属性 | 类型 | 默认值 | 功能 |
---|---|---|---|
value |
String |
null |
定义ID |
height |
double |
10 |
设置行高 |
fontSize |
short |
11 |
设置文字大小 |
@ExcelEntity
标记是不是导出excel 标记为实体类,一遍是一个内部属性类,标记是否继续穿透,可以自定义内部id
属性 | 类型 | 默认值 | 功能 |
---|---|---|---|
id |
String |
null |
定义ID |
@ExcelCollection
一对多的集合注解,用以标记集合是否被数据以及集合的整体排序
属性 | 类型 | 默认值 | 功能 |
---|---|---|---|
id |
String |
null |
定义ID |
name |
String |
null |
定义集合列名,支持nanm_id |
orderNum |
int |
0 |
排序,支持name_id |
type |
Class> |
ArrayList.class |
导入时创建对象使用 |
@ExcelIgnore
忽略这个属性,多使用需循环引用中,无需多解释吧^^
接下来就是实战了:
首先是实体类:
接下来是工具类的编写:
package com.example.easypoi.util;
import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
/**
* @Auther: lijiawei
* @Date: 2018/7/23 12:08
* @Description: Excle 文件导入导出Util(easypoi)
*/
public class EasyPoiUtil {
/**
* 功能描述:复杂导出Excel,包括文件名以及表名。创建表头
*
* @author 李家威
* @date 2018/7/23 13:07
* @param list 导出的实体类
* @param title 表头名称
* @param sheetName sheet表名
* @param pojoClass 映射的实体类
* @param isCreateHeader 是否创建表头
* @param fileName
* @param response
* @return
*/
public static void exportExcel(List> list, String title, String sheetName, Class> pojoClass, String fileName, boolean isCreateHeader, HttpServletResponse response) {
ExportParams exportParams = new ExportParams(title, sheetName);
exportParams.setCreateHeadRows(isCreateHeader);
defaultExport(list, pojoClass, fileName, response, exportParams);
}
/**
* 功能描述:复杂导出Excel,包括文件名以及表名,不创建表头
*
* @author 李家威
* @date 2018/7/23 13:07
* @param list 导出的实体类
* @param title 表头名称
* @param sheetName sheet表名
* @param pojoClass 映射的实体类
* @param fileName
* @param response
* @return
*/
public static void exportExcel(List> list, String title, String sheetName, Class> pojoClass, String fileName, HttpServletResponse response) {
defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
}
/**
* 功能描述:Map 集合导出
*
* @author 李家威
* @date 2018/7/23 16:14
* @param list 实体集合
* @param fileName 导出的文件名称
* @param response
* @return
*/
public static void exportExcel(List
下面是测试类以及结果:
就此,easypoi 的工作就完成了 是不是很简单
更多教程可以参考官方APIhttp://easypoi.mydoc.io/#text_202979