何为easy POI
要知道easy poi是什么,先去POI说起,Apache POI是Apache软件基金会的开放源码函式库,POI提供API给Java程序对Microsoft Office格式档案读和写的功能,所以从字面意思可知,easy poi是对POI的再封装,是对导入导出更方便的一种解决方案
如何使用
加依赖
<!--Easy POI 很牛逼哦-->
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-base</artifactId>
<version>3.2.0</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-web</artifactId>
<version>3.2.0</version>
</dependency>
<dependency>
<groupId>cn.afterturn</groupId>
<artifactId>easypoi-annotation</artifactId>
<version>3.2.0</version>
</dependency>
写注解
/**
* @author luohuiqi
* @Description:
* @Date: 2019/7/11 10:36
*/
@Data
@Accessors(chain = true)
@AllArgsConstructor
public class QrcodeBO implements Serializable {
private static final long serialVersionUID = 1L;
@Excel(name = "名称", isImportField = "true_st", width = 20)
private String stpragePointNmae;
@Excel(name = "标签编号", width = 20, isImportField = "true_st")
private String monitorPointCode;
@Excel(name = "二维码", width = 20, isImportField = "true_st")
private String qrcode;
}
这里使用到了最基础的@Excel注解
写实现
// 封装数据
List<QrcodeBO> qrcodeBOS = new ArrayList<>();
monitorPointDOS.forEach(monitorPointDO ->
qrcodeBOS.add(new QrcodeBO(collectionPointMap.get(monitorPointDO.getPointId()), monitorPointDO.getCode(), monitorPointDO.getQrcode()))
);
// 导出
FileUtil.exportExcel(qrcodeBOS, "产生点二维码表", "产生点二维码",
QrcodeBO.class, "产生点二维码表.xls", HttpKit.getResponse());
这里有用到一个工具类
/**
* @author luohuiqi
* @Description:
* @Date: 2019/7/14 1:40
*/
public class FileUtil {
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, boolean isCreateHeader, HttpServletResponse response) {
ExportParams exportParams = new ExportParams(title, sheetName);
exportParams.setCreateHeadRows(isCreateHeader);
defaultExport(list, pojoClass, fileName, response, exportParams);
}
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, HttpServletResponse response) {
defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
}
public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
defaultExport(list, fileName, response);
}
private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {
exportParams.setStyle(ExcelStyleUtil.class);
Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
// 写入数据
if (workbook != null) {
downLoadExcel(fileName, response, workbook);
}
}
private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
try {
response.setCharacterEncoding("UTF-8");
response.setHeader("content-Type", "application/vnd.ms-excel");
response.setHeader("Content-Disposition",
"attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
workbook.write(response.getOutputStream());
} catch (IOException e) {
throw new RuntimeException(e.getMessage());
}
}
private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
if (workbook != null) ;
downLoadExcel(fileName, response, workbook);
}
public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
if (StringUtils.isBlank(filePath)) {
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
} catch (NoSuchElementException e) {
throw new RuntimeException("模板不能为空");
} catch (Exception e) {
e.printStackTrace();
throw new RuntimeException(e.getMessage());
}
return list;
}
public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
if (file == null) {
return null;
}
ImportParams params = new ImportParams();
params.setTitleRows(titleRows);
params.setHeadRows(headerRows);
List<T> list = null;
try {
list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
} catch (NoSuchElementException e) {
throw new RuntimeException("excel文件不能为空");
} catch (Exception e) {
throw new RuntimeException(e.getMessage());
}
return list;
}
}
执行
是不是很很简单呢,借用大目老师的话就是10分钟上手,哈哈哈
样式设置
由导出的图可以看到吗,基本没有什么样式,比如表格的边框,文字的大小,边距等
easy POI 提供了一个接口 == IExcelExportStyler==,我们可以实现它,来设置样式
书写样式
/**
* @author luohuiqi
* @Description:
* @Date: 2019/7/17 19:17
*/
public class ExcelStyleUtil implements IExcelExportStyler {
@Override
public CellStyle getHeaderStyle(short headerColor) {
return null;
}
@Override
public CellStyle getTitleStyle(short color) {
return null;
}
@Override
public CellStyle getStyles(boolean parity, ExcelExportEntity entity) {
return null;
}
@Override
public CellStyle getStyles(Cell cell, int dataRow, ExcelExportEntity entity, Object obj, Object data) {
return null;
}
@Override
public CellStyle getTemplateStyles(boolean isSingle, ExcelForEachParams excelForEachParams) {
return null;
}
}
大家可以看到,官方提供了4个方法(一个已经过时)供我们实现,它们分别是
- getHeaderStyle (获取表格头样式)
- getTitleStyle (获取列标题样式)
- getStyles (获取样式)
- getTemplateStyles(获取模板的样式)
用于模板导入/出
设置好后的模板为
package pro.nbbt.medical.medicalwaste.util.easyPoi;
import cn.afterturn.easypoi.excel.entity.params.ExcelExportEntity;
import cn.afterturn.easypoi.excel.entity.params.ExcelForEachParams;
import cn.afterturn.easypoi.excel.export.styler.IExcelExportStyler;
import org.apache.poi.ss.usermodel.*;
import static org.apache.poi.ss.usermodel.BorderFormatting.BORDER_THIN;
import static org.apache.poi.ss.usermodel.CellStyle.ALIGN_CENTER;
import static org.apache.poi.ss.usermodel.CellStyle.SOLID_FOREGROUND;
import static org.apache.poi.ss.usermodel.CellStyle.VERTICAL_CENTER;
/**
* @author luohuiqi
* @Description:
* @Date: 2019/7/17 19:17
*/
public class ExcelStyleUtil implements IExcelExportStyler {
private static final short STRING_FORMAT = (short) BuiltinFormats.getBuiltinFormat("TEXT");
private static final short FONT_SIZE_TEN = 10;
private static final short FONT_SIZE_ELEVEN = 11;
private static final short FONT_SIZE_TWELVE = 12;
/**
* 大标题样式
*/
private CellStyle headerStyle;
/**
* 每列标题样式
*/
private CellStyle titleStyle;
/**
* 数据行样式
*/
private CellStyle styles;
public ExcelStyleUtil(Workbook workbook) {
this.init(workbook);
}
/**
* 初始化样式
*
* @param workbook
*/
private void init(Workbook workbook) {
this.headerStyle = initHeaderStyle(workbook);
this.titleStyle = initTitleStyle(workbook);
this.styles = initStyles(workbook);
}
/**
* 大标题样式
*
* @param color
* @return
*/
@Override
public CellStyle getHeaderStyle(short color) {
return headerStyle;
}
/**
* 每列标题样式
*
* @param color
* @return
*/
@Override
public CellStyle getTitleStyle(short color) {
return titleStyle;
}
/**
* 数据行样式
*
* @param parity 可以用来表示奇偶行
* @param entity 数据内容
* @return 样式
*/
@Override
public CellStyle getStyles(boolean parity, ExcelExportEntity entity) {
return styles;
}
/**
* 初始化--每列标题样式
*
* @param workbook
* @return
*/
private CellStyle initTitleStyle(Workbook workbook) {
CellStyle style = getBaseCellStyle(workbook);
style.setFont(getFont(workbook, FONT_SIZE_ELEVEN, false));
//背景色
style.setFillForegroundColor(IndexedColors.GREY_25_PERCENT.getIndex());
style.setFillPattern(SOLID_FOREGROUND);
return style;
}
/**
* 获取样式方法
*
* @param dataRow 数据行
* @param obj 对象
* @param data 数据
*/
@Override
public CellStyle getStyles(Cell cell, int dataRow, ExcelExportEntity entity, Object obj, Object data) {
return getStyles(true, entity);
}
/**
* 模板使用的样式设置
*/
@Override
public CellStyle getTemplateStyles(boolean isSingle, ExcelForEachParams excelForEachParams) {
return null;
}
/**
* 初始化--大标题样式
*
* @param workbook
* @return
*/
private CellStyle initHeaderStyle(Workbook workbook) {
CellStyle style = getBaseCellStyle(workbook);
style.setFont(getFont(workbook, FONT_SIZE_TWELVE, true));
return style;
}
/**
* 初始化--数据行样式
*
* @param workbook
* @return
*/
private CellStyle initStyles(Workbook workbook) {
CellStyle style = getBaseCellStyle(workbook);
style.setFont(getFont(workbook, FONT_SIZE_TEN, false));
style.setDataFormat(STRING_FORMAT);
return style;
}
/**
* 基础样式
*
* @return
*/
private CellStyle getBaseCellStyle(Workbook workbook) {
CellStyle style = workbook.createCellStyle();
//下边框
style.setBorderBottom(BORDER_THIN);
//左边框
style.setBorderLeft(BORDER_THIN);
//上边框
style.setBorderTop(BORDER_THIN);
//右边框
style.setBorderRight(BORDER_THIN);
//水平居中
style.setAlignment(ALIGN_CENTER);
//上下居中
style.setVerticalAlignment(VERTICAL_CENTER);
//设置自动换行
style.setWrapText(true);
return style;
}
/**
* 字体样式
*
* @param size 字体大小
* @param isBold 是否加粗
* @return
*/
private Font getFont(Workbook workbook, short size, boolean isBold) {
Font font = workbook.createFont();
//字体样式
font.setFontName("宋体");
//是否加粗
font.setBold(isBold);
//字体大小
font.setFontHeightInPoints(size);
return font;
}
}
使用样式
private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {
if (Objects.equals(MEDICALWASTEMONTHSTATIC, exportParams.getSheetName())) {
exportParams.setHeight((short) 7);
} else if ((Objects.equals(MEDICALWASTEYEARSTATIC, exportParams.getSheetName()))) {
exportParams.setHeight((short) 14);
}
// 设置样式
exportParams.setStyle(ExcelStyleUtil.class);
Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
// 写入数据
if (workbook != null) {
downLoadExcel(fileName, response, workbook);
}
}
导出效果2
遇到的坑
- 设置@Excel的height参数无效
解决方法:其实官方已经说的很清楚了
所以可以在刚才刚才设置样式的地方,同样设置高即可/** * 导出时在excel中每个列的高度 单位为字符,一个汉字=2个字符 * 优先选择@ExportParams中的 height */ @Deprecated public double height() default 10;
- 设置@Excel的isStatistics时,琪单元格的样式会和数据列的样式不一致
解决方法:可以继续在之前的defaultExport方法中设置
如图所示,若需要展示额外数据也可以添加
最后导出的效果如下
任意合并单元格
解决官方提供的只能合并相同内容的单元格和空单元格不能合并的问题/** * 纵向合并相同内容的单元格(包括空) * * @param sheet * @param mergeMap key--列,value--依赖的列,没有传空 * @param startRow 开始行 * @param endRow 结束行 */ public static void mergeCells(Sheet sheet, Map<Integer, int[]> mergeMap, int startRow, int endRow) { Map<Integer, MergeEntity> mergeDataMap = new HashMap<Integer, MergeEntity>(); if (mergeMap.size() == 0) { return; } Row row; Set<Integer> sets = mergeMap.keySet(); String text; for (int i = startRow; i <= endRow; i++) { row = sheet.getRow(i); for (Integer index : sets) { if (row == null || row.getCell(index) == null) { if (mergeDataMap.get(index) == null) { continue; } if (mergeDataMap.get(index).getEndRow() == 0) { mergeDataMap.get(index).setEndRow(i - 1); } } else { text = row.getCell(index).getStringCellValue(); hanlderMergeCells(index, i, text, mergeDataMap, sheet, row.getCell(index), mergeMap.get(index)); } } } // 为合并后的单元格赋值 if (mergeDataMap.size() > 0) { for (Integer index : mergeDataMap.keySet()) { if (mergeDataMap.get(index).getEndRow() > mergeDataMap.get(index).getStartRow()) { sheet.addMergedRegion(new CellRangeAddress(mergeDataMap.get(index).getStartRow(), mergeDataMap.get(index).getEndRow(), index, index)); } } } } public static MergeEntity createMergeEntity(String text, int rowNum, Cell cell, int[] delys) { MergeEntity mergeEntity = new MergeEntity(text, rowNum, rowNum); // 存在依赖关系 if (delys != null && delys.length != 0) { List<String> list = new ArrayList<String>(delys.length); mergeEntity.setRelyList(list); for (int i = 0; i < delys.length; i++) { list.add(getCellNotNullText(cell, delys[i], rowNum)); } } return mergeEntity; } /** * 获取一个单元格的值,确保这个单元格必须有值,不然向上查询 * * @param cell * @param index * @param rowNum * @return */ public static String getCellNotNullText(Cell cell, int index, int rowNum) { if (cell == null || cell.getRow() == null) { return null; } if (cell.getRow().getCell(index) != null && org.apache.commons.lang3.StringUtils.isNotEmpty(cell.getRow().getCell(index).getStringCellValue())) { return cell.getRow().getCell(index).getStringCellValue(); } return getCellNotNullText(cell.getRow().getSheet().getRow(--rowNum).getCell(index), index, rowNum); } /** * 处理合并单元格 * * @param index * @param rowNum * @param text * @param mergeDataMap * @param sheet * @param cell * @param delys */ public static void hanlderMergeCells(Integer index, int rowNum, String text, Map<Integer, MergeEntity> mergeDataMap, Sheet sheet, Cell cell, int[] delys) { if (mergeDataMap.containsKey(index)) { // 检查是否有依赖关系 if (checkIsEqualByCellContents(mergeDataMap.get(index), text, cell, delys, rowNum)) { mergeDataMap.get(index).setEndRow(rowNum); } else { if (mergeDataMap.get(index).getEndRow() > mergeDataMap.get(index).getStartRow()) { sheet.addMergedRegion(new CellRangeAddress(mergeDataMap.get(index).getStartRow(), mergeDataMap.get(index).getEndRow(), index, index)); } mergeDataMap.put(index, createMergeEntity(text, rowNum, cell, delys)); } } else { mergeDataMap.put(index, createMergeEntity(text, rowNum, cell, delys)); } } private static boolean checkIsEqualByCellContents(MergeEntity mergeEntity, String text, Cell cell, int[] delys, int rowNum) { // 没有依赖关系 if (delys == null || delys.length == 0) { return mergeEntity.getText().equals(text); } // 存在依赖关系 测试 if (mergeEntity.getText().equals(text)) { for (int i = 0; i < delys.length; i++) { if (mergeEntity.getRelyList().get(i) == null || !mergeEntity.getRelyList().get(i) .equals(getCellNotNullText(cell, delys[i], rowNum))) { return false; } } return true; } return false; }
此文是对http://easypoi.mydoc.io/ 的注脚,也是为了以后自己查阅方便,现阶段并没有遇到其他类型的导出,故只做于此,待日后补充