springboot + easypoi 一行代码搞定excel导入导出

  • A+
所属分类：java

我们不造轮子，只是轮子的搬运工。（其实最好是造轮子，造比别人好的轮子）

开发中经常会遇到的excel的处理，导入导出解析等等，JAVA中比较流行的用POI，但是每次都要写大段工具类来搞定这事儿，此处推荐一个别人造好的轮子【 easypoi】，下面介绍下“轮子”的使用。

POM引入

不再需要其他的jar

  1. <dependency>
  2.            <groupId>cn.afterturn</groupId>
  3.            <artifactId>easypoi-base</artifactId>
  4.            <version>3.0.3</version>
  5.        </dependency>
  6.        <dependency>
  7.            <groupId>cn.afterturn</groupId>
  8.            <artifactId>easypoi-web</artifactId>
  9.            <version>3.0.3</version>
  10.        </dependency>
  11.        <dependency>
  12.            <groupId>cn.afterturn</groupId>
  13.            <artifactId>easypoi-annotation</artifactId>
  14.            <version>3.0.3</version>
  15.        </dependency>

编写实体类

此处注意必须要有空构造函数，否则会报错“对象创建错误”
关于注解@ Excel，其他还有@ ExcelCollection，@ ExcelEntity，@ ExcelIgnore，@ ExcelTarget等，此处我们用不到，可以去官方查看更多

属性 类型 类型 说明
名称 串 空值 列名
needMerge 布尔 FASLE 纵向合并单元格
ORDERNUM 串 “0” 列的排序，支持名_ID
更换 串[] {} 值得替换导出是{a_id，b_id}导入反过来
savePath 串 “上传” 导入文件保存路径
类型 INT 1 导出类型1是文本2是图片，3是函数，10是数字默认是文本
宽度 双 10 列宽
高度 双 10 列高，后期打算统一使用@ExcelTarget的高度，这个会被废弃，注意
isStatistics 布尔 FASLE 自动统计数据，在追加一行统计，把所有数据都和输出这个处理会吞没异常，请注意这一点
isHyperlink 布尔 假 超链接，如果是需要实现接口返回对象
isImportField 布尔 真正 校验字段，看看这个字段是不是导入的Excel中中有，如果没有说明是错误的Excel中，读取失败，支持名_ID
exportFormat 串 “” 导出的时间格式，以这个是否为空来判断是否需要格式化日期
importFormat 串 “” 导入的时间格式，以这个是否为空来判断是否需要格式化日期
格式 串 “” 时间格式，相当于同时设置了exportFormat和importFormat
databaseFormat 串 “YYYYMMDDHHMMSS” 导出时间设置，如果字段是日期类型则不需要设置数据库如果是string类型，这个需要设置这个数据库格式，用以转换时间格式输出
numFormat 串 “” 数字格式化，参数是模式，使用的对象是DecimalFormat的
图像类型 INT 1 导出类型1从文件读取2是从数据库中读取默认是文件同样导入也是一样的
后缀 串 “” 文字后缀，如％90变成90％
isWrap 布尔 真正 是否换行即支持\ n
mergeRely INT [] {} 合并单元格依赖关系，比如第二列合并是基于第一列则{1}就可以了
mergeVertical 布尔 FASLE 纵向合并内容相同的单元格

实体类

  1. import cn.afterturn.easypoi.excel.annotation.Excel;
  3. import java.util.Date;
  5. public class Person {
  7.     @Excel(name = "姓名", orderNum = "0")
  8.     private String name;
  10.     @Excel(name = "性别", replace = {"男_1", "女_2"}, orderNum = "1")
  11.     private String sex;
  13.     @Excel(name = "生日", exportFormat = "yyyy-MM-dd", orderNum = "2")
  14.     private Date birthday;
  16.     public Person(String name, String sex, Date birthday) {
  17.         this.name = name;
  18.         this.sex = sex;
  19.         this.birthday = birthday;
  20.     }
  22.     public String getName() {
  23.         return name;
  24.     }
  26.     public void setName(String name) {
  27.         this.name = name;
  28.     }
  30.     public String getSex() {
  31.         return sex;
  32.     }
  34.     public void setSex(String sex) {
  35.         this.sex = sex;
  36.     }
  38.     public Date getBirthday() {
  39.         return birthday;
  40.     }
  42.     public void setBirthday(Date birthday) {
  43.         this.birthday = birthday;
  44.     }
  45. }

