POI动态导出多层表头的EXCEL文件

表格表头导出
- 单行表头
- 多行表头

以前接触过一个很古老的导出Excel，实现的逻辑是先声明一个导出的Excel模板，模板里报表的表头名称和顺序是固定的，这样执行导出时，系统是先读取手动创建的Excel模板文件，然后就往里面set查询结果值，最近因需要，写了一个可以根据表头信息自动导出Excel报表文件的方法，思路是把表头信息和表格数据进行分开2次写入，接下来分开讲解下思路，并贴上部分代码供大家参考。

首先，因为这种导出函数是可复用的，根据也无需要会导出不同的excel文件，里面数据不同，所以我们不能先声明Excel模板，只能通过POI里的Workbook类动态新建空白的excel模板，至于workbook具体的实现类，就要看你想导出03 还是07版excel了。

表格表头导出

单行表头

单行表头导出直接把获取的表头信息按照顺序输出就可以了，这里就不做特殊说明了。

多行表头

重点来了，多行表头动态导出难点是表头的行合并和列合并，这个能通过递归分析出来，分析出表头的行合并和列合并信息后就可以根据这些信息推导出每个表头信息在excel表格中所在的坐标以及单元格合并样式，剩下的就是根据这些信息进行写入workbook了。
下面是我的代码实现，只截取了部分仅供参考：
1.声明excel表格节点类和表头标题类

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;import java.io.Serializable;/*** 导出表头节点信息* @author wr*/
@Setter
@Getter
@ToString
public class HeaderNodeVo implements Serializable {private static final long serialVersionUID = 6243427059921159767L;/*** 行号*/private Integer rowStart;/*** 行号*/private Integer rowEnd;/*** 列号*/private Integer colStart;/*** 列号*/private Integer colEnd;/*** 层级*/private Integer level;/*** 标题名称*/private String name;/*** 对应的字段别名*/private String prop;/*** 节点ID*/private String id;/*** 节点父ID*/private String parentId;/*** 子节点数量*/private Integer sonNum;
}public class TargetTitleVo {/*** 指标ID列表*/private List<String> targetIds;/*** 标题ID*/private String titleId;/*** 标题*/private String value;/*** 对应数据集的字段名称* 最后一级标题以外为空*/private String prop;/*** 排序*/private Integer sort;/*** 子标题*/private List<TargetTitleVo> children;/*** 上级titleId*/private String parentId;/*** 该标题下叶子总数*/private int nodeCount;
}

2.获取表头字段名信息（这里要根据你们本地工程动态调整）

List<TargetTitleVo> titleVos = reportDataDao.getTitles();

3.初始化标题信息并组装HeaderNodeVo 类基本信息

