Java使用spire进行word文档的替换

Posted 2023-01-09 小花皮猪

前言

今天遇到一个需求，需要对word模板进行替换制定的变量

在网上找了很多方案，做了很多的demo，下面就把我觉得比较简单的一种分享给大家

本次的主角是：spire.doc

spire.doc是专门实现对word的操作（包括文字，表格，图片)

spire.doc介绍

Spire.Doc for .NET 是一款专门对 Word 文档进行操作的 .NET类库。这款控件的主要功能在于帮助开发人员轻松快捷高效地创建、编辑、转换和打印 Microsoft Word 文档。作为一款独立的 Word .NET 控件，Spire.Doc for .NET 的运行系统（服务器端或客户端）均无需安装 Microsoft Word，但是它却可以将 Microsoft Word 文档的操作功能集成到任何开发人员的 .NET 应用程序中。

Spire.Doc for .NET 能执行多种 Microsoft Word 文档处理任务的 .NET API。支持 Word97-2003，Word2007，Word2010 以及 Word2013。能在 Word 97/2003/2007/2010/2013 和 XML、RTF、TXT、XPS、EPUB、EMF、html、ODT 等格式文件之间进行双向转换，还能将 Word 文件高质量地转换为 PDF 和 SVG 文件格式。

具体使用可以参考文档： Spire.Doc for .NET 中文教程

前提准备

准备word模板

准备一个word文件，里面简单写点模板：

引入spire.do依赖

spire.doc比较小众，因此需要在pom.xml中导入spire.doc的仓库，导入之后直接导包，如果不配置仓库直接下载依赖是不行的！

	  <dependency>
            <groupId>e-iceblue</groupId>
            <artifactId>spire.doc.free</artifactId>
            <version>3.9.0</version>
        </dependency>
        
		 <repositories>
		        <repository>
		            <id>com.e-iceblue</id>
		            <url>http://repo.e-iceblue.cn/repository/maven-public/</url>
		        </repository>
		    </repositories>

案例演示

前提工作准备好之后，就可以开始编写demo了

单个内容替换

短短的三行代码，就完成了读取，替换，保存的功能：

package com.test;

import com.spire.doc.Document;
import com.spire.doc.FileFormat;

/**
 * @description: 替换word文档中的变量
 * @author: 魏一鹤
 * @createDate: 2023-01-08 10:51
 **/

public class FileTest3 
    public static void main(String[] args) 
        //加载Word文档
        Document document = new Document("C:\\\\Users\\\\PC\\\\Desktop\\\\test.docx");
        //使用新文本替换文档中的指定文本
        document.replace("$name", "张三丰", false, true);
        //保存文档
        document.saveToFile("C:\\\\Users\\\\PC\\\\Desktop\\\\test2.docx", FileFormat.Docx_2013);
    

这时候打开桌面生成的文件查看，$name的变量以及被替换掉了

但是这只是单独替换一个变量，一般一个模板里面是会有很多的变量的，这事我们需要支持批量替换变量

批量内容替换

想要实现批量内容替换，其实也很简单，还是拿上面举例的模板进行操作：

方式1

笨点的方式：既然我们使用的是document.replace进行替换，那么模板里面有多少个变量，我们就写多少个document.replac即可：

package com.test;

import com.spire.doc.Document;
import com.spire.doc.FileFormat;

/**
 * @description: 替换word文档中的变量
 * @author: 魏一鹤
 * @createDate: 2023-01-08 10:51
 **/

public class FileTest3 
    public static void main(String[] args) 
        //加载Word文档
        Document document = new Document("C:\\\\Users\\\\PC\\\\Desktop\\\\test.docx");
        //使用新文本替换文档中的指定文本
        document.replace("$name", "张三丰", false, true);
        document.replace("$age", "18", false, true);
        document.replace("$sex", "男", false, true);
        //保存文档
        document.saveToFile("C:\\\\Users\\\\PC\\\\Desktop\\\\test2.docx", FileFormat.Docx_2013);
    

虽然笨，但是可行：

方式2

虽然上面的方式可行，但是维护起来比较麻烦，这时候我们可以采取这种方式：

声明一个map，把一组组的key和value进行保存，key就是变量， value就是模板值，然后循环map进行替换，这样不管多少个变量，我们都只需要在map里配置即可

package com.test;

import com.spire.doc.Document;
import com.spire.doc.FileFormat;

import java.util.HashMap;
import java.util.Set;

/**
 * @description: 替换word文档中的变量
 * @author: 魏一鹤
 * @createDate: 2023-01-08 10:51
 **/

public class FileTest3 
    public static void main(String[] args) 
        //加载Word文档
        Document document = new Document("C:\\\\Users\\\\PC\\\\Desktop\\\\test.docx");
        //模板变量map
        HashMap<String, Object> paramsMap = new HashMap<>();
        // 填充key和vaulue key=模板变量,value=替换后的值
        paramsMap.put("$name","张三丰");
        paramsMap.put("$age","18");
        paramsMap.put("$sex","男");
        // 循环key
        for(String key:paramsMap.keySet())
            // 根据key得到value
            String value = paramsMap.get(key).toString();
            //使用新文本替换文档中的指定文本 也就是value替换key
            document.replace(key, value, false, true);
        
        //保存文档
        document.saveToFile("C:\\\\Users\\\\PC\\\\Desktop\\\\test3.docx", FileFormat.Docx_2013);
    

再次运行代码，文档里面的变量以及全部完成了替换。

总结

能够实现这样的例子很多，我个人也花了两天试了很多的demo，包括Apache下的poi的XWPFDocument，Java File文件流等，经过大量的常识，我个人更倾向于这种方式，不仅代码量少，而且spire本身就是支持对于word文档操作的，功能更多且强大。所以在次推荐给大家

另外，我也收藏了一些其他博主写的相关功能的问题，个人觉得也不错，在次推荐给大家，希望对大家有用！

Java实现替换Word中文本

Java File文件流读取文件夹内的文件并替换文件内容

XWPFDocument导出Word文档简单操作