EasyExcel工具类导入导出文件方法以及例子（从1.x版本到2.x版本升级）

忙着偷闲小王子

于 2024-06-07 11:37:40 发布

阅读量296

点赞数 5

文章标签： java excel 后端 spring boot

本文链接：https://blog.csdn.net/m0_51021692/article/details/139522418

版权

背景：最近公司excel表格的下载出现了时好时坏的情况（这种情况据同事说以前也有，没找到问题），于是准备换一种实现方式的工具类。我看了下项目目前用的是阿里的EasyExcel，已经算是优秀的Excel文件的导入导出库了，于是盯上了版本，发现目前用的是1.1.2-beta5版，比较老的版本，而且还是beta测试版，遂决定更新版本，目前最新版本为3.x，但一下升级两个版本，跨度太大，最终决定升级为2.x版本，此文便记录工具类的新老版本，各位客官可以参考一下。（ps：这个时好时坏也不一定是版本的问题，但没找到别的原因，试一试）

一、pom依赖

原版本

<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>easyexcel</artifactId>
  <version>1.1.2-beta5</version>
</dependency>

新版本

<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>easyexcel</artifactId>
  <version>2.2.10</version>
</dependency>

二、老版本工具类

老版本EasyExcel工具类：

package com.zzjdyf.tools.easyexcel;

import com.alibaba.excel.ExcelReader;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import com.alibaba.excel.support.ExcelTypeEnum;
import com.alibaba.fastjson.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.List;

/**
 * @Description 工具类
 */
public class ExcelUtil {

    private static final Logger log = LoggerFactory.getLogger(ExcelUtil.class);

    /**
     * 读取 Excel(多个 sheet)
     *
     * @param excel    文件
     * @param rowModel 实体类映射，继承 BaseRowModel 类
     * @return Excel 数据 list
     */
    public static List<Object> readExcel(MultipartFile excel, BaseRowModel rowModel) {
        ExcelListener excelListener = new ExcelListener();
        ExcelReader reader = getReader(excel, excelListener);
        if (reader == null) {
            return null;
        }
        for (Sheet sheet : reader.getSheets()) {
            if (rowModel != null) {
                sheet.setClazz(rowModel.getClass());
            }
            reader.read(sheet);
        }
        return excelListener.getDatas();
    }

    /**
     * 读取某个 sheet 的 Excel
     *
     * @param excel    文件
     * @param rowModel 实体类映射，继承 BaseRowModel 类
     * @param sheetNo  sheet 的序号 从1开始
     * @return Excel 数据 list
     */
    public static List<Object> readExcel(MultipartFile excel, BaseRowModel rowModel, int sheetNo) {
        return readExcel(excel, rowModel, sheetNo, 1);
    }

    /**
     * 读取某个 sheet 的 Excel
     *
     * @param excel       文件
     * @param rowModel    实体类映射，继承 BaseRowModel 类
     * @param sheetNo     sheet 的序号 从1开始
     * @param headLineNum 表头行数，默认为1
     * @return Excel 数据 list
     */
    public static List<Object> readExcel(MultipartFile excel, BaseRowModel rowModel, int sheetNo,
                                         int headLineNum) {
        ExcelListener excelListener = new ExcelListener();
        ExcelReader reader = getReader(excel, excelListener);
        if (reader == null) {
            return null;
        }
        reader.read(new Sheet(sheetNo, headLineNum, rowModel.getClass()));
        return excelListener.getDatas();
    }

