关于java:史上最全的Excel导入导出easyexcel版

38次阅读

共计 16791 个字符，预计需要花费 42 分钟才能阅读完成。

文章目录

  • 环境搭建
  • 读取 excel 文件
  • 默认读取
  • 指定读取
  • 默认读取
  • 指定读取
  • 小于 1000 行数据
  • 大于 1000 行数据
  • 导出 excle
  • 无模型映射导出
  • 模型映射导出
  • 单个 Sheet 导出
  • 多个 Sheet 导出
  • 工具类
  • 测试类 
  

** 注 意 **  

 ** 文末有：7701 页互联网大厂面试题 **

环境搭建

  • easyexcel 依赖（必须）
  • springboot (不是必须)
  • lombok（不是必须）
 <dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>easyexcel</artifactId>
   <version>1.1.2-beat1</version>
 </dependency>
  
 <dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.2</version>
 </dependency>

读取 excel 文件

小于 1000 行数据

默认读取

读取 Sheet1 的全副数据 

 String filePath = "/home/chenmingjian/Downloads/ 学生表.xlsx";
 List<Object> objects = ExcelUtil.readLessThan1000Row(filePath);
指定读取

上面是学生表.xlsx 中 Sheet1，Sheet2 的数据

获取 Sheet1 表头以下的信息 

String filePath = "/home/chenmingjian/Downloads/ 学生表.xlsx";
// 第一个 1 代表 sheet1, 第二个 1 代表从第几行开始读取数据，行号最小值为 0
Sheet sheet = new Sheet(1, 1);
List<Object> objects = ExcelUtil.readLessThan1000Row(filePath,sheet);

获取 Sheet2 的所有信息 

 String filePath = "/home/chenmingjian/Downloads/ 学生表.xlsx";
 Sheet sheet = new Sheet(2, 0);
 List<Object> objects = ExcelUtil.readLessThan1000Row(filePath,sheet);

大于 1000 行数据

默认读取 
String filePath = "/home/chenmingjian/Downloads/ 学生表.xlsx";
List<Object> objects = ExcelUtil.readMoreThan1000Row(filePath);
指定读取 
String filePath = "/home/chenmingjian/Downloads/ 学生表.xlsx";
Sheet sheet = new Sheet(1, 2);
List<Object> objects = ExcelUtil.readMoreThan1000Row(filePath，sheet);

导出 excle

单个 Sheet 导出

无模型映射导出 
String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
List<List<Object>> data = new ArrayList<>();
data.add(Arrays.asList("111","222","333"));
data.add(Arrays.asList("111","222","333"));
data.add(Arrays.asList("111","222","333"));
List<String> head = Arrays.asList("表头 1", "表头 2", "表头 3");
ExcelUtil.writeBySimple(filePath,data,head);

后果

模型映射导出

1、定义好模型对象 

package com.springboot.utils.excel.test;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.metadata.BaseRowModel;
import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * @description:
 * @author: chenmingjian
 * @date: 19-4-3 14:44
 */
@EqualsAndHashCode(callSuper = true)
@Data
public class TableHeaderExcelProperty extends BaseRowModel {

    /**
     * value: 表头名称
     * index: 列的号, 0 示意第一列
     */
    @ExcelProperty(value = "姓名", index = 0)
    private String name;

    @ExcelProperty(value = "年龄",index = 1)
    private int age;

    @ExcelProperty(value = "学校",index = 2)
    private String school;
}

2、调用办法 

String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
ArrayList<TableHeaderExcelProperty> data = new ArrayList<>();
  for(int i = 0; i < 4; i++){TableHeaderExcelProperty tableHeaderExcelProperty = new TableHeaderExcelProperty();
      tableHeaderExcelProperty.setName("cmj" + i);
      tableHeaderExcelProperty.setAge(22 + i);
      tableHeaderExcelProperty.setSchool("清华大学" + i);
      data.add(tableHeaderExcelProperty);
  }

  ExcelUtil.writeWithTemplate(filePath,data);

多个 Sheet 导出

1、定义好模型对象 

package com.springboot.utils.excel.test;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.metadata.BaseRowModel;
import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * @description:
 * @author: chenmingjian
 * @date: 19-4-3 14:44
 */
@EqualsAndHashCode(callSuper = true)
@Data
public class TableHeaderExcelProperty extends BaseRowModel {

    /**
     * value: 表头名称
     * index: 列的号, 0 示意第一列
     */
    @ExcelProperty(value = "姓名", index = 0)
    private String name;

    @ExcelProperty(value = "年龄",index = 1)
    private int age;

    @ExcelProperty(value = "学校",index = 2)
    private String school;
}

