Java中Word变量进行添加、统计、获取与删除操作详解

<repositories>
    <repository>
        <id>com.e-iceblue</id>
        <name>e-iceblue</name>
        <url>https://repo.e-iceblue.com/nexus/content/groups/public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>e-iceblue</groupId>
        <artifactId>spire.doc</artifactId>
        <version>14.4.9</version>
    </dependency>
</dependencies>

import com.spire.doc.Document;
import com.spire.doc.FieldType;
import com.spire.doc.FileFormat;
import com.spire.doc.Section;
import com.spire.doc.documents.Paragraph;

public class AddVariableDemo {
    public static void main(String[] args) {
        // 创建文档实例
        Document doc = new Document();
        Section section = doc.addSection();
        Paragraph paragraph = section.addParagraph();

        // 在段落中插入变量域，参数 "Term" 是变量的引用名称
        paragraph.appendField("Term", FieldType.Field_Doc_Variable);
        paragraph.appendText(" is a fundamental concept in physics.\r\n");
        paragraph.appendField("Term", FieldType.Field_Doc_Variable);
        paragraph.appendText(" has a measurable physical quantity.");

        // 通过 VariableCollection 添加变量值，将 Key 为 "Term" 的变量赋值为 "Time"
        doc.getVariables().add("Term", "Time");

        // 更新文档域（这行代码确保变量值正确显示）
        doc.isUpdateFields(true);

        // 保存文档
        doc.saveToFile("AddVariables.docx", FileFormat.Docx_2013);
        doc.dispose();
    }
}

import com.spire.doc.Document;

public class CountVariablesDemo {
    public static void main(String[] args) {
        // 加载之前生成的文档
        Document doc = new Document();
        doc.loadFromFile("AddVariables.docx");

        // 获取变量集合中的元素个数
        int count = doc.getVariables().getCount();
        System.out.println("当前文档包含的变量数量: " + count);
        // 输出结果: 当前文档包含的变量数量: 1
        doc.close();
    }
}

import com.spire.doc.Document;

public class RetrieveVariablesDemo {
    public static void main(String[] args) {
        Document doc = new Document();
        doc.loadFromFile("AddVariables.docx");

        // 通过索引检索（通常用于遍历）
        String name = doc.getVariables().getNameByIndex(0);
        String valueByIndex = doc.getVariables().getValueByIndex(0);
        System.out.println("索引0对应的变量名: " + name);
        System.out.println("索引0对应的变量值: " + valueByIndex);

        // 通过变量名直接检索值
        String valueByName = doc.getVariables().get("Term");
        System.out.println("变量 'Term' 的值为: " + valueByName);

        doc.close();
    }
}

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

public class RemoveVariablesDemo {
    public static void main(String[] args) {
        Document doc = new Document();
        doc.loadFromFile("AddVariables.docx");

        // 根据变量名执行删除操作
        doc.getVariables().remove("Term");
        
        // 建议更新域，删除变量后，原来的域代码通常会显示为空或变为默认值
        doc.isUpdateFields(true);

        // 保存清理后的新文档
        doc.saveToFile("RemoveVariables.docx", FileFormat.Docx_2013);
        System.out.println("变量已移除");
        doc.dispose();
    }
}