    /**
     * 导出 Excel ：一个 sheet，带表头
     *
     * @param response  HttpServletResponse
     * @param list      数据 list，每个元素为一个 BaseRowModel
     * @param fileName  导出的文件名
     * @param sheetName 导入文件的 sheet 名
     * @param object    映射实体类，Excel 模型
     */
    public static void writeExcel(HttpServletResponse response, List<? extends BaseRowModel> list,
                                  String fileName, String sheetName, BaseRowModel object) {
        try {
            ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX);
            Sheet sheet = new Sheet(1, 0, object.getClass());
          sheet.setSheetName(sheetName);
          writer.write(list, sheet);
          writer.finish();
       } catch (Exception e) {
          log.error("excel输出异常\n" + JSONObject.toJSON(list));
       }
    }

    /**
     * 导出 Excel ：多个 sheet，带表头
     *
     * @param response  HttpServletResponse
     * @param list      数据 list，每个元素为一个 BaseRowModel
     * @param fileName  导出的文件名
     * @param sheetName 导入文件的 sheet 名
     * @param object    映射实体类，Excel 模型
     */
    public static ExcelWriterFactroy writeExcelWithSheets(HttpServletResponse response, List<? extends BaseRowModel> list,
                                                          String fileName, String sheetName, BaseRowModel object) {
       ExcelWriterFactroy writer = new ExcelWriterFactroy(getOutputStream(fileName, response), ExcelTypeEnum.XLSX);
       Sheet sheet = new Sheet(1, 0, object.getClass());
       sheet.setSheetName(sheetName);
       writer.write(list, sheet);
       return writer;
    }

    /**
     * 导出文件时为Writer生成OutputStream
     */
    private static OutputStream getOutputStream(String fileName, HttpServletResponse response) {
       //创建本地文件
       String filePath = fileName + ".xlsx";
       File dbfFile = new File(filePath);
       try {
          if (!dbfFile.exists() || dbfFile.isDirectory()) {
             dbfFile.createNewFile();
          }
          fileName = new String(filePath.getBytes(), "ISO-8859-1");
          response.setContentType("application/vnd.ms-excel");
          response.setCharacterEncoding("utf-8");
          response.addHeader("Content-Disposition", "filename=" + fileName);
          response.setContentType("application/vnd.ms-excel;charset=utf-8");
          response.flushBuffer();
          return response.getOutputStream();
       } catch (IOException e) {
          throw new ExcelException("创建文件失败！");
       }
    }

    /**
     * 返回 ExcelReader
     *
     * @param excel         需要解析的 Excel 文件
     * @param excelListener new ExcelListener()
     */
    private static ExcelReader getReader(MultipartFile excel,
                                         ExcelListener excelListener) {
       String filename = excel.getOriginalFilename();
       if (filename == null || (!filename.toLowerCase().endsWith(".xls") && !filename.toLowerCase().endsWith(".xlsx"))) {
          throw new ExcelException("文件格式错误！");
       }
       InputStream inputStream;
       try {
          inputStream = new BufferedInputStream(excel.getInputStream());
          return new ExcelReader(inputStream, null, excelListener, false);
       } catch (IOException e) {
          e.printStackTrace();
       }
       return null;
    }
}

三、新版本工具类

新版本EasyExcel工具类：

package com.zzjdyf.tools.easyexcel;

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.read.builder.ExcelReaderBuilder;
import com.alibaba.excel.read.builder.ExcelReaderSheetBuilder;
import com.alibaba.excel.write.builder.ExcelWriterBuilder;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.fastjson.JSONObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.List;

public class EasyExcelUtil {

    private static final Logger log = LoggerFactory.getLogger(EasyExcelUtil.class);