/***  初始化标题信息* @param titleVos  标题vo集合* @param list   表头层级集合* @param level 表头开始层级号* @param nodes 表头节点集合*/private void initTitleInfo(List<TargetTitleVo> titleVos, List<Integer> list, Integer level, List<HeaderNodeVo> nodes){if(!CollectionUtils.isEmpty(titleVos)){//nofor(TargetTitleVo vo : titleVos){list.add(level);//初始化节点HeaderNodeVo node = this.initNode(vo, level);nodes.add(node);if(hasChild(vo)){//含有子项initTitleInfo(vo.getChildren(),list,level+1,nodes);}}}}/*** 判断标题是否有子项* @param vo    维度标题vo* @return  boolean*/private boolean hasChild(TargetTitleVo vo){boolean result = false;if(vo!=null){List<TargetTitleVo> children = vo.getChildren();if(children!=null &&children.size() >0){result = true;}}return result;}/*** 初始化节点* @param vo    指标vo* @param level 表头层数* @return  表头节点*/private HeaderNodeVo initNode(TargetTitleVo vo, Integer level){HeaderNodeVo result = new HeaderNodeVo();//节点idresult.setId(vo.getTitleId());//节点名称result.setName(vo.getValue());//父节点idresult.setParentId(vo.getParentId());//层级result.setLevel(level);//含有子项int sonNum = 0;//需要考虑多层表头，另处理if (hasChild(vo)){sonNum = vo.getChildren().size();}result.setSonNum(sonNum);String prop = vo.getProp();if(prop!=null&&!"".equals(prop)){result.setProp(prop);}return result;}

4.获取表头最大行数

/*** 获取表头行数* @param params    表头行数集合* @return  表头行数*/private Integer getMaxLevel(List<Integer> params){Integer result = 0;for(Integer param :params){if(param>result){result = param;}}return result;}

5.分析所有的表头节点，并将节点装配成Map<id,node>

/*** 装配 节点Id-节点 键值对* @param nodes 表头节点集合* @return  节点Id-节点 键值对*/private Map<String,HeaderNodeVo> assembleIdMap(List<HeaderNodeVo> nodes){Map<String,HeaderNodeVo> map = new HashMap<>(nodes.size());if(!CollectionUtils.isEmpty(nodes)){for(HeaderNodeVo node:nodes){if(node.getId()!=null){map.put(node.getId(),node);}}}return map;}

6.分析所有的表头节点，并保存成Map<父id，Set<子节点>>

/*** 装配 父节点ID-节点 键值对* @param nodes 表头节点集合* @return 父节点ID-节点 键值对*/private Map<String,List<HeaderNodeVo>> assemblePidMap(List<HeaderNodeVo> nodes){Map<String,List<HeaderNodeVo>> result = new HashMap<>(nodes.size());String parentId;List<HeaderNodeVo> ids;for(HeaderNodeVo node:nodes){parentId = node.getParentId();if(parentId != null){ids = result.get(parentId);if(ids==null){ids = new ArrayList<>();ids.add(node);result.put(parentId,ids);}else{ids.add(node);}}}return result;}

7.递归遍历分析所有的头节点，分析出每一个头节点含有的最下层节点个数

/*** 设置表头节点含有的子孙项数量* @param nodes 表头节点vo* @param pMap  父节点ID-节点 键值对*/private void setNodeSonNum(List<HeaderNodeVo> nodes,Map<String,List<HeaderNodeVo>> pMap){if(!CollectionUtils.isEmpty(nodes)){//not nullInteger sonNum;for(HeaderNodeVo node:nodes){if(node!=null&&node.getSonNum()>0){//含有子项需要遍历子项含有的孙项sonNum = recNode(node,pMap);node.setSonNum(sonNum);}//没有子项，退出}}}/*** 遍历表头节点信息* @param node  表头节点vo* @param pMap  父节点ID-节点 键值对* @return  含有的子孙项*/private Integer recNode(HeaderNodeVo node, Map<String,List<HeaderNodeVo>> pMap){int result = 0;if(node.getSonNum()==0){return 1;}else{if(pMap.get(node.getId())!=null && pMap.get(node.getId()).size()>0){for(HeaderNodeVo sNode:pMap.get(node.getId())){//子项result = result + recNode(sNode,pMap);}}else{return 0;}}return result;}

8.遍历所有的表头节点，将节点按照层级分开（与下一个步骤是同一个函数处理）

 /*** 初始化节点合并信息* @param nodes 表头节点集合* @param level 表头总行数* @param idMap 节点id-节点键值对*/private void initPositionData(List<HeaderNodeVo> nodes, Integer level, Map<String,HeaderNodeVo> idMap){//解析所有节点，定义位置信息//key 为层级，从1开始， List里node是有顺序的Map<Integer,List<HeaderNodeVo>> levelMap = new HashMap<>(level);Integer selLevel;List<HeaderNodeVo> levelList;if(!CollectionUtils.isEmpty(nodes)){for(HeaderNodeVo node:nodes){selLevel = node.getLevel();levelList = levelMap.get(selLevel);if(levelList==null){//nulllevelList = new ArrayList<>();levelList.add(node);levelMap.put(selLevel,levelList);}else{//not nulllevelList.add(node);}}}}

9.按照分好的层级和含有的所有子项分析出在excel中的坐标与合并单元格个数（与上一个步骤是同一个函数处理）

 //按照层级来遍历节点，组装合并节点信息List<HeaderNodeVo> selNodes;HeaderNodeVo selNode;HeaderNodeVo pNode;Integer rowStart = null;int rowEnd;Integer colStart = null;int colEnd;Integer sonNum;int lastColStart;Integer pColStart;for(int i=1;i<=level;i++){//一层所有的节点selNodes = levelMap.get(i);if(i==1){for(int j=0;j<selNodes.size();j++){//第一层第一个节点从 行2,列0开始if(j==0){rowStart = 2;colStart = 0;}selNode = selNodes.get(j);//含有的子项sonNum = selNode.getSonNum();if(sonNum>0){colEnd = colStart + sonNum - 1;rowEnd = 2;}else{colEnd = colStart;if(level==1){rowEnd = 2;}else{rowEnd = 2+level-1;}}setPosition(selNode,rowStart,rowEnd,colStart,colEnd);//再初始化下个节点的开始行列rowStart = 2;colStart = colEnd + 1;}}else{//非第一列lastColStart = 0;for (HeaderNodeVo node : selNodes) {//从节点的父节点往下一列开始selNode = node;pNode = idMap.get(selNode.getParentId());rowStart = pNode.getRowStart() + 1;pColStart = pNode.getColStart();if (lastColStart >= pColStart) {colStart = lastColStart;} else {colStart = pColStart;}//含有的子项sonNum = selNode.getSonNum();if (sonNum > 0) {colEnd = colStart + sonNum - 1;rowEnd = 2 + i - 1;} else {colEnd = colStart;rowEnd = 2 + level - 1;}setPosition(selNode, rowStart, rowEnd, colStart, colEnd);//再初始化下个节点的开始行列lastColStart = colEnd + 1;}}}/*** 设置节点合并单元格信息* @param node  表头节点Vo* @param rowStart  开始行号* @param rowEnd    结束行号* @param colStart  开始列号* @param colEnd    结束列号*/private void setPosition(HeaderNodeVo node, Integer rowStart, Integer rowEnd, Integer colStart, Integer colEnd){if(node !=null){node.setRowStart(rowStart);node.setRowEnd(rowEnd);node.setColStart(colStart);node.setColEnd(colEnd);}}

10最终组合在一起

/***  新增导出功能** @param vo 查询信息* @return 报表数据* @throws Exception 异常处理*/@Overridepublic Workbook exportReport(ReportDetailVo vo) throws Exception {long start = System.currentTimeMillis();log.info("[exportReport] - start.");Workbook wk;// 校验AssertUtil.voNotNull(vo);//将导出分成3类ReportType reportType = ReportType.getType(vo.getReportType());ReportDataVo reportDataVo;if(ReportType.TABLE.equals(reportType)){//报表//结果数据reportDataVo = reportQueryService.getReportData(vo);//报表名称String reportName = vo.getReportName();//表头字段名List<TargetTitleVo> titleVos = reportDataVo.getTitles();String[] titles = this.getTitles(titleVos);//表头总行数Integer rowCount;//表中数据List<Map<String, String>> list = reportDataVo.getPageResult().getList();//=============================================start=========================================List<Integer> levelList = new ArrayList<>();//处理完的节点信息List<HeaderNodeVo> nodes = new ArrayList<>();//获取最大levelinitTitleInfo(titleVos, levelList, 1, nodes);//总行数rowCount = getMaxLevel(levelList);Map<String,HeaderNodeVo> idMap = assembleIdMap(nodes);//遍历节点获取所有父节点含有的下一级节点数量   key:parentId   value:下一级子节点个数Map<String,List<HeaderNodeVo>> pMap = assemblePidMap(nodes);//遍历节点获取所有节点含有的子项,从下往上统计每个节点含有的子项（到最底层）,所有的节点含有所有子孙项个数已统计setNodeSonNum(nodes,pMap);//level 层级数//nodes 所有的节点数//idMap id-节点//sMap  子id-父节点//准备定义合并坐标initPositionData(nodes, rowCount, idMap);Map<String,String> proTypes = this.getProType(titleVos);//=============================================end=========================================//对查询结果进行解析导出到Excelif(rowCount==1){//单行报表导出List<String> pros = this.getPros(titleVos);wk = ExportBetterUtil.exportReport(reportName,titles,pros,list,proTypes);}else{//多行表头导出//重新组装pros属性信息，注意顺序信息List<String> pros = this.getLevelPros(nodes);wk = ExportBetterUtil.exportReportByNode(reportName,nodes,pros,list,rowCount,proTypes);}//准备输出流}else if(ReportType.XX.equals(reportType)){return null;}else{return null;}log.info("[exportReport_] - end. vo: {}, TickCount：{} ms", vo, (System.currentTimeMillis() - start));return wk;}

结语：
第一次写博客，思路有点混乱望大家见谅，以上是怎么分析导出excel多行表头的思路，希望对大家有点帮助，最后有个题外话如果大家要导出和读取的excel文件很大，数据量很多，workbook实现类可以用SXSSFWorkbook 去做读写，阿里巴巴的easyExcel也可以，可以防止OOM，最后给大家拜个早年。

补充：
1. hasChild(vo)，setPosition() 2个函数已添加。
2. ExportBetterUtil.java 导出工具类放在百度网盘了（C站的下载链接还在审核），可以手动下载，该文件可能与上面的代码版本不一致，你们可以自己手动修改下，

链接：https://pan.baidu.com/s/1KwKd9RDGQkcbJpEfjYVtNA
提取码：ukfj