devbox
花生_TL007
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

poi-tl导出word, 含表格单元格合并,表格单元格多图合并_poi-tl合并单元格

作者：花生_TL007 | 2024-05-22 06:06:48

赞

踩

poi-tl合并单元格

poi-tl是干嘛的?

poi-tl（poi template language）是Word模板引擎，使用Word模板和数据创建很棒的Word文档,

支持:

        1.单系列图表指的是饼图（3D饼图）、圆环图等。

        2.多系列图表指的是条形图（3D条形图）、柱形图（3D柱形图）、面积图（3D面积图）、折线图（3D折线图）、雷达图、散点图等。

        3.组合图表指的是由多系列图表（柱形图、折线图、面积图）组合而成的图表。

等等...

官网地址:Poi-tl Documentation

展示

一、效果展示

二、模板

 三、使用步骤

1.引包

该案例使用poi-tl版本: 1.12.0

  1. <dependency>
  2.     <groupId>com.deepoove</groupId>
  3.     <artifactId>poi-tl</artifactId>
  4.     <version>1.12.0</version>
  5. </dependency>

该案例引入的包

  1.     <dependencies>
  2.         <dependency>
  3.             <groupId>com.deepoove</groupId>
  4.             <artifactId>poi-tl</artifactId>
  5.             <version>1.12.0</version>
  6.         </dependency>
  7.         <dependency>
  8.             <groupId>org.projectlombok</groupId>
  9.             <artifactId>lombok</artifactId>
  10.             <version>1.18.24</version>
  11.         </dependency>
  12.  
  13.         <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
  14.         <dependency>
  15.             <groupId>org.apache.logging.log4j</groupId>
  16.             <artifactId>log4j-core</artifactId>
  17.             <version>2.17.1</version>
  18.         </dependency>
  19.  
  20.         <dependency>
  21.             <groupId>org.slf4j</groupId>
  22.             <artifactId>slf4j-nop</artifactId>
  23.             <version>1.7.2</version>
  24.             <type>jar</type>
  25.         </dependency>
  26.         <dependency>
  27.             <groupId>com.alibaba</groupId>
  28.             <artifactId>fastjson</artifactId>
  29.             <version>1.2.28</version>
  30.         </dependency>
  31.         <dependency>
  32.             <groupId>org.springframework.boot</groupId>
  33.             <artifactId>spring-boot-starter-web</artifactId>
  34.             <version>2.3.12.RELEASE</version>
  35.         </dependency>
  36.     </dependencies>

2.代码

ServerTablePolicy:主要处理合并数据表格工具类

MergeRowsRenderPolicy:含图片表格合并工具类

MultiImageRenderPolicy:注册添加前缀为'&'的自定义插件：

