描述:Java解析、生成Excel比较有名的框架有Apache poi、jxl。但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,但POI还是有一些缺陷,比如07版Excel解压缩以及解压后存储都是在内存中完成的,内存消耗依然很大。easyexcel重写了poi对07版Excel的解析,能够原本一个3M的excel用POI sax依然需要100M左右内存降低到KB级别,并且再大的excel不会出现内存溢出,03版依赖POI的sax模式。在上层做了模型转换的封装,让使用者更加简单方便。
1.添加依赖
<!--阿里巴巴easyexcel工具-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>1.1.2-beta5</version>
</dependency>
2.导出工具类(可以直接复制使用)
package cn.xxx.xxx.xxx.xxx;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import com.alibaba.excel.support.ExcelTypeEnum;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
/**
* @Author:
* @Description:
* @Date: Created in 15:40 2019/11/26
*/
public class ExcelExportUtil {
/**
* @Description: 使用阿里开源工具easyExcel导出
* List<? extends BaseRowModel> 的作用为可以传入任意实体集合并继承BaseRowModel
*/
public static void easyExcelExport(List<? extends BaseRowModel> resList, String fileName, HttpServletResponse response) throws IOException {
//指定文件输出位置,使用该方法不需要引入HttpServletResponse (根据业务需求,而选其一)
/*OutputStream outputStream =new FileOutputStream("H:/excel/file/myexcel3.xlsx");
ExcelWriter excelWriter = EasyExcelFactory.getWriter(outputStream);*/
//调用浏览器下载(根据业务需求,而选其一)
String fileName11 = URLEncoder.encode(fileName, "UTF-8");//避免中文乱码
String fileName12 = java.net.URLDecoder.decode(fileName11, "UTF-8");//避免中文乱码
response.setContentType("APPLICATION/OCTET-STREAM");
response.setHeader("Content-Disposition", "attachment;filename=" + new String(fileName12.getBytes("gb2312"), "ISO8859-1"));
ServletOutputStream out = response.getOutputStream();
ExcelWriter excelWriter = EasyExcelFactory.getWriter(out, ExcelTypeEnum.XLS);
//将要输出的内容填充到Sheet里,resList.get(0).getClass()获取的就是ExcelSignpay.class
Sheet sheet1 = new Sheet(1, 0, resList.get(0).getClass());
//设置sheet表名
sheet1.setSheetName("sheet1");
/**
* 写数据到Write上下文中
* 第一个参数:要写入的内容、第二个参数:要写入的sheet目标
*/
writer.write(resList, sheet1);
out.flush();
writer.finish();
out.close();
}
}
3. 定义上面备注中的ExcelSignpay.class,首先需要继承BaseRowModel,其次,通过 @ExcelProperty
注解来指定每个字段的列名称,以及下标位置;
package **********;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.metadata.BaseRowModel;
import lombok.Data;
import java.math.BigDecimal;
import java.util.Date;
@Data
public class ExcelSignpay extends BaseRowModel {
@ExcelProperty(value = "订单id", index = 0)
private String orderId;
@ExcelProperty(value = "公司名称", index = 1)
private String companyName;
}
4.调用
/**
* @Description: HttpServletResponse 在使用调用浏览器下载方式时需要引入,指定路径不需要
*/
@RequestMapping(value = "/excelForComOrder", method = RequestMethod.GET)
@ApiOperation(value = "导出公司订单")
public void excelForComOrder(HttpServletResponse response) {
DateFormat df = new SimpleDateFormat("yyyyMMdd_HHmmss");
try {
// 虚拟数据(根据自己逻辑调用数据库)
List<ExcelSignpay> resList = createModelList();
//定义文件名称
String fileName = "签到历史" + df.format(new Date()) + ".xls";
ExcelExportUtil.easyExcelExport(resList, fileName, response);
} catch (Exception e) {
log.error("导出签到历史失败" + e.getMessage(), e);
}
}
5.虚拟生成数据方法
private List<ExcelSignpay> createModelList (){
List<ExcelSignpay> list = new ArrayList<>();
for(int i=0; i<20;i++){
ExcelSignpay excelMode = new ExcelSignpay();
excelMode.setOrderId("哒哒"+i);
excelMode.setCompanyName("22");
list.add(excelMode);
}
return list;
}
特别注意一下,测试的时候如果是用swagger进行测试的话,文件名称中有中文的话会一直是乱码,要用浏览器通过链接访问才行,此坑很深,我一直以为工具类中的编译没有生效,耽误了很久
**************************************************上面是导出的示例,下面是导入的**********************************************************
第一步:在pom中和导出引用同样的依赖,这个看上面
第二步:导入工具类(可以直接复制使用)
package xxx.xxx.xxx.xxx.utils;
import com.alibaba.excel.ExcelReader;
import com.alibaba.excel.metadata.BaseRowModel;
import com.alibaba.excel.metadata.Sheet;
import xxx.xxx.xxx.xxx.xxx.ShangzeException;
import com.shangze.gf.common.listener.ExcelListener;
import org.springframework.web.multipart.MultipartFile;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
/**
* @Author: xxxx
* @Description: excel导入
* @Date: Created in 15:40 2020/12/14
*/
public class ExcelImportUtil {
/**
* 读取某个 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) {
//引入 Excel 导入监听
ExcelListener excelListener = new ExcelListener();
//解析的 Excel 文件
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) {
String filename = excel.getOriginalFilename();
if (filename == null || (!filename.toLowerCase().endsWith(".xls") && !filename.toLowerCase().endsWith(".xlsx"))) {
//这里是我们自定义的异常,可以根据自己的项目更改
throw new ShangzeException("文件格式错误!");
}
InputStream inputStream;
try {
inputStream = new BufferedInputStream(excel.getInputStream());
return new ExcelReader(inputStream, null, excelListener, false);
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
}
第三步:创建同导出第三步一样的工具类,类名自定义
package ***.***.***.***.***;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.metadata.BaseRowModel;
import lombok.Data;
@Data
public class ImportExcelVo extends BaseRowModel {
@ExcelProperty(value = {"***"}, index = 0)
private String id;
@ExcelProperty(value = {"***"}, index = 1)
private String name;
}
第四步:调用
/**
* @Description: 批量导入信息
* @author: ***
* @date: 2020/12/14 9:26
*/
@PostMapping(value = "/importList")
@ApiOperation(value = "批量导入信息")
public Result<Object> importList(MultipartFile excel) throws ParseException {
Object objList = ExcelImportUtil.readExcel(excel, new ImportExcelVo(), 1, 1);
if (objList == null) {
return new ResultUtil<>().setErrorMsg("导入的数据不能为空");
}
List<ImportExcelVo> list = (List<ImportExcelVo>) objList;
if (list == null || list .size() <= 0) {
return new ResultUtil<>().setErrorMsg("导入的数据不能为空");
}
//下面就是自己的业务逻辑了
return *******;
}