2、调用办法 

 ArrayList<ExcelUtil.MultipleSheelPropety> list1 = new ArrayList<>();
 for(int j = 1; j < 4; j++){ArrayList<TableHeaderExcelProperty> list = new ArrayList<>();
      for(int i = 0; i < 4; i++){TableHeaderExcelProperty tableHeaderExcelProperty = new TableHeaderExcelProperty();
          tableHeaderExcelProperty.setName("cmj" + i);
          tableHeaderExcelProperty.setAge(22 + i);
          tableHeaderExcelProperty.setSchool("清华大学" + i);
          list.add(tableHeaderExcelProperty);
      }

      Sheet sheet = new Sheet(j, 0);
      sheet.setSheetName("sheet" + j);

      ExcelUtil.MultipleSheelPropety multipleSheelPropety = new ExcelUtil.MultipleSheelPropety();
      multipleSheelPropety.setData(list);
      multipleSheelPropety.setSheet(sheet);

      list1.add(multipleSheelPropety);

  }

  ExcelUtil.writeWithMultipleSheel("/home/chenmingjian/Downloads/aaa.xlsx",list1);

工具类 

package com.springboot.utils.excel;

import com.alibaba.excel.EasyExcelFactory;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;

import java.io.*;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * @description:
 * @author: chenmingjian
 * @date: 19-3-18 16:16
 */
@Slf4j
public class ExcelUtil {

   private static Sheet initSheet;

   static {initSheet = new Sheet(1, 0);
      initSheet.setSheetName("sheet");
      // 设置自适应宽度
      initSheet.setAutoWidth(Boolean.TRUE);
   }

   /**
    * 读取少于 1000 行数据
    * @param filePath 文件绝对路径
    * @return
    */
   public static List<Object> readLessThan1000Row(String filePath){return readLessThan1000RowBySheet(filePath,null);
   }

   /**
    * 读小于 1000 行数据, 带款式
    * filePath 文件绝对路径
    * initSheet：*      sheetNo: sheet 页码，默认为 1
    *      headLineMun: 从第几行开始读取数据，默认为 0, 示意从第一行开始读取
    *      clazz: 返回数据 List<Object> 中 Object 的类名
    */
   public static List<Object> readLessThan1000RowBySheet(String filePath, Sheet sheet){if(!StringUtils.hasText(filePath)){return null;}

      sheet = sheet != null ? sheet : initSheet;

      InputStream fileStream = null;
      try {fileStream = new FileInputStream(filePath);
         return EasyExcelFactory.read(fileStream, sheet);
      } catch (FileNotFoundException e) {log.info("找不到文件或文件门路谬误, 文件：{}", filePath);
      }finally {
         try {if(fileStream != null){fileStream.close();
            }
         } catch (IOException e) {log.info("excel 文件读取失败, 失败起因：{}", e);
         }
      }
      return null;
   }

   /**
    * 读大于 1000 行数据
    * @param filePath 文件感觉门路
    * @return
    */
   public static List<Object> readMoreThan1000Row(String filePath){return readMoreThan1000RowBySheet(filePath,null);
   }

   /**
    * 读大于 1000 行数据, 带款式
    * @param filePath 文件感觉门路
    * @return
    */
   public static List<Object> readMoreThan1000RowBySheet(String filePath, Sheet sheet){if(!StringUtils.hasText(filePath)){return null;}

      sheet = sheet != null ? sheet : initSheet;

      InputStream fileStream = null;
      try {fileStream = new FileInputStream(filePath);
         ExcelListener excelListener = new ExcelListener();
         EasyExcelFactory.readBySax(fileStream, sheet, excelListener);
         return excelListener.getDatas();} catch (FileNotFoundException e) {log.error("找不到文件或文件门路谬误, 文件：{}", filePath);
      }finally {
         try {if(fileStream != null){fileStream.close();
            }
         } catch (IOException e) {log.error("excel 文件读取失败, 失败起因：{}", e);
         }
      }
      return null;
   }

   /**
    * 生成 excle
    * @param filePath  绝对路径, 如：/home/chenmingjian/Downloads/aaa.xlsx
    * @param data 数据源
    * @param head 表头
    */
   public static void writeBySimple(String filePath, List<List<Object>> data, List<String> head){writeSimpleBySheet(filePath,data,head,null);
   }