2.1.ServerTablePolicy:主要处理合并数据表格工具类

  1. public class ServerTablePolicy extends DynamicTableRenderPolicy {
  2.     @Override
  3.     public void render(XWPFTable xwpfTable, Object tableData) throws Exception {
  4.         if (null == tableData) {
  5.             return;
  6.         }
  7.  
  8.         // 参数数据声明
  9.         ServerTableData serverTableData = (ServerTableData) tableData;
  10.         List<RowRenderData> serverDataList = serverTableData.getServerDataList();
  11.         List<Map<String, Object>> groupDataList = serverTableData.getGroupDataList();
  12.         Integer mergeColumn = serverTableData.getMergeColumn();
  13.  
  14.         if (CollectionUtils.isNotEmpty(serverDataList)) {
  15.             // 先删除一行, demo中第一行是为了调整 三线表 样式
  16.             xwpfTable.removeRow(1);
  17.  
  18.             // 行从中间插入, 因此采用倒序渲染数据
  19.             for (int i = serverDataList.size() - 1; i >= 0; i--) {
  20.                 XWPFTableRow newRow = xwpfTable.insertNewTableRow(1);
  21.                 newRow.setHeight(400);
  22.                 //每一行填充多少个单元格
  23.                 for (int j = 0; j < serverDataList.get(0).getCells().size(); j++) {
  24.                     newRow.createCell();
  25.                 }
  26.                 // 渲染一行数据
  27.                 TableRenderPolicy.Helper.renderRow(newRow, serverDataList.get(i));
  28.             }
  29.  
  30.  
  31.             // 处理合并
  32.             for (int i = 0; i < serverDataList.size(); i++) {
  33.                 // 获取要合并的名称那一列数据 mergeColumn代表要合并的列，从0开始
  34.                 String typeNameData = serverDataList.get(i).getCells().get(mergeColumn).getParagraphs().get(0).getContents().get(0).toString();
  35.                 for (int j = 0; j < groupDataList.size(); j++) {
  36.                     String typeNameTemplate = String.valueOf(groupDataList.get(j).get("typeName"));
  37.                     int listSize = Integer.parseInt(String.valueOf(groupDataList.get(j).get("listSize")));
  38.                     //如果只有一条数据不进行合并处理
  39.                     if (listSize!=1) {
  40.                         // 若匹配上 就直接合并
  41.                         if (typeNameTemplate.equals(typeNameData)) {
  42.                             //如果合并列不为空直接合并,否则提示输入要合并的列
  43.                             if (CollectionUtils.isNotEmpty(serverTableData.getMergeColumnList())) {
  44.                                 for (Integer mergeColumns : serverTableData.getMergeColumnList()) {
  45.                                     TableTools.mergeCellsVertically(xwpfTable, mergeColumns, i + 1, i + listSize);
  46.                                 }
  47.                                 groupDataList.remove(j);
  48.                                 break;
  49.                             } else {
  50.                                 throw new Exception("要合并列不能为空!");
  51.                             }
  52.                         }
  53.                     }
  54.                 }
  55.             }
  56.         }
  57.     }
  58. }