    /**
     * 读取 Excel 文件中的所有数据，使用指定的 rowModel 映射每一行的数据。
     *
     * @param excel    MultipartFile 上传的 Excel 文件
     * @param rowModel 映射每一行数据的类
     * @return 读取到的数据列表
     */
    public static List<Object> readExcel(MultipartFile excel, Class<?> rowModel) {
        // 初始化 ExcelListener，用于监听 Excel 读取过程中的事件
        ExcelListener excelListener = new ExcelListener();
        // 获取 ExcelReaderBuilder，用于构建读取操作
        ExcelReaderBuilder readerBuilder = getReader(excel, excelListener);
        if (readerBuilder == null) {
            return null;
        }
        // 设置读取的行模型
        readerBuilder.head(rowModel);
        // 读取所有的 Sheet 页
        readerBuilder.doReadAll();
        // 返回读取到的数据
        return excelListener.getDatas();
    }
    /**
     * 读取指定 sheetNo 的 Excel 数据，使用指定的 rowModel 映射每一行的数据。
     *
     * @param excel    MultipartFile 上传的 Excel 文件
     * @param rowModel 映射每一行数据的类
     * @param sheetNo  要读取的 Sheet 页编号，从 0 开始
     * @return 读取到的数据列表
     */
    public static List<Object> readExcel(MultipartFile excel, Class<?> rowModel, int sheetNo) {
        return readExcel(excel, rowModel, sheetNo, 1);
    }
    /**
     * 读取指定 sheetNo 的 Excel 数据，使用指定的 rowModel 映射每一行的数据，支持自定义表头行数。
     *
     * @param excel       MultipartFile 上传的 Excel 文件
     * @param rowModel    映射每一行数据的类
     * @param sheetNo     要读取的 Sheet 页编号，从 0 开始
     * @param headLineNum 表头行数，默认为 1
     * @return 读取到的数据列表
     */
    public static List<Object> readExcel(MultipartFile excel, Class<?> rowModel, int sheetNo, int headLineNum) {
        // 初始化 ExcelListener，用于监听 Excel 读取过程中的事件
        ExcelListener excelListener = new ExcelListener();
        // 获取 ExcelReaderBuilder，用于构建读取操作
        ExcelReaderBuilder readerBuilder = getReader(excel, excelListener);
        if (readerBuilder == null) {
            return null;
        }
        // 构建 Sheet 页读取器
        ExcelReaderSheetBuilder sheetBuilder = readerBuilder.sheet(sheetNo).head(rowModel).headRowNumber(headLineNum);
        // 读取指定 Sheet 页
        sheetBuilder.doRead();
        // 返回读取到的数据
        return excelListener.getDatas();
    }
    /**
     * 将数据列表写入 Excel 文件，并通过 HTTP 响应返回给客户端。
     *
     * @param response  HttpServletResponse 用于返回文件的响应
     * @param list      要写入 Excel 的数据列表
     * @param fileName  导出的文件名
     * @param sheetName Sheet 页名称
     * @param rowModel  映射每一行数据的类
     */
    public static void writeExcel(HttpServletResponse response, List<?> list, String fileName, String sheetName, Class<?> rowModel) {
        try {
            // 构建 ExcelWriterBuilder，用于构建写入操作
            // 这里不指定转换器，使用EasyExcel默认的转换方式
            ExcelWriterBuilder writerBuilder = EasyExcel.write(getOutputStream(fileName, response), rowModel);
            // 构建 WriteSheet，用于定义写入的 Sheet 页
            WriteSheet sheet = EasyExcel.writerSheet(sheetName).build();
            // 写入数据到指定 Sheet 页
            writerBuilder.sheet(String.valueOf(sheet)).doWrite(list);
        } catch (Exception e) {
            log.error("excel输出异常\n" + JSONObject.toJSONString(list), e);
        }
    }
    /**
     * 将数据列表写入多个 Sheet 页的 Excel 文件，并通过 HTTP 响应返回给客户端。
     *
     * @param response  HttpServletResponse 用于返回文件的响应
     * @param list      要写入 Excel 的数据列表
     * @param fileName  导出的文件名
     * @param sheetName Sheet 页名称
     * @param rowModel  映射每一行数据的类
     * @return ExcelWriterBuilder 用于后续写入操作
     */
    public static ExcelWriterBuilder writeExcelWithSheets(HttpServletResponse response, List<?> list, String fileName, String sheetName, Class<?> rowModel) {
        // 构建 ExcelWriterBuilder，用于构建写入操作
        ExcelWriterBuilder writerBuilder = EasyExcel.write(getOutputStream(fileName, response), rowModel);
        // 构建 WriteSheet，用于定义写入的 Sheet 页
        WriteSheet sheet = EasyExcel.writerSheet(sheetName).build();
        // 写入数据到指定 Sheet 页
        writerBuilder.sheet(String.valueOf(sheet)).doWrite(list);
        // 返回 ExcelWriterBuilder
        return writerBuilder;
    }
    /**
     * 创建输出流，用于将 Excel 文件写入 HTTP 响应。
     *
     * @param fileName 导出的文件名
     * @param response HttpServletResponse 用于返回文件的响应
     * @return OutputStream 输出流
     */
    private static OutputStream getOutputStream(String fileName, HttpServletResponse response) {
        // 定义文件路径
        String filePath = fileName + ".xlsx";
        File dbfFile = new File(filePath);
        try {
            // 如果文件不存在或是目录，则创建新文件
            if (!dbfFile.exists() || dbfFile.isDirectory()) {
                dbfFile.createNewFile();
            }
            // 设置响应头，指定文件名和文件类型
            fileName = new String(filePath.getBytes(), "ISO-8859-1");
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            response.addHeader("Content-Disposition", "attachment; filename=" + fileName);
            response.flushBuffer();
            // 返回输出流
            return response.getOutputStream();
        } catch (IOException e) {
            throw new ExcelException("创建文件失败！");
        }
    }
    /**
     * 获取 ExcelReaderBuilder，用于构建 Excel 读取操作。
     *
     * @param excel         MultipartFile 上传的 Excel 文件
     * @param excelListener ExcelListener 监听器，用于处理读取过程中的事件
     * @return ExcelReaderBuilder 构建器
     */
    private static ExcelReaderBuilder getReader(MultipartFile excel, ExcelListener excelListener) {
        // 获取文件名
        String filename = excel.getOriginalFilename();
        // 检查文件格式是否正确
        if (filename == null || (!filename.toLowerCase().endsWith(".xls") && !filename.toLowerCase().endsWith(".xlsx"))) {
            throw new ExcelException("文件格式错误！");
        }
        try {
            // 获取文件输入流
            InputStream inputStream = new BufferedInputStream(excel.getInputStream());
            // 返回 ExcelReaderBuilder
            return EasyExcel.read(inputStream, excelListener);
        } catch (IOException e) {
            throw new ExcelException("读取文件失败！");
        }
    }
}