导入导出公用方法

  1. public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName,boolean isCreateHeader, HttpServletResponse response){
  2.         ExportParams exportParams = new ExportParams(title, sheetName);
  3.         exportParams.setCreateHeadRows(isCreateHeader);
  4.         defaultExport(list, pojoClass, fileName, response, exportParams);
  6.     }
  7.     public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName, HttpServletResponse response){
  8.         defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
  9.     }
  10. public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response){
  11.         defaultExport(list, fileName, response);
  12.     }
  14.     private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {
  15.         Workbook workbook = ExcelExportUtil.exportExcel(exportParams,pojoClass,list);
  16.         if (workbook != null);
  17.         downLoadExcel(fileName, response, workbook);
  18.     }
  20.     private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
  21.         try {
  22.             response.setCharacterEncoding("UTF-8");
  23.             response.setHeader("content-Type", "application/vnd.ms-excel");
  24.             response.setHeader("Content-Disposition",
  25.                     "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
  26.             workbook.write(response.getOutputStream());
  27.         } catch (IOException e) {
  28.             throw new NormalException(e.getMessage());
  29.         }
  30.     }
  31. private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
  32.         Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
  33.         if (workbook != null);
  34.         downLoadExcel(fileName, response, workbook);
  35.     }
  37.     public static <T> List<T> importExcel(String filePath,Integer titleRows,Integer headerRows, Class<T> pojoClass){
  38.         if (StringUtils.isBlank(filePath)){
  39.             return null;
  40.         }
  41.         ImportParams params = new ImportParams();
  42.         params.setTitleRows(titleRows);
  43.         params.setHeadRows(headerRows);
  44.         List<T> list = null;
  45.         try {
  46.             list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
  47.         }catch (NoSuchElementException e){
  48.             throw new NormalException("模板不能为空");
  49.         } catch (Exception e) {
  50.             e.printStackTrace();
  51.             throw new NormalException(e.getMessage());
  52.         }
  53.         return list;
  54.     }
  55.     public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass){
  56.         if (file == null){
  57.             return null;
  58.         }
  59.         ImportParams params = new ImportParams();
  60.         params.setTitleRows(titleRows);
  61.         params.setHeadRows(headerRows);
  62.         List<T> list = null;
  63.         try {
  64.             list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
  65.         }catch (NoSuchElementException e){
  66.             throw new NormalException("excel文件不能为空");
  67.         } catch (Exception e) {
  68.             throw new NormalException(e.getMessage());
  69.         }
  70.         return list;
  71.     }

对的，没看错，这就可以导出导入了，看起来代码挺多，其实是提供了多个导入导出方法而已

测试

  1. @RequestMapping("export")
  2.     public void export(HttpServletResponse response){
  4.         //模拟从数据库获取需要导出的数据
  5.         List<Person> personList = new ArrayList<>();
  6.         Person person1 = new Person("路飞","1",new Date());
  7.         Person person2 = new Person("娜美","2", DateUtils.addDate(new Date(),3));
  8.         Person person3 = new Person("索隆","1", DateUtils.addDate(new Date(),10));
  9.         Person person4 = new Person("小狸猫","1", DateUtils.addDate(new Date(),-10));
  10.         personList.add(person1);
  11.         personList.add(person2);
  12.         personList.add(person3);
  13.         personList.add(person4);
  15.         //导出操作
  16.         FileUtil.exportExcel(personList,"花名册","草帽一伙",Person.class,"海贼王.xls",response);
  17.     }
  19.     @RequestMapping("importExcel")
  20.     public void importExcel(){
  21.         String filePath = "F:\\海贼王.xls";
  22.         //解析excel，
  23.         List<Person> personList = FileUtil.importExcel(filePath,1,1,Person.class);
  24.         //也可以使用MultipartFile,使用 FileUtil.importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass)导入
  25.         System.out.println("导入数据一共【"+personList.size()+"】行");
  27.         //TODO 保存数据库
  28.     }

导出结果

springboot + easypoi 一行代码搞定excel导入导出
导出结果

测试导入

导出结果再添加一行，执行，输出导入数据行数

springboot + easypoi 一行代码搞定excel导入导出
导入结果

 

 

avatar

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: