使用 Java 为 Word 文档添加文档属性

Source: Dev.to

为什么使用 Spire.Doc for Java？

Spire.Doc for Java 是一个专业的 API，能够让您在服务器上无需 Microsoft Word 即可创建、编辑、转换和打印 Word 文档。它的功能集包括：

• 文本操作
• 表格处理
• 图像处理
• 文档属性管理

由于使用简便且功能全面，它是 Java 中实现 Word 文档自动化任务的极佳选择。

添加 Spire.Doc 到您的项目

如果您使用 Maven，请将仓库和依赖项添加到 pom.xml 中：

<repositories>
    <repository>
        <id>e-iceblue</id>
        <url>https://repo.e-iceblue.com/nexus/content/groups/public/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>e-iceblue</groupId>
        <artifactId>spire.doc</artifactId>
        <version>13.12.2</version>
    </dependency>
</dependencies>

Source: …

内置文档属性

内置属性是每个 Word 文档都可以拥有的预定义字段。它们提供标准元数据，便于对文档进行分类、搜索和管理。常见的内置属性包括：

使用 Spire.Doc 设置内置属性

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

public class AddBuiltinDocumentProperties {
    public static void main(String[] args) throws Exception {
        // 创建 Document 实例并加载 Word 文件
        Document document = new Document();
        document.loadFromFile("Sample.docx");

        // 访问内置文档属性
        BuiltinDocumentProperties props = document.getBuiltinDocumentProperties();

        // 设置属性值
        props.setTitle("Add Document Properties");
        props.setSubject("Java Example");
        props.setAuthor("James");
        props.setCompany("Eiceblue");
        props.setManager("Michael");
        props.setCategory("Document Manipulation");
        props.setKeywords("Java, Word, Document Properties");
        props.setComments("This article shows how to add document properties");

        // 保存更新后的文档
        document.saveToFile("AddStandardDocumentProperties.docx",
                FileFormat.Docx_2013);
    }
}

在本例中：

1. 创建 Document 对象并加载 Word 文件。
2. getBuiltinDocumentProperties() 返回 BuiltinDocumentProperties 集合。
3. 使用 setter 方法（如 setTitle()、setAuthor()）赋值。
4. 将文档保存并附带新的元数据。

自定义文档属性

内置属性涵盖常见的元数据，但许多场景需要 自定义 属性，这些属性针对您的组织或项目具有特定意义。自定义属性允许您定义任意名称，并存储多种数据类型的值（文本、数字、布尔值、日期）。

常见使用场景

• 项目管理 – 项目 ID、版本号、客户名称
• 文档工作流 – 审批状态、审阅人、最后修改者
• 内部分类 – 部门、安全级别、保留策略
• 自动化处理 – 用作其他系统触发器的属性

使用 Spire.Doc 添加自定义属性

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

import java.util.Date;

public class AddCustomDocumentProperties {
    public static void main(String[] args) throws Exception {
        // Create a Document instance and load a Word file
        Document document = new Document();
        document.loadFromFile("Sample.docx");

        // Access the custom document properties collection
        CustomDocumentProperties customProps = document.getCustomDocumentProperties();

        // Add custom properties with different data types
        customProps.add("Document ID", 1);                     // Integer
        customProps.add("Authorized", true);                  // Boolean
        customProps.add("Authorized By", "John Smith");       // String
        customProps.add("Authorized Date", new Date());       // Date

        // Save the updated document
        document.saveToFile("AddCustomDocumentProperties.docx",
                FileFormat.Docx_2013);
    }
}

代码说明

1. 初始化 Document 对象并加载已有的 Word 文件。
2. 通过 getCustomDocumentProperties() 获取 CustomDocumentProperties 集合。
3. 使用 add(propertyName, value) 插入不同类型的属性。
4. 保存文档，文档中现在已包含自定义的元数据。

Recap

• 内置属性 提供标准元数据（标题、作者等）。
• 自定义属性 让您可以存储任何所需的额外信息，支持灵活的数据类型。
• Spire.Doc for Java API 提供简洁、流畅的方法来读取、修改和持久化这两类属性。

通过将这些技术整合到您的 Java 应用程序中，您可以实现文档分类自动化、提升可搜索性，并更紧密地将 Word 文件与其他业务流程集成。祝编码愉快！

添加自定义文档属性

stomDocumentProperties()

我们使用 add() 方法创建新的自定义属性，指定属性名称及其值。Spire.Doc 会自动处理底层的数据类型转换。

查看已添加的属性

运行这些示例后，您可以打开生成的 Word 文档并导航至：

1. 文件 → 信息 → 属性 → 高级属性
2. 单击 自定义 选项卡以查看您添加的自定义属性。
3. 使用 摘要 或 统计信息 选项卡查看内置属性。

为什么这很重要

掌握使用 Java 和 Spire.Doc for Java 在 Word 文件中添加文档属性的技巧，对从事文档自动化的开发者来说是一项宝贵的技能。

• 标准内置属性 提供通用的元数据。
• 自定义属性 允许存储灵活的、由应用驱动的信息。

嵌入这些元数据显著提升了 Word 文档的可发现性、组织性和整体实用性。这一能力在现代文档管理系统中至关重要，能够实现：

• 强大的搜索功能
• 自动化工作流
• 流畅的信息检索

我们鼓励您进一步尝试 Spire.Doc for Java，并在您的 Java 应用中探索其广阔的潜力。

编码愉快！