2.2.MergeRowsRenderPolicy:含图片表格合并工具类

  1. public class MergeRowsRenderPolicy implements RenderPolicy {
  2.  
  3.     private final String prefix;
  4.     private final String suffix;
  5.     private final boolean onSameLine;
  6.  
  7.     public MergeRowsRenderPolicy() {
  8.         this(false);
  9.     }
  10.  
  11.     public MergeRowsRenderPolicy(boolean onSameLine) {
  12.         this("[", "]", onSameLine);
  13.     }
  14.  
  15.     public MergeRowsRenderPolicy(String prefix, String suffix) {
  16.         this(prefix, suffix, false);
  17.     }
  18.  
  19.     public MergeRowsRenderPolicy(String prefix, String suffix, boolean onSameLine) {
  20.         this.prefix = prefix;
  21.         this.suffix = suffix;
  22.         this.onSameLine = onSameLine;
  23.     }
  24.  
  25.     @Override
  26.     public void render(ElementTemplate eleTemplate, Object data, XWPFTemplate template) {
  27.         RunTemplate runTemplate = (RunTemplate) eleTemplate;
  28.         XWPFRun run = runTemplate.getRun();
  29.         try {
  30.             if (!TableTools.isInsideTable(run)) {
  31.                 throw new IllegalStateException(
  32.                         "The template tag " + runTemplate.getSource() + " must be inside a table");
  33.             }
  34.             XWPFTableCell tagCell = (XWPFTableCell) ((XWPFParagraph) run.getParent()).getBody();
  35.             XWPFTable table = tagCell.getTableRow().getTable();
  36.             run.setText("", 0);
  37.  
  38.             int templateRowIndex = getTemplateRowIndex(tagCell);
  39.             if (data instanceof Iterable) {
  40.                 Iterator<?> iterator = ((Iterable<?>) data).iterator();
  41.                 XWPFTableRow templateRow = table.getRow(templateRowIndex);
  42.                 int insertPosition = templateRowIndex;
  43.  
  44.                 TemplateResolver resolver = new TemplateResolver(template.getConfig().copy(prefix, suffix));
  45.                 boolean firstFlag = true;
  46.                 int index = 0;
  47.                 boolean hasNext = iterator.hasNext();
  48.                 while (hasNext) {
  49.                     Object root = iterator.next();
  50.                     hasNext = iterator.hasNext();
  51.  
  52.                     insertPosition = templateRowIndex++;
  53.                     table.insertNewTableRow(insertPosition);
  54.                     setTableRow(table, templateRow, insertPosition);
  55.  
  56.                     // double set row
  57.                     XmlCursor newCursor = templateRow.getCtRow().newCursor();
  58.                     newCursor.toPrevSibling();
  59.                     XmlObject object = newCursor.getObject();
  60.                     XWPFTableRow nextRow = new XWPFTableRow((CTRow) object, table);
  61.                     if (!firstFlag) {
  62.                         // update VMerge cells for non-first row
  63.                         List<XWPFTableCell> tableCells = nextRow.getTableCells();
  64.                         for (XWPFTableCell cell : tableCells) {
  65.                             CTTcPr tcPr = TableTools.getTcPr(cell);
  66.                             CTVMerge vMerge = tcPr.getVMerge();
  67.                             if (null == vMerge) {continue;}
  68.                             if (STMerge.RESTART == vMerge.getVal()) {
  69.                                 vMerge.setVal(STMerge.CONTINUE);
  70.                             }
  71.                         }
  72.                     } else {
  73.                         firstFlag = false;
  74.                     }
  75.                     setTableRow(table, nextRow, insertPosition);
  76.  
  77.                     RenderDataCompute dataCompute = template.getConfig()
  78.                             .getRenderDataComputeFactory()
  79.                             .newCompute(EnvModel.of(root, EnvIterator.makeEnv(index++, hasNext)));
  80.                     List<XWPFTableCell> cells = nextRow.getTableCells();
  81.                     cells.forEach(cell -> {
  82.                         List<MetaTemplate> templates = resolver.resolveBodyElements(cell.getBodyElements());
  83.                         new DocumentProcessor(template, resolver, dataCompute).process(templates);
  84.                     });
  85.                 }
  86.                 // 处理连续数据相同行合并
  87.                 int currPos = getTemplateRowIndex(tagCell);
  88.                 XWPFTableRow prevRow = table.getRow(currPos);
  89.                 while (currPos <= insertPosition) {
  90.                     currPos++;
  91.                     XWPFTableRow nextRow = table.getRow(currPos);
  92.                     List<XWPFTableCell> cells = nextRow.getTableCells();
  93.                     int currCellPos = 0;
  94.                     while (currCellPos < cells.size()) {
  95.                         CTTcPr tcPrPrev = TableTools.getTcPr(prevRow.getCell(currCellPos));
  96.                         CTVMerge vMergePrev = tcPrPrev.getVMerge();
  97.                         if (null == vMergePrev) {
  98.                             vMergePrev = tcPrPrev.addNewVMerge();
  99.                             vMergePrev.setVal(STMerge.RESTART);
  100.                         }
  101.                         CTTcPr tcPrNext = TableTools.getTcPr(nextRow.getCell(currCellPos));
  102.                         CTVMerge vMergeNext = tcPrNext.getVMerge();
  103.                         if (null == vMergeNext) {
  104.                             vMergeNext = tcPrNext.addNewVMerge();
  105.                             vMergeNext.setVal(STMerge.RESTART);
  106.                         }
  107.                         // 判断上下两行的字符串值是否一样，一样就合并
  108.                         if (StringUtils.equalsIgnoreCase(
  109.                                 prevRow.getCell(currCellPos).getText(),
  110.                                 nextRow.getCell(currCellPos).getText())) {
  111.                             vMergeNext.setVal(STMerge.CONTINUE);
  112.                         }
  113.                         currCellPos++;
  114.                     }
  115.                     prevRow = nextRow;
  116.                 }
  117.  
  118.             }
  119.  
  120.             table.removeRow(templateRowIndex);
  121.             afterloop(table, data);
  122.         } catch (Exception e) {
  123.             throw new RenderException("HackLoopTable for " + eleTemplate + "error: " + e.getMessage(), e);
  124.         }
  125.     }
  126.  
  127.     private int getTemplateRowIndex(XWPFTableCell tagCell) {
  128.         XWPFTableRow tagRow = tagCell.getTableRow();
  129.         return onSameLine ? getRowIndex(tagRow) : (getRowIndex(tagRow) + 1);
  130.     }
  131.  
  132.     protected void afterloop(XWPFTable table, Object data) {
  133.     }
  134.  
  135.     @SuppressWarnings("unchecked")
  136.     private void setTableRow(XWPFTable table, XWPFTableRow templateRow, int pos) {
  137.         List<XWPFTableRow> rows = (List<XWPFTableRow>) ReflectionUtils.getValue("tableRows", table);
  138.         rows.set(pos, templateRow);
  139.         table.getCTTbl().setTrArray(pos, templateRow.getCtRow());
  140.     }
  141.  
  142.     private int getRowIndex(XWPFTableRow row) {
  143.         List<XWPFTableRow> rows = row.getTable().getRows();
  144.         return rows.indexOf(row);
  145.     }
  146. }

