- 简介
easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员 就可以方便的写出Excel导出,Excel模板导出,Excel导入,Word模板导出,通过简单的注解和模板。
官网:
https://opensource.afterturn.cn/doc/easypoi.html - maven坐标
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-annotation</artifactId>
<version>4.0.0</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-base</artifactId>
<version>4.0.0</version>
</dependency>
- 最简单的导入
完成最简单的导入,只需要两步:一使用注解配置实体类,二调用工具类
实体类(省略get/set方法):
public class API implements Serializable {
@Excel(name = "接口名称")
private String name;
@Excel(name = "接口编号")
private String id;
@Excel(name = "接口提交方式")
private String type;
@Excel(name = "接口地址")
private String url;
@Excel(name = "参数类型")
private String contentType;
}
@Excel(name = “接口名称”)这个注解是啥意思呢?name属性表示excel表头。如图:
当我们导入excel时,就会按照@Excel注解的映射关系封装API实体类。
工具类:
FileInputStream fis = new FileInputStream(EXCEL_PATH);
//导入参数设置类
ImportParams params = new ImportParams();
List<API> importExcel = ExcelImportUtil.importExcel(fis, API.class, params);
总共三行代码,第一行加载excel文件,第二行设置导入参数,第三行根据导入参数返回对应结果并封装成List集合。
这三个代码中主要讲解第二行和第三行,第二行是导入参数设置,它能给我们提供什么设置呢?参考下表:
对照完这张表之后,你会发现即使我们不对ImportParams做任何设置,也会有对应的默认值。
那么第二句代码就能翻译成:读取第一个Sheet且只读取第一个,表头是Sheet的第一行且只有一行。
最终我们就能得到第一个Sheet中每一行数据,并且每一行被封装成了API对象也就是一个List。
有了这个集合之后我们需要导入的数据就能任由我们如何处理了,是不是很简单。
- 最简单的导出
List<API> list = new ArrayList<API>();
ExportParams exportParams = new ExportParams();
Workbook workbook = ExcelExportUtil.exportExcel(exportParams, API.class, list);
workbook.write(new FileOutputStream(EXCEL_PATH));
导出也只有四句代码。
第一句是需要导出的数据集合,第二句导出参数,第三句获取导出workbook对象,第四句通过输出流导出数据到excel中。
其中第二句也是有很多设置的,我们就用默认设置也能是导出的。第三句也要用到API实体类中的注解映射关系。