最近写项目时遇到一些操作数据填充word、pdf以及word转pdf、word转图片的需求。网络搜索资料经整理如下
操作office文档、pdf一般来说有好几种实现方式
<!-- pdf 转图片 -->
org.apache.pdfbox</groupId>
pdfbox</artifactId>
2.0.25</version>
</dependency>
<!--
org.apache.poi</groupId>
poi-ooxml</artifactId>
3.10.1</version>
</dependency>
-->
<!-- https://mvnrepository.com/artifact/fr.opensagres.xdocreport/org.apache.poi.xwpf.converter.pdf-->
fr.opensagres.xdocreport</groupId>
org.apache.poi.xwpf.converter.pdf</artifactId>
1.0.4</version>
</dependency>
<!-- pdf 转图片 -->
<!-- docx4j 创建docx文件、pdf文档、word转pdf文档-->
org.docx4j</groupId>
docx4j-JAXB-Internal</artifactId>
8.2.4</version>
</dependency>
org.docx4j</groupId>
docx4j-export-fo</artifactId>
8.2.4</version>
</dependency>
<!-- docx4j 创建docx文件、pdf文档、word转pdf文档-->
package com.sl.utils.office.word;
import com.sl.utils.id.IDUtils;
import org.apache.commons.collections4.MapUtils;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.rendering.PDFRenderer;
import org.docx4j.Docx4J;
import org.docx4j.TraversalUtil;
import org.docx4j.XmlUtils;
import org.docx4j.dml.wordprocessingDrawing.Inline;
import org.docx4j.finders.RangeFinder;
import org.docx4j.fonts.IdentityPlusMapper;
import org.docx4j.fonts.Mapper;
import org.docx4j.fonts.PhysicalFonts;
import org.docx4j.jaxb.Context;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.openpackaging.parts.WordprocessingML.BinaryPartAbstractImage;
import org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart;
import org.docx4j.wml.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* docx4j生成docx文件、pdf文件、docx转pdf、docx转图片 pdf转图片工具
*
* 有三种方式
* 1 通过占位符
*
*
* 通过docx文件的书签、占位符替换变量
*
* 通过占位符替换注意
* * 通过占位符替换注意 -----------坑坑坑坑 直接再docx文件中进行修改占位符不一定会连续!!!-----------
* ${var}必须是连续的,否则取不到变量。有时候取不到变量的时候可以抓换为xml然后查看你的变量是否是连续的
* 可以通过如下方式解决 现在docx文件中写入占位符然后
* 把当前docx文件用rar或zip打开,找到其中的 word/document.xml文件,修改占位符连续
*
* 比如把
*
* ${na</w:t>
* </w:r>
*
* me}</w:t>
* </w:r>
* 修改为
*
* ${name}</w:t>
* </w:r>
* 2、全部通过书签
* 3、通过域变量
* 通过域变量需要重写 docx4居中 XmlUtils 工具类中unmarshallFromTemplate方法 以适配域变量
* 具体目录在 org.docx4j
* @author gaoxueyong
* @create at: 2021/12/28 下午15:02
*/
public class DocxAndPdfAndImgUtils {
private static final Logger log = LoggerFactory.getLogger(DocxAndPdfAndImgUtils.class);
private static WordprocessingMLPackage wordMLPackage;
private static ObjectFactory factory;
/**
* 通过docx模板获取docx模板转换的图片
* @param templatePath 模板文件
* @param mappings 要匹配的占位符数据
* @param fileMapping 书签名称对于的文件
* @return
*/
public static List[]> getPngByDocxTemplate(String templatePath, Map, String> mappings, Map, byte[]> fileMapping) {
return pdfToImg(getPdfFile(templatePath, mappings, fileMapping));
}
/**
* 通过模板获取转换后docx的二进制数组
* @param templatePath 模板文件
* @param mappings 要匹配的占位符数据
* @param fileMapping 书签名称对于的文件
* @return
*/
public static byte[] getDocxByTemplate(String templatePath, Map, String> mappings, Map, byte[]> fileMapping) {
File docxFile = getDocxFile(templatePath, mappings, fileMapping);
try {
if (null == docxFile) {
return null;
}
byte[] bytes = Files.readAllBytes(docxFile.toPath());
if (docxFile.exists()) {
docxFile.delete();
}
return bytes;
} catch (IOException e) {
log.error("获取文件失败");
if (docxFile.exists()) {
docxFile.delete();
}
return null;
}
}
/**
* 通过模板获取转换后pdf文件
* @param templatePath 模板文件
* @param mappings 要匹配的占位符数据
* @param fileMapping 书签名称对于的文件
* @return
*/
public static byte[] getPdfFile(String templatePath, Map, String> mappings, Map, byte[]> fileMapping){
try {
File docxFile = getDocxFile(templatePath, mappings, fileMapping);
if(null == docxFile){
return null;
}
WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.load(docxFile);
Path pdf = Files.createTempFile(IDUtils.getPrimaryId(), "pdf");
File pdfFile = pdf.toFile();
if(null == pdfFile){
log.error("创建文件失败");
return null;
}
Docx4J.toPDF(wordMLPackage, new FileOutputStream(pdfFile));
if(docxFile.exists()){
docxFile.delete();
}
byte[] bytes = Files.readAllBytes(pdf);
if(pdfFile.exists()){
pdfFile.delete();
}
return bytes;
} catch (Docx4JException e) {
log.error("bookReplaceVarText error:Docx4JException ", e);
return null;
} catch (Exception e) {
log.error("bookReplaceVarText error:Docx4JException ", e);
return null;
}
}
/**
* 通过文件输入流获取pdf文档的二进制数组
* @param docxInputstream
* @return
*/
public static byte[] getPdfByte(InputStream docxInputstream){
try {
if(null == docxInputstream){
return null;
}
WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.load(docxInputstream);
Path pdf = Files.createTempFile(IDUtils.getPrimaryId(), "pdf");
File pdfFile = pdf.toFile();
if(null == pdfFile){
log.error("创建文件失败");
return null;
}
Docx4J.toPDF(wordMLPackage, new FileOutputStream(pdfFile));
byte[] bytes = Files.readAllBytes(pdf);
if(pdfFile.exists()){
pdfFile.delete();
}
return bytes;
} catch (Docx4JException e) {
log.error("bookReplaceVarText error:Docx4JException ", e);
return null;
} catch (Exception e) {
log.error("bookReplaceVarText error:Docx4JException ", e);
return null;
}
}
/**
* 通过模板获取转换后docx文件
* @param templatePath 模板文件
* @param mappings 要匹配的占位符数据
* @param fileMapping 书签名称对于的文件
* @return
*/
public static File getDocxFile(String templatePath, Map, String> mappings, Map, byte[]> fileMapping){
try {
wordMLPackage = WordprocessingMLPackage.load(new File(templatePath));
MainDocumentPart mainDocumentPart = wordMLPackage.getMainDocumentPart();
if(MapUtils.isNotEmpty(mappings)){
mainDocumentPart.variableReplace(mappings);
}
factory = Context.getWmlObjectFactory();
Document wmlDoc = (Document) mainDocumentPart.getJaxbElement();
Body body = wmlDoc.getBody();
// 提取正文中所有段落
List
重写 XmlUtils 工具类中unmarshallFromTemplate方法 以适配域变量
用zip或rar工具打开docx文档并找到word/document.xml文件进行编辑
偷偷的告诉你,其实docx文档也是压缩包,可以修改其后缀直接变成zip文件
打开document.xml文档如下发现刚才的占位符是不连续的,我们要修改使其连续
使用编辑器修改后如下,然后把该文件写会到word问里,或者通过zip工具放进去
现在就可以直接调用工具方法替换数据以及图片了
注意 使用域变量需要重写 docx4居中 XmlUtils 工具类中unmarshallFromTemplate方法 以适配域变量
<!-- xdocreport 生成word、pdf -->
<!-- https://mvnrepository.com/artifact/fr.opensagres.xdocreport/fr.opensagres.xdocreport.document.docx -->
fr.opensagres.xdocreport</groupId>
fr.opensagres.xdocreport.document.docx</artifactId>
2.0.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/fr.opensagres.xdocreport/fr.opensagres.xdocreport.template.freemarker -->
fr.opensagres.xdocreport</groupId>
fr.opensagres.xdocreport.template.freemarker</artifactId>
2.0.2</version>
</dependency>
fr.opensagres.xdocreport</groupId>
fr.opensagres.xdocreport.converter.docx.xwpf</artifactId>
2.0.2</version>
</dependency>
<!-- xdocreport 生成word、pdf -->
<!-- pdf转图片 -->
org.apache.pdfbox</groupId>
pdfbox</artifactId>
2.0.25</version>
</dependency>
<!-- https://mvnrepository.com/artifact/fr.opensagres.xdocreport/fr.opensagres.poi.xwpf.converter.pdf -->
fr.opensagres.xdocreport</groupId>
fr.opensagres.poi.xwpf.converter.pdf</artifactId>
2.0.2</version>
</dependency>
<!-- pdf转图片 -->
org.projectlombok</groupId>
lombok</artifactId>
</dependency>
注意 如果要动态替换图片需要先在模板里插入一张图片,否则无法替换图片
选中头像后的图片
public static void main(String[] args) {
Map<String, Object> param = new HashMap<>();
param.put("user.username", "小明不怕不怕啦");
param.put("user.hobby", "爱玩dota");
param.put("name", "sssssssssssssssssssssss");
String rootPath = XdocreportUtils.class.getClassLoader().getResource("").getPath();
String filePath = String.format("%stemplates/xdocreport/xdocxtemplate.docx", rootPath);
Map<String, IImageProvider> imgMap = new HashMap<>();
IImageProvider logo = new FileImageProvider(new File("C:\\Users\\Administrator\\Desktop\\2021122211591833953227008.png"), true);
logo.setSize(500f, 500f);
imgMap.put("logo", logo);
IImageProvider pic = new FileImageProvider(new File("C:\\Users\\Administrator\\Desktop\\suoluePic.PNG"), true);
pic.setSize(200f, 200f);
imgMap.put("pic", pic);
exportDocx(param, imgMap, new File(filePath), "C:\\Users\\Administrator\\Desktop\\DocxProjectWithFreemarker_Out.docx");
exportPdf(param, imgMap, new File(filePath), "C:\\Users\\Administrator\\Desktop\\DocxProjectWithFreemarker_Out.pdf");
}
public static void exportDocx(Map<String, Object> param, Map<String, IImageProvider> imgMap, File templateFIle, String outPath) {
try {
InputStream in = new FileInputStream(templateFIle);
//载入模板
IXDocReport report = XDocReportRegistry.getRegistry().loadReport(in, TemplateEngineKind.Freemarker);
IContext context = report.createContext();
//设置要替换的值
if (MapUtils.isNotEmpty(param)) {
for (Map.Entry<String, Object> entry : param.entrySet()) {
context.put(entry.getKey(), entry.getValue());
}
}
FieldsMetadata metadata = report.createFieldsMetadata();
report.setFieldsMetadata(metadata);
//替换图片
if (MapUtils.isNotEmpty(imgMap)) {
for (Map.Entry<String, IImageProvider> entry : imgMap.entrySet()) {
context.put(entry.getKey(), entry.getValue());
metadata.addFieldAsImage(entry.getKey());
}
}
report.setFieldsMetadata(metadata);
OutputStream out = new FileOutputStream(new File(outPath));
report.process(context, out);
out.close();
} catch (IOException e) {
log.error("导出docx文件出现异常!", e);
} catch (XDocReportException e) {
log.error("导出docx文件出现异常!", e);
}
}
public static void exportPdf(Map<String, Object> param, Map<String, IImageProvider> imgMap, File templateFIle, String outPath) {
try {
InputStream in = new FileInputStream(templateFIle);
//载入模板
IXDocReport report = XDocReportRegistry.getRegistry().loadReport(in, TemplateEngineKind.Freemarker);
IContext context = report.createContext();
//设置要替换的值
if (MapUtils.isNotEmpty(param)) {
for (Map.Entry<String, Object> entry : param.entrySet()) {
context.put(entry.getKey(), entry.getValue());
}
}
FieldsMetadata metadata = report.createFieldsMetadata();
report.setFieldsMetadata(metadata);
//替换图片
if (MapUtils.isNotEmpty(imgMap)) {
for (Map.Entry<String, IImageProvider> entry : imgMap.entrySet()) {
context.put(entry.getKey(), entry.getValue());
metadata.addFieldAsImage(entry.getKey());
}
}
report.setFieldsMetadata(metadata);
OutputStream out = new FileOutputStream(new File(outPath));
Options options = Options.getTo(ConverterTypeTo.PDF).via(ConverterTypeVia.XWPF);
report.convert(context, options, out);
out.close();
} catch (IOException e) {
log.error("导出pdf文件出现异常!", e);
} catch (XDocReportException e) {
log.error("导出pdf文件出现异常!", e);
}
}
e-iceblue</groupId>
spire.doc.free</artifactId>
3.9.0</version>
</dependency>
com.e-iceblue</id>
https://repo.e-iceblue.cn/repository/maven-public/</url>
</repository>
</repositories>
import com.spire.doc.Document;
import com.spire.doc.FileFormat;
import com.spire.doc.documents.BookmarksNavigator;
import com.spire.doc.documents.Paragraph;
import com.spire.doc.documents.TextBodyPart;
import com.spire.doc.fields.DocPicture;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
public class SpireWordPicTest {
public static void main(String[] args) throws IOException {
//加载Word文档
Document doc = new Document("C:\\Users\\Administrator\\Desktop\\testDocTemplates.docx");
Map,String> mappings = new HashMap<>();
mappings.put("username","小明");
mappings.put("password","123456");
/**
* https://www.cnblogs.com/Yesi/p/11422349.html
* 需要先在模板里设置书签 然后替换
*
*/
for(Map.Entry,String > entry:mappings.entrySet()){
doc.replace(String.format("${%s}",entry.getKey()),entry.getValue(), false, true);
}
//定位到指定书签位置 设置二维码
BookmarksNavigator bookmarksNavigator = new BookmarksNavigator(doc);
bookmarksNavigator.moveToBookmark("headerPng", true, true);
Paragraph para= new Paragraph(doc);
DocPicture docPicture = para.appendPicture("C:\\Users\\Administrator\\Desktop\\企业微信截图_20211228152622.png");//设置图片宽度
docPicture.setWidth(110);
//设置图片高度
docPicture.setHeight(110);
TextBodyPart bodyPart = new TextBodyPart(doc);
bodyPart.getBodyItems().add(para);
bookmarksNavigator.replaceBookmarkContent(bodyPart);
//保存文档
doc.saveToFile("C:\\Users\\Administrator\\Desktop\\ReplaceAllMatchedText.docx", FileFormat.Docx_2013);
}
冰蓝科技的免费版代码执行效率很低,不知道正式版怎么样
https://www.e-iceblue.cn/spiredocforjava/spire-doc-for-java-program-guide-content.html
样例代码可参考 https://gitee.com/wahnn/SpringBoot2.x/tree/master/XdocreportAndDocx4j