2.3.MultiImageRenderPolicy:注册添加前缀为'&'的自定义插件：

  1. public class MultiImageRenderPolicy extends AbstractRenderPolicy<Collection<PictureRenderData>> {
  2.  
  3.     @Override
  4.     protected void afterRender(RenderContext<Collection<PictureRenderData>> context) {
  5.         clearPlaceholder(context, true);
  6.     }
  7.  
  8.     @Override
  9.     public void doRender(RenderContext<Collection<PictureRenderData>> context) throws Exception {
  10.         IRunBody iRunBody = context.getRun().getParent();
  11.         if (iRunBody instanceof XWPFParagraph) {
  12.             XWPFParagraph p = (XWPFParagraph) iRunBody;
  13.             Collection<PictureRenderData> data = context.getData();
  14.             if (CollectionUtils.isNotEmpty(data)) {
  15.                 for (PictureRenderData pic : data) {
  16.                     PictureRenderPolicy.Helper.renderPicture(p.createRun(), pic);
  17.                 }
  18.             }
  19.         }
  20.     }
  21. }

2.4. 数据表格合并实体类

  1. @Data
  2. public class ServerTableData {
  3.  
  4.     /**
  5.      *  携带表格中真实数据
  6.      */
  7.     private List<RowRenderData> serverDataList;
  8.  
  9.     /**
  10.      * 携带要分组的信息
  11.      */
  12.     private List<Map<String, Object>> groupDataList;
  13.  
  14.     /**
  15.      * 需要合并的列，从0开始
  16.      */
  17.     private Integer mergeColumn;
  18.  
  19.     /**
  20.      * 具体要合并的列集合
  21.      */
  22.     private List<Integer> mergeColumnList;
  23. }

