R先生一步步教你用EasyExcel导出包含多图片的Excel
光与光之间的黑暗，路人永不得知
书接上文说到，R先生之前有写过一篇用EasyExel导出包含图片的Excel文件，由于在官方文档并没有找到多图片导出的demo，在GitHub也找了找，也有人提到过这个问题，但并没有找到对应的解决方案。
后来发现有同事用POI实现了复杂报表和多图片的功能，说到这个事，后期也间接导致了我使用EasyExcel无法导出的Bug，不过好在R先生已经解决了。
R先生所在的项目组对Excel多图片报表的需求还是挺大的，由于之前在前东家一直用的阿里的EasyExcel，这次也就安常守故吧 （PS：R先生守旧但也知变革）。
你的存在，是夜风遁走的回声
依照惯例还是首先添加Maven依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>${easyexcel.version}</version>
</dependency>
这里使用了版本的集中管理，R先生使用的版本是
<easyexcel.version>2.2.7</easyexcel.version>
依然还是EasyExcel数据模型实体类，此处省略业务查询与处理，重点关注如何将单个图片修改为多图片。
/**
* 重点在这里！！！！！！！！！！！！！
*/
@ExcelProperty(value = "报告",converter = ListUrlConverterUtil.class)
@ColumnWidth(60)
private List<URL> excelUrlList;
/**
* 单张图片导出参照官方文档使用URL类型导出
*/
private URL excelUrl;
上图代码可以看到，多图片导出使用了自定义类型转换，啥也不说了，看我一步步操作吧。
/**
* @Description: easyecxel多图片导出到单元格转换工具类
* @Author GreenArrow
* @Date: 2021/7/7 15:56
* @Version 1.0
*/
public class ListUrlConverterUtil implements Converter<List<URL>> {
@Override
public Class supportJavaTypeKey() {
return List.class;
}
@Override
public CellDataTypeEnum supportExcelTypeKey() {
/**
*这里记得枚举类型为IMAGE
*/
return CellDataTypeEnum.IMAGE;
}
@Override
public List convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
return null;
}
@Override
public CellData convertToExcelData(List<URL> value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) throws Exception {
// 这里进行对数据实体类URL集合处理
List<CellData> data = new ArrayList<>();
for (URL url : value) {
InputStream inputStream = null;
try {
inputStream = url.openStream();
byte[] bytes = IoUtils.toByteArray(inputStream);
data.add(new CellData(bytes));
} finally {
if (inputStream != null){
inputStream.close();
}
}
}
CellData cellData = new CellData(data);
cellData.setType(CellDataTypeEnum.IMAGE);
return cellData;
}
}
你以为到这里就结束了吗？然而并不能，我发现这个 convertToExcelData的实现方法,返回值是一个CellData,它并不能识别并返回一个List对象,实际上我们看CellWriteHandler接口的实现方法afterCellDispose中,是有一个参数是List cellDataList， 官方问题处理样例上给的注释是 :
// cellDataList 是list的原因是 填充的情况下 可能会多个写到一个单元格 但是如果普通写入 一定只有一个
这种方式并不能返回一个List,所以只好通过CellData cellData = new CellData(data);将这个list对象塞到返回值CellData对象的data属性中；
人生百态，犹如四海归帆
由于图片大小不一，为了调整图片大小位置我们,一般会实现CellWriteHandler 的afterCellDataConverted 方法，将 CellData 的 type 设置成 EMPTY ,这样 EasyExcel 不会帮忙填充该单元格的数据，然后实现 CellWriteHandler 的 afterCellDispose 方法，将将图片信息填充上去。
/**
* @Description: 图片信息修改拦截器
* @Author GreenArrow
* @Date: 2021/7/7 16:05
* @Version 1.0
*/
public class CustomImageModifyHandler implements CellWriteHandler {
private List<String> repeats = new ArrayList<>();
@Override
public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) {
}
@Override
public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
}
@Override
public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, CellData cellData, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
// 在 数据转换成功后 不是头就把类型设置成空
if (isHead) {
return;
}
//将要插入图片的单元格的type设置为空,下面再填充图片
if(cellData.getImageValue()!=null||cellData.getData() instanceof ArrayList){
cellData.setType(CellDataTypeEnum.EMPTY);
}
}
@Override
public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<CellData> cellDataList, Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) {
// 在 单元格写入完毕后 ，自己填充图片
if (isHead || CollectionUtils.isEmpty(cellDataList)) {
return;
}
Boolean listFlag = false;
ArrayList data = null;
Sheet sheet = cell.getSheet();
// 此处为ListUrlConverterUtil的返回值
if (cellDataList.get(0).getData() instanceof ArrayList){
data = (ArrayList) cellDataList.get(0).getData();
if (data.get(0) instanceof CellData){
CellData cellData = (CellData) data.get(0);
if (cellData.getImageValue() == null){
return;
}else {
listFlag = true;
}
}
}
if (!listFlag && cellDataList.get(0).getImageValue() == null){
return;
}
String key = cell.getRowIndex() + "_" + cell.getColumnIndex();
if (repeats.contains(key)){
return;
}
repeats.add(key);
// 默认要导出的图片大小为60*60px,60px的行高大约是900,60px列宽大概是248*8
sheet.getRow(cell.getRowIndex()).setHeight((short)900);
sheet.setColumnWidth(cell.getColumnIndex(),listFlag?240*8*data.size():240*8);
if (listFlag){
for (int i = 0; i < data.size(); i++) {
CellData cellData= (CellData) data.get(i);
if(cellData.getImageValue()==null){
continue;
}
this.insertImage(sheet,cell,cellData.getImageValue(),i);
}
}else {
// cellDataList 是list的原因是 填充的情况下 可能会多个写到一个单元格 但是如果普通写入 一定只有一个
this.insertImage(sheet,cell,cellDataList.get(0).getImageValue(),0);
}
}
private void insertImage(Sheet sheet,Cell cell,byte[] pictureData,int i){
int picWidth = Units.pixelToEMU(60);
int index = sheet.getWorkbook().addPicture(pictureData, HSSFWorkbook.PICTURE_TYPE_PNG);
Drawing drawing = sheet.getDrawingPatriarch();
if (drawing == null) {
drawing = sheet.createDrawingPatriarch();
}
CreationHelper helper = sheet.getWorkbook().getCreationHelper();
ClientAnchor anchor = helper.createClientAnchor();
// 设置图片坐标
anchor.setDx1(picWidth*i);
anchor.setDx2(picWidth+picWidth*i);
anchor.setDy1(0);
anchor.setDy2(0);
//设置图片位置
anchor.setCol1(cell.getColumnIndex());
anchor.setCol2(cell.getColumnIndex());
anchor.setRow1(cell.getRowIndex());
anchor.setRow2(cell.getRowIndex() + 1);
// 设置图片可以随着单元格移动
anchor.setAnchorType(ClientAnchor.AnchorType.MOVE_AND_RESIZE);
drawing.createPicture(anchor, index);
}
}
自古路远马亡，殊途同归
EasyExcel.write(outputStream, Excel数据实体类.class)
.registerWriteHandler(new CustomImageModifyHandler()).sheet().doWrite(查询出来并且完成数据转换的Excel数据集合);
注意上面的代码，有很重要的一步，registerWriteHandler(new CustomImageModifyHandler())，需要将自己写的拦截器注册进去，到这里基本上就是真正完成了。
沉默与黑暗
接下来，就是见证成果的时刻了，直接上截图吧。
v1.1.0版本：
v1.0.0版本：
结束语
一些我们不忍目睹的事情，并不会因为我们的不堪而延迟了脚步。我们需要遗忘并且继续生活下去，尽管我知道这样的过程对于你来说将会是惨烈无比的。 懂的人自然会懂。
