史上最全的Excel导入导出（easyexcel版）

川长思鸟来 2022-09-17 03:07 381阅读 0赞

![845dd7763670fac3f66ab2aa290fcd19.png][]

*来源：blog.csdn.net/qq\_32258777/article/details/89031479*

喝水不忘挖井人，感谢阿里巴巴项目组提供了easyexcel工具类，github地址：

> https://github.com/alibaba/easyexcel

## 文章目录 ##

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

## 环境搭建 ##

*  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的数据

![4158c6e7a1901141491750f41183f2b5.png][] ![4c0a2705badae277dfa9647a5fc44bc3.png][]

获取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);

结果

![b9624dce119669abb140f6b51fa21290.png][]

##### 模型映射导出 #####

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、定义好模型对象

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;
        }
    
        /*******************匿名内部类，实际开发中该对象要提取出去**********************/
    
    }

####  ####

**往期推荐**

[**程序员写过的最大Bug：亏损30亿、致6人亡，甚至差点毁灭世界**][Bug_30_6]

[**国产Linux发行版再添一员，操作界面不输苹果！**][Linux]

[**0.2秒居然复制了100G文件？**][0.2_100G]

[**一打卡作弊软件CEO被判5年6个月，网友：这也太...**][CEO_5_6_...]

[**这才是中国被卡脖子最严重的软件！**][Link 1]

[**被问 Linux 命令 su 和 sudo 的区别？当场蒙了！**][Linux _ su _ sudo]

[**为什么 JSP 还没有被淘汰？**][JSP]

![3b139aa24565bf483b181267c938cca2.png][]

[845dd7763670fac3f66ab2aa290fcd19.png]: /images/20220828/cd326b30ce4e4240a3111ba053575b32.png
[4158c6e7a1901141491750f41183f2b5.png]: https://img-blog.csdnimg.cn/img_convert/4158c6e7a1901141491750f41183f2b5.png
[4c0a2705badae277dfa9647a5fc44bc3.png]: /images/20220828/c506a4de87814cd3a5ab0417f254746d.png
[b9624dce119669abb140f6b51fa21290.png]: /images/20220828/e979e1c5b70e4e819fc9413ad33d6b66.png
[Bug_30_6]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498492&idx=1&sn=c3c9d985960f1dda5b890ad66eaf9d0a&chksm=fd346890ca43e186942bf1035c472f8e2aa41701f677dfa9008c520c813a4304c374d9de5d72&scene=21#wechat_redirect
[Linux]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498511&idx=1&sn=c6a250af3b7b702d0be9a4ef83e27ae8&chksm=fd346963ca43e07531f8c3f2f53f238ab93bd63d8ddbf6b3472058cde3032aee0983ca394793&scene=21#wechat_redirect
[0.2_100G]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498530&idx=1&sn=9d07fa4860f00b89c104344805be75dc&chksm=fd34694eca43e05813061ada5e431a33a4c1e4cd422c5e3fadb64b21651a1df6a9ed9c28584b&scene=21#wechat_redirect
[CEO_5_6_...]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498553&idx=1&sn=193a890612eb754fb1a3ea481d8d181c&chksm=fd346955ca43e0439336dcaff7afacb89ac1246ccee535c7c491ee2fae2dbc350d09af39ab6c&scene=21#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498565&idx=1&sn=be8de66fabac12dd23ea757872b92a01&chksm=fd346929ca43e03f40a4e47b55daff919d8d10fbefcd5cf0ed8cb53ef7138a2bab38fb9c9a40&scene=21#wechat_redirect
[Linux _ su _ sudo]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498578&idx=1&sn=dff18b4d532392514d71f0a486b22377&chksm=fd34693eca43e028be3ef319375c4b6aa6c976cb806d5c50899a69121f2251ed0b364ca6efe3&scene=21#wechat_redirect
[JSP]: http://mp.weixin.qq.com/s?__biz=MzU3NDE0NjMwNw==&mid=2247498593&idx=1&sn=a25f0606c5d5fc2e18467b8b776407a6&chksm=fd34690dca43e01b9ba49e65317743cff920f900147234fa8974efb93441a90f6b1746d1e066&scene=21#wechat_redirect
[3b139aa24565bf483b181267c938cca2.png]: /images/20220828/6087963a24b64824ab8a5345d961b013.png