四.测试及数据处理

  1. public class WordExport {
  2.  
  3.     public static void main(String[] args) throws IOException {
  4.         // 获取模板文件流
  5.         String filePath = "D:\\poi-tl\\template.docx";
  6.         String targetPath = "D:\\poi-tl\\templateTest.docx";
  7.         String picturePath = "D:\\poi-tl\\1_1.jpg";
  8.         String picturePaths="D:\\poi-tl\\1_1.jpg,D:\\poi-tl\\2_2.jpg,D:\\poi-tl\\3_3.jpg,D:\\poi-tl\\4_4.jpg";
  9.         String httpPicturePath = "http://deepoove.com/images/icecream.png";
  10.         String httpPicturePaths = "http://deepoove.com/images/icecream.png,http://deepoove.com/images/icecream.png";
  11.  
  12.         //单个图片数据模板
  13.         PictureRenderData picture = Pictures.ofStream(new FileInputStream(picturePath), PictureType.JPEG)
  14.                 .size(400, 300).create();
  15.  
  16.         //多张图片数据模板
  17.  
  18.         ArrayList<JSONObject> pictures = new ArrayList<JSONObject>() {
  19.             {
  20.                 add(new JSONObject().fluentPut("url",picturePath));
  21.                 add(new JSONObject().fluentPut("url", httpPicturePath));
  22.             }
  23.         };
  24.  
  25.         //多张图片处理
  26.         List<Map<String, Object>> pictureList = new ArrayList(){{
  27.             for (int i = 0; i < 2; i++) {
  28.                 add(new HashMap<String,Object>(){{
  29.                     put("url", Pictures.ofStream(new FileInputStream(picturePath), PictureType.JPEG)
  30.                             .size(220,150).create());
  31.                 }});
  32.             }}};
  33.  
  34.         //如果表格内不需要合并数据直接put("",new ArrayList<string,object>/new ArrayList<实体类>)
  35.  
  36.         //单元格多图片
  37.         ArrayList<JSONObject> arrayList = getArrayList(picturePaths,httpPicturePaths);
  38.  
  39.         // 伪造一个表格数据
  40.         //具体要合并的列
  41.         List<Integer> mergeColumnList = Arrays.asList(0,3);
  42.         ServerTableData oneTable = getServerTableData(mergeColumnList);
  43.  
  44.         //表格绑定
  45.         Configure config = Configure.builder()
  46.                 //注册添加前缀为'&'的自定义插件：
  47.                 .addPlugin('&', new MultiImageRenderPolicy())
  48.                 //含图片数据表格合并同列相邻的单元格
  49.                 .bind("items", new MergeRowsRenderPolicy())
  50.                 //数据表格可指定合并列
  51.                 .bind("oneTable",new ServerTablePolicy())
  52.                 .build();
  53.  
  54.         XWPFTemplate template = XWPFTemplate.compile(filePath, config).render(
  55.                 new HashMap<String, Object>(){{
  56.                     //单张图片
  57.                     put("image", picture);
  58.                     //单张图片描述
  59.                     put("imageDesc","这是图片描述");
  60.                     //多张图片1
  61.                     put("pictures", pictures);
  62.                     //多张图片2
  63.                     put("pictureList", pictureList);
  64.                     //合并表格
  65.                     put("oneTable",oneTable);
  66.                     //单元格多个图片
  67.                     put("items", arrayList);
  68.  
  69.  
  70.                 }});
  71.  
  72.         //输出网络流 本地导出
  73.         template.writeAndClose(new FileOutputStream(targetPath));
  74.  
  75.         //网络导出
  76.         //exportFile(filePath,hashMap,config);
  77.     }
  78.  
  79.     /**
  80.      *  表格合并数据处理
  81.      * @param mergeColumnList 要合并的列集合
  82.      * @return 数据集合
  83.      */
  84.     private static ServerTableData getServerTableData(List<Integer> mergeColumnList) {
  85.         ServerTableData serverTableData = new ServerTableData();
  86.         List<RowRenderData> serverDataList = new ArrayList<>();
  87.         for (int j = 0; j < 5; j++) {
  88.             String typeName;
  89.             if (j > 1) {
  90.                 typeName = "张三";
  91.                 serverDataList.add(Rows.of(typeName, "男", "3", "喝酒").center().create());
  92.             }else {
  93.                 typeName = "李四";
  94.                 serverDataList.add(Rows.of(typeName, "女", "4", "逛街").center().create());
  95.             }
  96.         }
  97.  
  98.         List<Map<String, Object>> groupDataList = new ArrayList<>();
  99.         Map<String, Object> groupData1 = new HashMap<>();
  100.         //typeName是张三的数据有两条
  101.         groupData1.put("typeName", "张三");
  102.         groupData1.put("listSize", "3");
  103.         Map<String, Object> groupData2 = new HashMap<>();
  104.         //typeName是李四的数据有三条
  105.         groupData2.put("typeName", "李四");
  106.         groupData2.put("listSize", "2");
  107.         groupDataList.add(groupData1);
  108.         groupDataList.add(groupData2);
  109.  
  110.         //具体合并的列
  111.         serverTableData.setMergeColumnList(mergeColumnList);
  112.         //表格中数据
  113.         serverTableData.setServerDataList(serverDataList);
  114.         //分组的信息
  115.         serverTableData.setGroupDataList(groupDataList);
  116.         //从哪列开始合并
  117.         serverTableData.setMergeColumn(0);
  118.         return serverTableData;
  119.     }
  120.  
  121.     /**
  122.      * 含图片表格数据处理, 可单独抽成工具类,官网支持多种不同图片处理
  123.      * @param picturePaths java图片路径
  124.      * @param httpPicturePaths 网络图片路径
  125.      * @return 数据集合
  126.      * @throws IOException 抛出io流异常
  127.      */
  128.     public static ArrayList<JSONObject> getArrayList(String picturePaths,String httpPicturePaths) throws IOException {
  129.  
  130.         String[] picturePathArr = picturePaths.split(",");
  131.         String[] httpPicturePathArr = httpPicturePaths.split(",");
  132.  
  133.         word模板中使用 {{&images}}来插入多张图片了
  134.         ArrayList<JSONObject> arrayList = new ArrayList<JSONObject>() {{
  135.             //网络图片
  136.             add(new JSONObject().fluentPut("title", "第一组图片")
  137.                     .fluentPut("detail", "这是第1.1组图片描述")
  138.                     .fluentPut("images", new ArrayList<PictureRenderData>() {{
  139.                         for (String httpPicturePath : httpPicturePathArr) {
  140.                             add(Pictures.ofUrl(httpPicturePath).create());
  141.                         }
  142.                     }}));
  143.             //网络图片
  144.             add(new JSONObject().fluentPut("title", "第一组图片")
  145.                     .fluentPut("detail", "这是第1.2组图片描述")
  146.                     .fluentPut("images", new ArrayList<PictureRenderData>() {{
  147.                         for (String httpPicturePath : httpPicturePathArr) {
  148.                             add(Pictures.ofUrl(httpPicturePath).create());
  149.                         }
  150.                     }}));
  151.  
  152.             // java图片
  153.             add(new JSONObject().fluentPut("title", "第二组图片")
  154.                     .fluentPut("detail", "这是第2.1组图片描述")
  155.                     .fluentPut("images", new ArrayList<PictureRenderData>() {{
  156.                         for (String picturePath : picturePathArr) {
  157.                             BufferedImage bufferedImage = ImageIO.read(new FileInputStream(picturePath));
  158.                             add(Pictures.ofBufferedImage(bufferedImage, PictureType.PNG)
  159.                                     .size(205, 205).create());
  160.                         }
  161.                     }}));
  162.         }};
  163.         return arrayList;
  164.     }
  165.  
  166.     /**
  167.      * 浏览器导出
  168.      * @param fileName 文件名称
  169.      * @param map 数据集合
  170.      * @param configure 配置信息
  171.      */
  172.     public static void exportFile(String fileName, Map<String, Object> map,Configure configure) {
  173.         try {
  174.  
  175.             ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  176.             HttpServletResponse response = attributes.getResponse();
  177.  
  178.             // 获取Word模板，模板存放路径在项目的resources目录下
  179.             //PoiController就是方法所在的类
  180.             XWPFTemplate template = XWPFTemplate.compile(fileName,configure).render(map);
  181.  
  182.             //处理文件名乱码
  183.             String attachName = new String(("测试.docx").getBytes(), "ISO-8859-1");
  184.  
  185.             // 浏览器端下载
  186.             response.setContentType("application/x-download;charset=" + "utf-8");
  187.             response.addHeader("Content-Disposition", "attachment;filename=" + attachName);
  188.  
  189.             OutputStream out = response.getOutputStream();
  190.             BufferedOutputStream bos = new BufferedOutputStream(out);
  191.             template.write(bos);
  192.             bos.flush();
  193.             out.flush();
  194.             PoitlIOUtils.closeQuietlyMulti(template, bos, out);
  195.         } catch (Exception e) {
  196.             e.printStackTrace();
  197.         }
  198.     }
  199.  
  200. }

五.总结

如果出现出现与项目其他技术不兼容,可单独拉出一个服务,但此时涉及到不同服务之间通过feign实现Response传递可参考: https://mp.csdn.net/mp_blog/creation/editor/129615552

针对于未接触的技术,先了解官方文档,然后百度,谷歌,嘎嘎一顿乱造,想要的结果也就差不多了,

有疑问欢迎交流沟通!!!

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/花生_TL007/article/detail/606771
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号