Java EasyPoi工具使用
一、工具使用
引入最新的pom依赖
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-spring-boot-starter</artifactId>
<version>3.3.0</version>
</dependency>
具体工具类
import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
public class ExcelUtils {
/**
* excel 导出
*
* @param list 数据
* @param title 标题
* @param sheetName sheet名称
* @param pojoClass pojo类型
* @param fileName 文件名称
* @param isCreateHeader 是否创建表头
* @param response
*/
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, boolean isCreateHeader, HttpServletResponse response) throws IOException {
ExportParams exportParams = new ExportParams(title, sheetName, ExcelType.XSSF);
exportParams.setCreateHeadRows(isCreateHeader);
defaultExport(list, pojoClass, fileName, response, exportParams);
}
/**
* excel 导出
*
* @param list 数据
* @param title 标题
* @param sheetName sheet名称
* @param pojoClass pojo类型
* @param fileName 文件名称
* @param response
*/
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, HttpServletResponse response) throws IOException {
defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName, ExcelType.XSSF));
}
/**
* excel 导出
*
* @param list 数据
* @param pojoClass pojo类型
* @param fileName 文件名称
* @param response
* @param exportParams 导出参数
*/
public static void exportExcel(List<?> list, Class<?> pojoClass, String fileName, ExportParams exportParams, HttpServletResponse response) throws IOException {
defaultExport(list, pojoClass, fileName, response, exportParams);
}
/**
* excel 导出
*
* @param list 数据
* @param fileName 文件名称
* @param response
*/
public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) throws IOException {
defaultExport(list, fileName, response);
}
/**
* 默认的 excel 导出
*
* @param list 数据
* @param pojoClass pojo类型
* @param fileName 文件名称
* @param response
* @param exportParams 导出参数
*/
private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) throws IOException {
Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
downLoadExcel(fileName, response, workbook);
}
/**
* 默认的 excel 导出
*
* @param list 数据
* @param fileName 文件名称
* @param response
*/
private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) throws IOException {
Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
downLoadExcel(fileName, response, workbook);
}
/**
* 下载
*
* @param fileName 文件名称
* @param response
* @param workbook excel数据
*/
private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) throws IOException {
try {
response.setCharacterEncoding("UTF-8");
response.setHeader("content-Type", "application/vnd.ms-excel");
response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName + "." + ExcelTypeEnum.XLSX.getValue(), "UTF-8"));
workbook.write(response.getOutputStream());
} catch (Exception e) {
throw new IOException(e.getMessage());
}
}
/**
* excel 导入
*
* @param filePath excel文件路径
* @param titleRows 标题行
* @param headerRows 表头行
* @param pojoClass pojo类型
* @param <T>
* @return
*/
public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) throws IOException {
if (StringUtils.isBlank(filePath)) {
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
params.setNeedSave(true);
params.setSaveUrl("/excel/");
try {
return ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
} catch (NoSuchElementException e) {
throw new IOException("模板不能为空");
} catch (Exception e) {
throw new IOException(e.getMessage());
}
}
/**
* excel 导入
*
* @param file excel文件
* @param pojoClass pojo类型
* @param <T>
* @return
*/
public static <T> List<T> importExcel(MultipartFile file, Class<T> pojoClass) throws IOException {
return importExcel(file, 1, 1, pojoClass);
}
/**
* excel 导入
*
* @param file excel文件
* @param titleRows 标题行
* @param headerRows 表头行
* @param pojoClass pojo类型
* @param <T>
* @return
*/
public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass) throws IOException {
return importExcel(file, titleRows, headerRows, false, pojoClass);
}
/**
* excel 导入
*
* @param file 上传的文件
* @param titleRows 标题行
* @param headerRows 表头行
* @param needVerfiy 是否检验excel内容
* @param pojoClass pojo类型
* @param <T>
* @return
*/
public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, boolean needVerfiy, Class<T> pojoClass) throws IOException {
if (file == null) {
return null;
}
try {
return importExcel(file.getInputStream(), titleRows, headerRows, needVerfiy, pojoClass);
} catch (Exception e) {
throw new IOException(e.getMessage());
}
}
/**
* excel 导入
*
* @param inputStream 文件输入流
* @param titleRows 标题行
* @param headerRows 表头行
* @param needVerfiy 是否检验excel内容
* @param pojoClass pojo类型
* @param <T>
* @return
*/
public static <T> List<T> importExcel(InputStream inputStream, Integer titleRows, Integer headerRows, boolean needVerfiy, Class<T> pojoClass) throws IOException {
if (inputStream == null) {
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
params.setSaveUrl("/excel/");
params.setNeedSave(true);
params.setNeedVerfiy(needVerfiy);
try {
return ExcelImportUtil.importExcel(inputStream, pojoClass, params);
} catch (NoSuchElementException e) {
throw new IOException("excel文件不能为空");
} catch (Exception e) {
throw new IOException(e.getMessage());
}
}
/**
* Excel 类型枚举
*/
enum ExcelTypeEnum {
XLS("xls"), XLSX("xlsx");
private String value;
ExcelTypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
}
}
测试类(实体自己替换)
/**
* 导出
*
* @param response
*/
@RequestMapping(value = "/export", method = RequestMethod.GET)
public void exportExcel(HttpServletResponse response) {
long start = System.currentTimeMillis();
List<MonitorPersonExportVo> personList = new ArrayList<>();
for (int i = 0; i < 5; i++) {
MonitorPersonExportVo personVo = new MonitorPersonExportVo();
personVo.setName("张三" + i);
personVo.setUsername("张三" + i);
personVo.setPhoneNumber("18888888888");
personVo.setImageUrl(Constant.DEFAULT_IMAGE);
personList.add(personVo);
}
log.debug("导出excel所花时间:" + (System.currentTimeMillis() - start));
ExcelUtils.exportExcel(personList, "员工信息表", "员工信息", MonitorPersonExportVo.class, "员工信息", response);
}
二、合并(自己对照着结果琢磨代码)
代码
/**
* @author Wilson
* @date 2019/8/26
**/
public class DynamicPoiTest {
public static void main(String[] args) throws IOException {
List<ExcelExportEntity> entity = new ArrayList<>();
entity.add(buildExcelEntity("序号", "order", 0));
entity.add(buildExcelEntity("性别", "sex", 1));
// 设置了group的若不设置排序默认会派到最后
entity.add(buildExcelEntityByGroup("姓名", "students.name", "学生", 2));
entity.add(buildExcelEntityByGroup("性别", "students.sex", "学生", 2));
entity.add(buildExcelEntity("班级", "class", 3));
List<Map<String, Object>> list = new ArrayList<>();
IntStream.range(0, 10).forEach(i -> {
Map<String, Object> params = new HashMap<>();
params.put("order", "" + i);
params.put("sex", "sex" + i);
params.put("class", "class-" + i);
params.put("students.sex", "man-" + i);
params.put("students.name", "name-" + i);
list.add(params);
});
Workbook workbook = ExcelExportUtil.exportExcel(new ExportParams("测试", "测试"), entity, list);
try (FileOutputStream fos = new FileOutputStream("E:/IntelliJ/workspace/netty-demo/ExcelExportForMap.xls")) {
workbook.write(fos);
}
}
private static ExcelExportEntity buildExcelEntity(String name, Object key, int orderNo) {
ExcelExportEntity excelEntity = new ExcelExportEntity(name, key);
excelEntity.setOrderNum(orderNo);
return excelEntity;
}
/**
* 在group列下添加子列
*
* @param name
* @param key
* @param group
* @return
*/
private static ExcelExportEntity buildExcelEntityByGroup(String name, Object key, String group, int orderNo) {
ExcelExportEntity excelEntity = new ExcelExportEntity(name, key);
excelEntity.setGroupName(group);
excelEntity.setOrderNum(orderNo);
return excelEntity;
}
}
结果
三、预览
说明:前不部分跟自己业务相关的,有时间再来优化
public Result excelPreview(Integer id) {
String content = null;
StringWriter writer = null;
try {
UserGroupVo userGroupVo = userGroupMapper.getUserGroupById(id);
// 导出Excel
if (userGroupVo != null) {
List<UserExcelDto> userInfoList = getUserGroupList(userGroupVo);
userInfoList = userInfoList.subList(0, userInfoList.size() > 100 ? 100 : userInfoList.size());
ExportParams exportParams = new ExportParams(userGroupVo.getName(), userGroupVo.getName(),
ExcelType.HSSF);
Workbook workBook = ExcelExportUtil.exportExcel(exportParams, UserExcelDto.class, userInfoList);
ExcelToHtmlConverter converter = new ExcelToHtmlConverter(
DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument());
converter.setOutputColumnHeaders(false);// 不显示列的表头
converter.setOutputRowNumbers(false);// 不显示行的表头
converter.processWorkbook((HSSFWorkbook) workBook);
writer = new StringWriter();
Transformer serializer = TransformerFactory.newInstance().newTransformer();
serializer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
serializer.setOutputProperty(OutputKeys.INDENT, "yes");
serializer.setOutputProperty(OutputKeys.METHOD, "html");
serializer.transform(new DOMSource(converter.getDocument()), new StreamResult(writer));
content = writer.toString();
writer.close();
}
} catch (Exception e) {
log.error("excel预览异常:{}", e.getMessage());
return ResultUtil.error(e.getMessage());
} finally {
try {
if (writer != null) {
writer.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
return ResultUtil.success(content);
}
四、遇到的问题:
EasyPOI在导出不指定格式时,数量10w以内默认使用HSSF格式,10w以上会使用XSSF格式,这样在7w-10w会有性能问题,源码如下
private static Workbook getWorkbook(ExcelType type, int size) {
if (ExcelType.HSSF.equals(type)) {
return new HSSFWorkbook();
} else {
return (Workbook)(size < 100000 ? new XSSFWorkbook() : new SXSSFWorkbook());
}
}
解决方案
1、可以一开始就使用XSSF,亲测性能大大提高,具体是替换源码:模仿源码写一段代码,用自己的这段代码而不是用源码的这段代码
参考:
https://www.jianshu.com/p/6e1d962ff444
https://blog.csdn.net/z28126308/article/details/100079790