Spire.Cloud.Word 添加、獲取和刪除 Word 文檔自定義屬性

前言：

Spire.Cloud 在線編輯器是一款基于網頁的 Office 文件編輯工具，支持在網頁中打開、編輯、打印 Word、Excel、PPT 文件，支持將文檔保存到私有云盤。支持 IE、Chrome、FireFox、搜狗、遨游、360 等常見瀏覽器。Spire.Cloud Web API 能幫助開發人員能在任何時間、任何地點直接調用 SDK 接口對 Word、Excel、PPT、PDF 文檔進行操作。Spire.Cloud 支持 .NET、Java、PHP、Python、JavaScript 等多種編程語言，并提供了 1 萬次的免費調用次數及 2G 文檔內存。

本文將通過實例闡述如何通過Spire.Cloud.Word API給開發人員提供的DocumentPropertiesApi接口，來添加、獲取和刪除Word文檔自定義屬性。

詳細步驟：

1、通過冰藍云官網（ https://cloud.e-iceblue.cn/）注冊賬號并登陸，在“我的應用”版塊創建應用程序，獲得App ID及App Key。

2、上傳Word文檔至冰藍云官網的“文檔管理”版塊。為了便于文檔管理，您也可以先創建文件夾“input”和“output”，然后將需要編輯的Word文檔上傳至input文件夾下，output文件夾用于存放生成的文檔。

3、創建Maven應用程序，通過Maven倉庫安裝Spire.Cloud.SDK jar包及依賴。詳細步驟參考 文章 。

<repositories>
    <repository>
        <id>com.e-iceblue</id>
        <name>cloud</name>
        <url>http://repo.e-iceblue.cn/repository/maven-public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
            <groupId> cloud </groupId>
            <artifactId>spire.cloud.sdk</artifactId>
            <version>3.5.0</version>
        </dependency>
    <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-annotations</artifactId>
        <version>1.5.18</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp</groupId>
        <artifactId>okhttp</artifactId>
        <version>2.7.5</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okhttp</groupId>
        <artifactId>logging-interceptor</artifactId>
        <version>2.7.5</version>
    </dependency>
    <dependency>
        <groupId> com.squareup.okio </groupId>
        <artifactId>okio</artifactId>
        <version>1.6.0</version>
    </dependency>
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.8.1</version>
    </dependency>
    <dependency>
        <groupId>io.gsonfire</groupId>
        <artifactId>gson-fire</artifactId>
        <version>1.8.0</version>
    </dependency>
    <dependency>
        <groupId>org.threeten</groupId>
        <artifactId>threetenbp</artifactId>
        <version>1.3.5</version>
    </dependency>
</dependencies>

4、新建Java class，調用Spire.Cloud.Word API操作input文件夾下的示例文檔。

示例1、添加自定義文檔屬性

import spire.cloud.word.sdk.client.*;
import spire.cloud.word.sdk.client.api.DocumentPropertiesApi;
import spire.cloud.word.sdk.client.model.*;
import java.util.ArrayList;
import java.util.List;
public class addCustomDocumentProperties {
    static String appId = " APP ID "; 
    static String appKey = " APP Key ";
    static String baseUrl = "https://api.e-iceblue.cn";
    //配置APP ID和APP Key
    static Configuration wordConfiguration = new Configuration(appId, appKey, baseUrl);
    //創建documentPropertiesApi實例
    static DocumentPropertiesApi documentPropertiesApi = new DocumentPropertiesApi(wordConfiguration);
    public static void main(String[] args) throws ApiException {
        //示例文檔名稱
        String name = "test.docx";
        //示例文檔的密碼
        String password = null;
        //存放示例文檔的文件夾
        String folder = "input";
        //使用冰藍云默認的存儲空間
        String storage = null;
        //輸出文檔存放路徑
        String destFilePath = "output/addCustomDocumentProperties_out.docx";
        //設置自定義文檔屬性
        List properties = new ArrayList();
        properties.add(new CustomDocumentProperty("Name1", "Value1"));
        properties.add(new CustomDocumentProperty("Name2", "Value2"));
        //調用addCustomDocumentProperties添加自定義文檔屬性
        documentPropertiesApi.addCustomDocumentProperties(name, properties, destFilePath, password, folder, storage);
    }
  }

示例2、獲取自定義文檔屬性

import spire.cloud.word.sdk.client.*;
import spire.cloud.word.sdk.client.api.DocumentPropertiesApi;
import spire.cloud.word.sdk.client.model.*;
import java.util.List;
public class getCustomDocumentProperties {
    static String appId = " APP ID "; 
    static String appKey = " APP Key ";
    static String baseUrl = "https://api.e-iceblue.cn";
    //配置APP ID和APP Key
    static Configuration wordConfiguration = new Configuration(appId, appKey, baseUrl);
    //創建documentPropertiesApi實例
    static DocumentPropertiesApi documentPropertiesApi = new DocumentPropertiesApi(wordConfiguration);
    public static void main(String[] args) throws ApiException {
        //示例文檔名稱
        String name = "Sample.docx";
        //示例文檔的密碼
        String password = null;
        //存放示例文檔的文件夾
        String folder = "input";
        //使用冰藍云默認的存儲空間
        String storage = null;
        //調用getCustomDocumentProperties讀取自定義文檔屬性
        List response = documentPropertiesApi.getCustomDocumentProperties(name, password, folder, storage);
        System.out.println(response);
    }
  }

示例3、刪除自定義文檔屬性

import spire.cloud.word.sdk.client.*;
import spire.cloud.word.sdk.client.api.DocumentPropertiesApi;
public class deleteCustomDocumentProperties {
    static String appId = " APP ID "; 
    static String appKey = " APP Key ";
    static String baseUrl = "https://api.e-iceblue.cn";
    //配置APP ID和APP Key
    static Configuration wordConfiguration = new Configuration(appId, appKey, baseUrl);
    //創建documentPropertiesApi實例
    static DocumentPropertiesApi documentPropertiesApi = new DocumentPropertiesApi(wordConfiguration);
    public static void main(String[] args) throws ApiException {
        //示例文檔名稱
        String name = "Sample.docx";
        //示例文檔自定義屬性中需要刪除的項目
        String propertieName = "Owner";
        //示例文檔的密碼
        String password = null;
        //存放示例文檔的文件夾
        String folder = "input";
        //使用冰藍云默認的存儲空間
        String storage = null;
        //輸出文檔存放路徑
        String destFilePath = "output/deleteCustomDocumentProperties_output.docx";
        //調用deleteCustomDocumentProperty刪除指定的自定義文檔屬性
        documentPropertiesApi.deleteCustomDocumentProperty(name, propertieName, destFilePath, password, folder, storage);
    }
  }