SpringBoot整合easyexcel实现Excel的导出
Posted 山河永慕
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringBoot整合easyexcel实现Excel的导出相关的知识，希望对你有一定的参考价值。
之前使用POI导出excel需要自己先去创建excel文件，还要创建sheet，写表头，操作起来确实很麻烦，针对产品这种随心而欲的需求我们能不能快速的做完这样一个产品看起来挺简单的功能。
或者弊端是POI 占用内存较大而且性能不高,表格数据多卡顿 解析慢。
引入Maven依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.2.5</version>
</dependency>
导入好了之后，我们接下来需要创建一个导出的模板类，首先要集成BaseRowModel，set、get省略，@ExcelProperty注解中的value就是表头的信息，index是在第几列，没有加注解的不会导出。
这里需要注意的是BaseRowModel 新版本里面提示过时了,但easyexcel刚出来不久 有知道新的写法的可以指import com.alibaba.excel.ExcelReaderimport com.alibaba.excel.metadata.BaseRowModelimport com.alibaba.excel.metadata.Sheet;import com.project.common.exception.MyException;
import com.project.listener.ExcelListener; import org.springframework.web.multipart.MultipartFile; import java.io.BufferedInputStream; import java.io.IOException; import java.io.InputStream; import java.util.List; public class ExcelUtils { /** * 读取某个 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) throws Exception { 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(); } /** * 返回 ExcelReader * * @param excel 需要解析的 Excel 文件 * @param excelListener new ExcelListener() */ private static ExcelReader getReader(MultipartFile excel, ExcelListener excelListener) throws Exception { String filename = excel.getOriginalFilename(); if (filename == null || (!filename.toLowerCase().endsWith(".xls") && !filename.toLowerCase().endsWith(".xlsx"))) { //throw new ExcelException("文件格式错误！"); throw new MyException("文件格式错误！"); } InputStream inputStream; try { inputStream = new BufferedInputStream(excel.getInputStream()); return new ExcelReader(inputStream, null, excelListener, false); } catch (IOException e) { e.printStackTrace(); } return null; }
}
补充一些excelutils里面还会用到的
/** * 读取 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) { ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); TableStyle tableStyle = new TableStyle(); tableStyle.setTableContentBackGroundColor(IndexedColors.WHITE); Font font = new Font(); font.setFontHeightInPoints((short) 9); tableStyle.setTableHeadFont(font); tableStyle.setTableContentFont(font); sheet.setTableStyle(tableStyle); writer.write(list, sheet); writer.finish(); } /** * 导出 Excel ：多个 sheet，带表头 * * @param response HttpServletResponse * @param list 数据 list，每个元素为一个 BaseRowModel * @param fileName 导出的文件名 * @param sheetName 导入文件的 sheet 名 * @param object 映射实体类，Excel 模型 */ public static ExcelWriterFactory writeExcelWithSheets(HttpServletResponse response, List<? extends BaseRowModel> list, String fileName, String sheetName, BaseRowModel object) { ExcelWriterFactory writer = new ExcelWriterFactory(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); sheet.setTableStyle(getTableStyle()); writer.write(list, sheet); return writer; } /** * 导出融资还款情况表 * * @param response * @param list * @param fileName * @param sheetName * @param object */ public static void writeFinanceRepayment(HttpServletResponse response, List<? extends BaseRowModel> list, String fileName, String sheetName, BaseRowModel object) { ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); sheet.setTableStyle(getTableStyle()); writer.write(list, sheet); for (int i = 1; i <= list.size(); i += 4) { writer.merge(i, i + 3, 0, 0); writer.merge(i, i + 3, 1, 1); } writer.finish(); } /** * 导出文件时为Writer生成OutputStream */ private static OutputStream getOutputStream(String fileName, HttpServletResponse response) { //创建本地文件 fileName = fileName + ".xls"; try { fileName = new String(fileName.getBytes(), "ISO-8859-1"); response.addHeader("Content-Disposition", "filename=" + fileName); return response.getOutputStream(); } catch (Exception 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; } /** * 资金收支导出 Excel ：一个 sheet，带表头 * * @param response HttpServletResponse * @param list 数据 list，每个元素为一个 BaseRowModel * @param fileName 导出的文件名 * @param sheetName 导入文件的 sheet 名 * @param object 映射实体类，Excel 模型 */ public static void exportFundBudgetExcel(HttpServletResponse response, List<? extends BaseRowModel> list, String fileName, String sheetName, BaseRowModel object) throws IOException { ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); sheet.setTableStyle(getTableStyle()); writer.write(list, sheet); writer.merge(2, 3, 0, 0); writer.merge(4, 13, 0, 0); writer.merge(14, 14, 0, 1); writer.finish(); } /** * 读取Excel表格数据，封装成实体 * * @param inputStream * @param clazz * @param sheetNo * @param headLineMun * @return */ public static Object readExcel(InputStream inputStream, Class<? extends BaseRowModel> clazz, Integer sheetNo, Integer headLineMun) { if (null == inputStream) { throw new NullPointerException("the inputStream is null!"); } ExcelListener listener = new ExcelListener(); ExcelReader reader = new ExcelReader(inputStream, valueOf(inputStream), null, listener); reader.read(new Sheet(sheetNo, headLineMun, clazz)); return listener.getDatas(); } /** * 根据输入流，判断为xls还是xlsx，该方法原本存在于easyexcel 1.1.0 的ExcelTypeEnum中。 */ public static ExcelTypeEnum valueOf(InputStream inputStream) { try { FileMagic fileMagic = FileMagic.valueOf(inputStream); if (FileMagic.OLE2.equals(fileMagic)) { return ExcelTypeEnum.XLS; } if (FileMagic.OOXML.equals(fileMagic)) { return ExcelTypeEnum.XLSX; } throw new ExcelException("excelTypeEnum can not null"); } catch (IOException e) { throw new RuntimeException(e); } } /** * 设置全局样式 * * @return */ private static TableStyle getTableStyle() { TableStyle tableStyle = new TableStyle(); tableStyle.setTableContentBackGroundColor(IndexedColors.WHITE); Font font = new Font(); font.setBold(true); font.setFontHeightInPoints((short) 9); tableStyle.setTableHeadFont(font); Font fontContent = new Font(); fontContent.setFontHeightInPoints((short) 9); tableStyle.setTableContentFont(fontContent); return tableStyle; }
再需要一个Listener解析每一行的结果并返回
import com.alibaba.excel.context.AnalysisContext; import com.alibaba.excel.event.AnalysisEventListener; import java.util.ArrayList; import java.util.List; public class ExcelListener extends AnalysisEventListener { /** * 自定义用于暂时存储data。 * 可以通过实例获取该值 */ private List<Object> datas = new ArrayList<>(); /** * 通过 AnalysisContext 对象还可以获取当前 sheet，当前行等数据 */ @Override public void invoke(Object object, AnalysisContext context) { //数据存储到list，供批量处理，或后续自己业务逻辑处理。 datas.add(object); //根据业务自行 do something doSomething(); /* 如数据过大，可以进行定量分批处理 if(datas.size()<=100){ datas.add(object); }else { doSomething(); datas = new ArrayList<Object>(); } */ } /** * 根据业务自行实现该方法 */ private void doSomething() { } @Override public void doAfterAllAnalysed(AnalysisContext context) { /* datas.clear(); 解析结束销毁不用的资源 */ } public List<Object> getDatas() { return datas; } public void setDatas(List<Object> datas) { this.datas = datas; } }
导入controller
@PostMapping("/import/order")
public ResultMsg import_order(MultipartFile excel) {
Object objList = ExcelUtil.readExcel(excel, new OrderExcelBO(), 1, 1);
if (objList == null) {
return ResultMsg.fail(500, "导入的数据不能为空");
}
List<OrderExcelBO> orderList = (List<OrderExcelBO>) objList;
if (orderList == null || orderList.size() <= 0) {
return ResultMsg.fail(500, "导入的数据不能为空");
}
orderList.forEach(System.out::println);
return ResultMsg.success();
}
/** * 导出 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) { ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); TableStyle tableStyle = new TableStyle(); tableStyle.setTableContentBackGroundColor(IndexedColors.WHITE); Font font = new Font(); font.setFontHeightInPoints((short) 9); tableStyle.setTableHeadFont(font); tableStyle.setTableContentFont(font); sheet.setTableStyle(tableStyle); writer.write(list, sheet); writer.finish(); } /** * 导出 Excel ：多个 sheet，带表头 * * @param response HttpServletResponse * @param list 数据 list，每个元素为一个 BaseRowModel * @param fileName 导出的文件名 * @param sheetName 导入文件的 sheet 名 * @param object 映射实体类，Excel 模型 */public static ExcelWriterFactory writeExcelWithSheets(HttpServletResponse response, List<? extends BaseRowModel> list, String fileName, String sheetName, BaseRowModel object) { ExcelWriterFactory writer = new ExcelWriterFactory(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); sheet.setTableStyle(getTableStyle()); writer.write(list, sheet); return writer; } /** * 导出融资还款情况表 * * @param response * @param list * @param fileName * @param sheetName * @param object */public static void writeFinanceRepayment(HttpServletResponse response, List<? extends BaseRowModel> list, String fileName, String sheetName, BaseRowModel object) { ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); sheet.setTableStyle(getTableStyle()); writer.write(list, sheet); for (int i = 1; i <= list.size(); i += 4) { writer.merge(i, i + 3, 0, 0); writer.merge(i, i + 3, 1, 1); } writer.finish(); } /** * 导出文件时为Writer生成OutputStream */private static OutputStream getOutputStream(String fileName, HttpServletResponse response) { //创建本地文件 fileName = fileName + ".xls"; try { fileName = new String(fileName.getBytes(), "ISO-8859-1"); response.addHeader("Content-Disposition", "filename=" + fileName); return response.getOutputStream(); } catch (Exception e) { thrownew 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"))) { thrownew ExcelException("文件格式错误！"); } InputStream inputStream; try { inputStream = new BufferedInputStream(excel.getInputStream()); returnnew ExcelReader(inputStream, null, excelListener, false); } catch (IOException e) { e.printStackTrace(); } returnnull; } /** * 资金收支导出 Excel ：一个 sheet，带表头 * * @param response HttpServletResponse * @param list 数据 list，每个元素为一个 BaseRowModel * @param fileName 导出的文件名 * @param sheetName 导入文件的 sheet 名 * @param object 映射实体类，Excel 模型 */public static void exportFundBudgetExcel(HttpServletResponse response, List<? extends BaseRowModel> list, String fileName, String sheetName, BaseRowModel object) throws IOException { ExcelWriter writer = new ExcelWriter(getOutputStream(fileName, response), ExcelTypeEnum.XLSX); Sheet sheet = new Sheet(1, 0, object.getClass()); sheet.setSheetName(sheetName); sheet.setTableStyle(getTableStyle()); writer.write(list, sheet); writer.merge(2, 3, 0, 0); writer.merge(4, 13, 0, 0); writer.merge(14, 14, 0, 1); writer.finish(); } /** * 读取Excel表格数据，封装成实体 * * @param inputStream * @param clazz * @param sheetNo * @param headLineMun * @return */public static Object readExcel(InputStream inputStream, Class<? extends BaseRowModel> clazz, Integer sheetNo, Integer headLineMun) { if (null == inputStream) { thrownew NullPointerException("the inputStream is null!"); } ExcelListener listener = new ExcelListener(); ExcelReader reader = new ExcelReader(inputStream, valueOf(inputStream), null, listener); reader.read(new Sheet(sheetNo, headLineMun, clazz)); return listener.getDatas(); } /** * 根据输入流，判断为xls还是xlsx，该方法原本存在于easyexcel 1.1.0 的ExcelTypeEnum中。 */public static ExcelTypeEnum valueOf(InputStream inputStream) { try { FileMagic fileMagic = FileMagic.valueOf(inputStream); if (FileMagic.OLE2.equals(fileMagic)) { return ExcelTypeEnum.XLS; } if (FileMagic.OOXML.equals(fileMagic)) { return ExcelTypeEnum.XLSX; } thrownew ExcelException("excelTypeEnum can not null"); } catch (IOException e) { thrownew RuntimeException(e); } } /** * 设置全局样式 * * @return */private static TableStyle getTableStyle() { TableStyle tableStyle = new TableStyle(); tableStyle.setTableContentBackGroundColor(IndexedColors.WHITE); Font font = new Font(); font.setBold(true); font.setFontHeightInPoints((short) 9); tableStyle.setTableHeadFont(font); Font fontContent = new Font(); fontContent.setFontHeightInPoints((short) 9); tableStyle.setTableContentFont(fontContent); return tableStyle; }
以上是关于SpringBoot整合easyexcel实现Excel的导出的主要内容，如果未能解决你的问题，请参考以下文章
SpringBoot整合easyexcel实现Excel的导出
SpringBoot——快速整合EasyExcel实现Excel的上传下载
SpringBoot——快速整合EasyExcel实现Excel的上传下载
SpringBoot——快速整合EasyExcel实现Excel的上传下载