四、新版本工具类使用例子

实体类（使用@ExcelProperty注解）

package com.zzjdyf.tools.easyexcel;

import com.alibaba.excel.annotation.ExcelProperty;
import lombok.Data;

@Data
public class User {
    @ExcelProperty("ID")
    private Long id;

    @ExcelProperty("姓名")
    private String name;

    @ExcelProperty("年龄")
    private Integer age;
}

导入Excel数据

import com.zzjdyf.tools.easyexcel.EasyExcelUtil;
import org.springframework.web.multipart.MultipartFile;

import java.util.List;

public class ExcelImportExample {

    public void importExcel(MultipartFile file) {
        // 导入Excel文件，并将数据映射到User类
        List<Object> userList = EasyExcelUtil.readExcel(file, User.class);

        // 处理导入的数据
        for (Object obj : userList) {
            User user = (User) obj;
            System.out.println(user);
        }
    }
}

导出Excel数据

import com.zzjdyf.tools.easyexcel.EasyExcelUtil;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.List;

public class ExcelExportExample {

    public void exportExcel(HttpServletResponse response) {
        // 创建一些示例数据
        List<User> userList = new ArrayList<>();
        userList.add(new User(1L, "Alice", 30));
        userList.add(new User(2L, "Bob", 25));
        userList.add(new User(3L, "Charlie", 35));

        // 导出Excel文件
        EasyExcelUtil.writeExcel(response, userList, "用户信息", "Sheet1", User.class);
    }
}

导入指定Sheet的数据

import com.zzjdyf.tools.easyexcel.EasyExcelUtil;
import org.springframework.web.multipart.MultipartFile;

import java.util.List;

public class ExcelImportExample {

    public void importExcel(MultipartFile file, int sheetNo) {
        // 从指定的Sheet导入数据
        List<Object> userList = EasyExcelUtil.readExcel(file, User.class, sheetNo);

        // 处理导入的数据
        for (Object obj : userList) {
            User user = (User) obj;
            System.out.println(user);
        }
    }
}

导出到多个Sheet

import com.zzjdyf.tools.easyexcel.EasyExcelUtil;
import com.alibaba.excel.write.builder.ExcelWriterBuilder;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.List;

public class ExcelExportExample {

    public void exportExcelWithSheets(HttpServletResponse response) {
        // 创建一些示例数据
        List<User> userList1 = new ArrayList<>();
        userList1.add(new User(1L, "Alice", 30));
        userList1.add(new User(2L, "Bob", 25));

        List<User> userList2 = new ArrayList<>();
        userList2.add(new User(3L, "Charlie", 35));
        userList2.add(new User(4L, "David", 28));

        // 导出第一个Sheet
        ExcelWriterBuilder writerBuilder = EasyExcelUtil.writeExcelWithSheets(response, userList1, "用户信息", "Sheet1", User.class);

        // 导出第二个Sheet
        writerBuilder.sheet("Sheet2").doWrite(userList2);
    }
}