poi word-03-文档模板
2019年2月14日大约 7 分钟
文档模板
有时候我们希望 word 中有一个模板，然后在这个模板的基础上进行生成。
我们可以去解析 word 的基本信息，然后对其中的内容进行替换。
示例代码
maven 导入
org.apache.poi
poi
3.9
org.apache.poi
poi-ooxml
3.7
org.apache.poi
poi-ooxml-schemas
3.9自定义 XWPFDocument
其实就是对基础的 XWPFDocument 进行扩展，支持图片的生成。
这个例子图片是基于 xml 的原理生成的，不是很建议这么做。
/*
* Copyright (c) 2019. houbinbin Inc.
* idoc All rights reserved.
*/
package com.github.houbb.idoc.test.utils;
import java.io.IOException;
import java.io.InputStream;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.xmlbeans.XmlException;
import org.apache.xmlbeans.XmlToken;
import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps;
import org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D;
import org.openxmlformats.schemas.drawingml.x2006.wordprocessingDrawing.CTInline;
/**
* 自定义 XWPFDocument，并重写 createPicture()方法
*/
public class CustomXWPFDocument extends XWPFDocument {
public CustomXWPFDocument(InputStream in) throws IOException {
super(in);
}
public CustomXWPFDocument() {
super();
}
public CustomXWPFDocument(OPCPackage pkg) throws IOException {
super(pkg);
}
/**
* @param id
* @param width 宽
* @param height 高
* @param paragraph 段落
*/
public void createPicture(int id, int width, int height,XWPFParagraph paragraph) {
final int EMU = 9525;
width *= EMU;
height *= EMU;
String blipId = getAllPictures().get(id).getPackageRelationship().getId();
CTInline inline = paragraph.createRun().getCTR().addNewDrawing().addNewInline();
System.out.println(blipId+":"+inline);
String picXml = ""
+ ""
+ " "
+ " "
+ " " + " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " "
+ " " + "";
inline.addNewGraphic().addNewGraphicData();
XmlToken xmlToken = null;
try {
xmlToken = XmlToken.Factory.parse(picXml);
} catch (XmlException xe) {
xe.printStackTrace();
}
inline.set(xmlToken);
inline.setDistT(0);
inline.setDistB(0);
inline.setDistL(0);
inline.setDistR(0);
CTPositiveSize2D extent = inline.addNewExtent();
extent.setCx(width);
extent.setCy(height);
CTNonVisualDrawingProps docPr = inline.addNewDocPr();
docPr.setId(id);
docPr.setName("图片" + id);
docPr.setDescr("测试");
}
}定义 word 模板工具类
对 word 模板的文本，表格中的信息。
如果是 ${XXXX}，则进行替换。
/*
* Copyright (c) 2019. houbinbin Inc.
* idoc All rights reserved.
*/
package com.github.houbb.idoc.test.utils;
import org.apache.poi.POIXMLDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.apache.poi.xwpf.usermodel.XWPFTable;
import org.apache.poi.xwpf.usermodel.XWPFTableCell;
import org.apache.poi.xwpf.usermodel.XWPFTableRow;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTHMerge;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTcPr;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTVMerge;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.STMerge;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
public class WorderToNewWordUtils {
/**
* 根据模板生成word文档
* @param inputUrl 模板路径
* @param textMap 需要替换的文本内容
* @param mapList 需要动态生成的内容
* @return
*/
public static CustomXWPFDocument changWord(String inputUrl, Map textMap, Map mapList) {
CustomXWPFDocument document = null;
try {
//获取docx解析对象
document = new CustomXWPFDocument(POIXMLDocument.openPackage(inputUrl));
//解析替换文本段落对象
WorderToNewWordUtils.changeText(document, textMap);
//解析替换表格对象
WorderToNewWordUtils.changeTable(document, textMap, mapList);
} catch (IOException e) {
e.printStackTrace();
}
return document;
}
/**
* 替换段落文本
* @param document docx解析对象
* @param textMap 需要替换的信息集合
*/
public static void changeText(CustomXWPFDocument document, Map textMap){
//获取段落集合
List paragraphs = document.getParagraphs();
for (XWPFParagraph paragraph : paragraphs) {
//判断此段落时候需要进行替换
String text = paragraph.getText();
System.out.println(text);
if(checkText(text)){
List runs = paragraph.getRuns();
for (XWPFRun run : runs) {
//替换模板原来位置
Object ob = changeValue(run.toString(), textMap);
if (ob instanceof String){
run.setText((String)ob,0);
}
}
}
}
}
/**
* 替换表格对象方法
* @param document docx解析对象
* @param textMap 需要替换的信息集合
* @param mapList 需要动态生成的内容
*/
public static void changeTable(CustomXWPFDocument document, Map textMap,Map mapList){
// document.setTable();
//获取表格对象集合
List tables = document.getTables();
//循环所有需要进行替换的文本，进行替换
for (int i = 0; i rows = table.getRows();
//遍历表格,并替换模板
eachTable(document,rows, textMap);
}
}
List list01 = (List) mapList.get("list01");
List list02 = (List) mapList.get("list02");
//操作word中的表格
for (int i = 0; i indexList = startEnd(list01);
for (int c=0;c rows ,Map textMap){
for (XWPFTableRow row : rows) {
List cells = row.getTableCells();
for (XWPFTableCell cell : cells) {
//判断单元格是否需要替换
if(checkText(cell.getText())){
List paragraphs = cell.getParagraphs();
for (XWPFParagraph paragraph : paragraphs) {
List runs = paragraph.getRuns();
for (XWPFRun run : runs) {
Object ob = changeValue(run.toString(), textMap);
if (ob instanceof String){
run.setText((String)ob,0);
}else if (ob instanceof Map){
run.setText("",0);
Map pic = (Map)ob;
int width = Integer.parseInt(pic.get("width").toString());
int height = Integer.parseInt(pic.get("height").toString());
int picType = getPictureType(pic.get("type").toString());
byte[] byteArray = (byte[]) pic.get("content");
ByteArrayInputStream byteInputStream = new ByteArrayInputStream(byteArray);
try {
int ind = document.addPicture(byteInputStream,picType);
document.createPicture(ind, width , height,paragraph);
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
}
}
}
}
/**
* 为表格插入数据，行数不够添加新行
* @param table 需要插入数据的表格
* @param tableList 第四个表格的插入数据
* @param daList 第二个表格的插入数据
* @param type 表格类型：1-第一个表格 2-第二个表格 3-第三个表格 4-第四个表格
*/
public static void insertTable(XWPFTable table, List tableList,List daList,Integer type){
if (2 == type){
//创建行和创建需要的列
for(int i = 1; i cells = table.getRow(i+1).getTableCells();
for(int j = 0; j cells = row.getTableCells();
cells.get(0).setText(tableList.get(i));
}
}
}
/**
* 判断文本中时候包含$
* @param text 文本
* @return 包含返回true,不包含返回false
*/
public static boolean checkText(String text){
boolean check = false;
if(text.indexOf("$")!= -1){
check = true;
}
return check;
}
/**
* 匹配传入信息集合与模板
* @param value 模板需要替换的区域
* @param textMap 传入信息集合
* @return 模板需要替换区域信息集合对应值
*/
public static Object changeValue(String value, Map textMap){
Set> textSets = textMap.entrySet();
Object valu = "";
for (Entry textSet : textSets) {
//匹配模板与替换值 格式${key}
String key = textSet.getKey();
if(value.indexOf(key)!= -1){
valu = textSet.getValue();
}
}
return valu;
}
/**
* 将输入流中的数据写入字节数组
* @param in
* @return
*/
public static byte[] inputStream2ByteArray(InputStream in,boolean isClose){
byte[] byteArray = null;
try {
int total = in.available();
byteArray = new byte[total];
in.read(byteArray);
} catch (IOException e) {
e.printStackTrace();
}finally{
if(isClose){
try {
in.close();
} catch (Exception e2) {
System.out.println("关闭流失败");
}
}
}
return byteArray;
}
/**
* 根据图片类型，取得对应的图片类型代码
* @param picType
* @return int
*/
private static int getPictureType(String picType){
int res = CustomXWPFDocument.PICTURE_TYPE_PICT;
if(picType != null){
if(picType.equalsIgnoreCase("png")){
res = CustomXWPFDocument.PICTURE_TYPE_PNG;
}else if(picType.equalsIgnoreCase("dib")){
res = CustomXWPFDocument.PICTURE_TYPE_DIB;
}else if(picType.equalsIgnoreCase("emf")){
res = CustomXWPFDocument.PICTURE_TYPE_EMF;
}else if(picType.equalsIgnoreCase("jpg") || picType.equalsIgnoreCase("jpeg")){
res = CustomXWPFDocument.PICTURE_TYPE_JPEG;
}else if(picType.equalsIgnoreCase("wmf")){
res = CustomXWPFDocument.PICTURE_TYPE_WMF;
}
}
return res;
}
/**
* 合并行
* @param table
* @param col 需要合并的列
* @param fromRow 开始行
* @param toRow 结束行
*/
public static void mergeCellVertically(XWPFTable table, int col, int fromRow, int toRow) {
for(int rowIndex = fromRow; rowIndex startEnd(List daList){
List indexList = new ArrayList();
List list = new ArrayList();
for (int i=0;i tm = new HashMap();
for (int i=0;i entry : tm.entrySet()) {
String key = entry.getKey().toString();
String value = entry.getValue().toString();
if (list.indexOf(key) != (-1)){
Integer[] index = new Integer[2];
index[0] = list.indexOf(key);
index[1] = list.lastIndexOf(key);
indexList.add(index);
}
}
return indexList;
}
}测试案例
/*
* Copyright (c) 2019. houbinbin Inc.
* idoc All rights reserved.
*/
package com.github.houbb.idoc.test.poi;
import com.github.houbb.idoc.test.utils.CustomXWPFDocument;
import com.github.houbb.idoc.test.utils.WorderToNewWordUtils;
import org.junit.Test;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
/**
*
*
* Created: 2019/2/14 7:07 AM
* Project: idoc
*
* @author houbinbin
*/
public class WordUtilTest {
@Test
public void genTest() throws IOException {
final String templatePath = "/Users/houbinbin/code/_github/idoc/idoc-core/src/main/resources/idoc/word/idoc-word-all.docx";
//需要进行文本替换的信息
Map data = new HashMap<>();
data.put("${author}", "binbin.hou");
//需要进行动态生成的信息
Map mapList = new HashMap();
CustomXWPFDocument doc = WorderToNewWordUtils.changWord(templatePath,data,mapList);
FileOutputStream fopts = new FileOutputStream("替换后的信息.docx");
doc.write(fopts);
fopts.close();
}
}其中 templatePath 对应的文件，就是一个包含 ${author} 信息文件，这里直接是匹配替换。
生成之后的文件，${author} 就会被替换成为 binbin.hou。其他更多字段信息，也是同理。
参考资料
贡献者
binbin.hou