   /**
    * 生成 excle
    * @param filePath 绝对路径, 如：/home/chenmingjian/Downloads/aaa.xlsx
    * @param data 数据源
    * @param sheet excle 页面款式
    * @param head 表头
    */
   public static void writeSimpleBySheet(String filePath, List<List<Object>> data, List<String> head, Sheet sheet){sheet = (sheet != null) ? sheet : initSheet;

      if(head != null){List<List<String>> list = new ArrayList<>();
         head.forEach(h -> list.add(Collections.singletonList(h)));
         sheet.setHead(list);
      }

      OutputStream outputStream = null;
      ExcelWriter writer = null;
      try {outputStream = new FileOutputStream(filePath);
         writer = EasyExcelFactory.getWriter(outputStream);
         writer.write1(data,sheet);
      } catch (FileNotFoundException e) {log.error("找不到文件或文件门路谬误, 文件：{}", filePath);
      }finally {
         try {if(writer != null){writer.finish();
            }

            if(outputStream != null){outputStream.close();
            }

         } catch (IOException e) {log.error("excel 文件导出失败, 失败起因：{}", e);
         }
      }

   }

   /**
    * 生成 excle
    * @param filePath 绝对路径, 如：/home/chenmingjian/Downloads/aaa.xlsx
    * @param data 数据源
    */
   public static void writeWithTemplate(String filePath, List<? extends BaseRowModel> data){writeWithTemplateAndSheet(filePath,data,null);
   }

   /**
    * 生成 excle
    * @param filePath 绝对路径, 如：/home/chenmingjian/Downloads/aaa.xlsx
    * @param data 数据源
    * @param sheet excle 页面款式
    */
   public static void writeWithTemplateAndSheet(String filePath, List<? extends BaseRowModel> data, Sheet sheet){if(CollectionUtils.isEmpty(data)){return;}

      sheet = (sheet != null) ? sheet : initSheet;
      sheet.setClazz(data.get(0).getClass());

      OutputStream outputStream = null;
      ExcelWriter writer = null;
      try {outputStream = new FileOutputStream(filePath);
         writer = EasyExcelFactory.getWriter(outputStream);
         writer.write(data,sheet);
      } catch (FileNotFoundException e) {log.error("找不到文件或文件门路谬误, 文件：{}", filePath);
      }finally {
         try {if(writer != null){writer.finish();
            }

            if(outputStream != null){outputStream.close();
            }
         } catch (IOException e) {log.error("excel 文件导出失败, 失败起因：{}", e);
         }
      }

   }

   /**
    * 生成多 Sheet 的 excle
    * @param filePath 绝对路径, 如：/home/chenmingjian/Downloads/aaa.xlsx
    * @param multipleSheelPropetys
    */
   public static void writeWithMultipleSheel(String filePath,List<MultipleSheelPropety> multipleSheelPropetys){if(CollectionUtils.isEmpty(multipleSheelPropetys)){return;}

      OutputStream outputStream = null;
      ExcelWriter writer = null;
      try {outputStream = new FileOutputStream(filePath);
         writer = EasyExcelFactory.getWriter(outputStream);
         for (MultipleSheelPropety multipleSheelPropety : multipleSheelPropetys) {Sheet sheet = multipleSheelPropety.getSheet() != null ? multipleSheelPropety.getSheet() : initSheet;
            if(!CollectionUtils.isEmpty(multipleSheelPropety.getData())){sheet.setClazz(multipleSheelPropety.getData().get(0).getClass());
            }
            writer.write(multipleSheelPropety.getData(), sheet);
         }

      } catch (FileNotFoundException e) {log.error("找不到文件或文件门路谬误, 文件：{}", filePath);
      }finally {
         try {if(writer != null){writer.finish();
            }

            if(outputStream != null){outputStream.close();
            }
         } catch (IOException e) {log.error("excel 文件导出失败, 失败起因：{}", e);
         }
      }

   }


   /********************* 匿名外部类开始，能够提取进来 ******************************/

   @Data
   public static class MultipleSheelPropety{

      private List<? extends BaseRowModel> data;

      private Sheet sheet;
   }

   /**
    * 解析监听器，* 每解析一行会回调 invoke() 办法。* 整个 excel 解析完结会执行 doAfterAllAnalysed() 办法
    *
    * @author: chenmingjian
    * @date: 19-4-3 14:11
    */
   @Getter
   @Setter
   public static class ExcelListener extends AnalysisEventListener {private List<Object> datas = new ArrayList<>();

      /**
       * 逐行解析
       * object : 以后行的数据
       */
      @Override
      public void invoke(Object object, AnalysisContext context) {
         // 以后行
         // context.getCurrentRowNum()
         if (object != null) {datas.add(object);
         }
      }


      /**
       * 解析完所有数据后会调用该办法
       */
      @Override
      public void doAfterAllAnalysed(AnalysisContext context) {// 解析完结销毁不必的资源}

   }

   /************************ 匿名外部类完结，能够提取进来 ***************************/

}

测试类 

package com.springboot.utils.excel;

import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * @description: 测试类
 * @author: chenmingjian
 * @date: 19-4-4 15:24
 */
@SpringBootTest
@RunWith(SpringRunner.class)
public class Test {

    /**
     * 读取少于 1000 行的 excle
     */
    @org.junit.Test
    public void readLessThan1000Row(){
        String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
        List<Object> objects = ExcelUtil.readLessThan1000Row(filePath);
        objects.forEach(System.out::println);
    }

    /**
     * 读取少于 1000 行的 excle，能够指定 sheet 和从几行读起
     */
    @org.junit.Test
    public void readLessThan1000RowBySheet(){
        String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
        Sheet sheet = new Sheet(1, 1);
        List<Object> objects = ExcelUtil.readLessThan1000RowBySheet(filePath,sheet);
        objects.forEach(System.out::println);
    }

    /**
     * 读取大于 1000 行的 excle
     * 带 sheet 参数的办法可参照测试方法 readLessThan1000RowBySheet()
     */
    @org.junit.Test
    public void readMoreThan1000Row(){
        String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
        List<Object> objects = ExcelUtil.readMoreThan1000Row(filePath);
        objects.forEach(System.out::println);
    }


    /**
     * 生成 excle
     * 带 sheet 参数的办法可参照测试方法 readLessThan1000RowBySheet()
     */
    @org.junit.Test
    public void writeBySimple(){
        String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
        List<List<Object>> data = new ArrayList<>();
        data.add(Arrays.asList("111","222","333"));
        data.add(Arrays.asList("111","222","333"));
        data.add(Arrays.asList("111","222","333"));
        List<String> head = Arrays.asList("表头 1", "表头 2", "表头 3");
        ExcelUtil.writeBySimple(filePath,data,head);
    }


    /**
     * 生成 excle, 带用模型
     * 带 sheet 参数的办法可参照测试方法 readLessThan1000RowBySheet()
     */
    @org.junit.Test
    public void writeWithTemplate(){
        String filePath = "/home/chenmingjian/Downloads/ 测试.xlsx";
        ArrayList<TableHeaderExcelProperty> data = new ArrayList<>();
        for(int i = 0; i < 4; i++){TableHeaderExcelProperty tableHeaderExcelProperty = new TableHeaderExcelProperty();
            tableHeaderExcelProperty.setName("cmj" + i);
            tableHeaderExcelProperty.setAge(22 + i);
            tableHeaderExcelProperty.setSchool("清华大学" + i);
            data.add(tableHeaderExcelProperty);
        }
        ExcelUtil.writeWithTemplate(filePath,data);
    }


    /**
     * 生成 excle, 带用模型, 带多个 sheet
     */
    @org.junit.Test
    public void writeWithMultipleSheel(){ArrayList<ExcelUtil.MultipleSheelPropety> list1 = new ArrayList<>();
        for(int j = 1; j < 4; j++){ArrayList<TableHeaderExcelProperty> list = new ArrayList<>();
            for(int i = 0; i < 4; i++){TableHeaderExcelProperty tableHeaderExcelProperty = new TableHeaderExcelProperty();
                tableHeaderExcelProperty.setName("cmj" + i);
                tableHeaderExcelProperty.setAge(22 + i);
                tableHeaderExcelProperty.setSchool("清华大学" + i);
                list.add(tableHeaderExcelProperty);
            }

            Sheet sheet = new Sheet(j, 0);
            sheet.setSheetName("sheet" + j);

            ExcelUtil.MultipleSheelPropety multipleSheelPropety = new ExcelUtil.MultipleSheelPropety();
            multipleSheelPropety.setData(list);
            multipleSheelPropety.setSheet(sheet);

            list1.add(multipleSheelPropety);

        }

        ExcelUtil.writeWithMultipleSheel("/home/chenmingjian/Downloads/aaa.xlsx",list1);

    }


    /******************* 匿名外部类，理论开发中该对象要提取进来 **********************/
    
    
    /**
     * @description:
     * @author: chenmingjian
     * @date: 19-4-3 14:44
     */
    @EqualsAndHashCode(callSuper = true)
    @Data
    public static class TableHeaderExcelProperty extends BaseRowModel {

        /**
         * value: 表头名称
         * index: 列的号, 0 示意第一列
         */
        @ExcelProperty(value = "姓名", index = 0)
        private String name;

        @ExcelProperty(value = "年龄",index = 1)
        private int age;

        @ExcelProperty(value = "学校",index = 2)
        private String school;
    }

    /******************* 匿名外部类，理论开发中该对象要提取进来 **********************/

}

正文完
java
发表至： java
2021-10-27
 0
关于java:springMVCjwtShiro
关于java:设计模式-4分钟搞懂10种设计模式
关于java:工作三年小胖连-Thread-源码都没看过真的菜
android中小图片icon的优化（svg矢量图与iconfiy的使用）