您可以通過文檔在線編輯功能在線編輯文檔。本文介紹文檔在線編輯處理功能參數及示例。
使用場景
協同辦公平臺：多個用戶協同辦公時，需要多人實時協作編輯同一份文檔。
內容管理系統：一些企業級的內容管理系統需要進行在線編輯，以直接在系統內對文檔進行增刪改查。
教育平臺：在線教育平臺常會讓學生提交作業或教師編寫課件，文檔直接保存在云端，方便隨時查閱和分享。
前提條件
已通過配額中心申請開啟新版本IMM Get和Post數據處理能力。
已綁定IMM Project。您可以通過OSS控制臺或API綁定IMM Project。
通過OSS控制臺綁定的具體操作，請參見步驟一：綁定IMM。
通過API綁定的具體操作，請參見AttachOSSBucket。
注意事項
文檔在線編輯僅支持同步處理（x-oss-process處理方式）。
不支持匿名訪問。
必須擁有IMM處理所需的相關權限。更多信息，請參見權限。
如果使用OSS默認域名訪問文件，將下載文檔預覽HTML頁面。如果使用自定義域名文檔在線預覽操作需要您在OSS Bucket綁定自定義域名，通過自定義域名訪問文件時才能打開預覽。關于綁定自定義域名更多信息，請參見綁定自定義域名至Bucket默認域名。
參數說明
操作名稱：doc/edit
具體參數如下表所示。
參數名稱 | 類型 | 是否必須 | 描述 |
int | 否 | 是否允許打印。取值：
| |
export | int | 否 | 是否允許導出為PDF。取值：
|
watermark | string | 否 | 水印參數。 |
text | string | 否 | 水印文字。需經過URL安全的Base64編碼。具體操作，請參見水印編碼。 父節點：watermark |
size | int | 否 | 水印文字字號，取大于0的整數。 父節點：watermark |
t | int | 否 | 水印文字透明度。取值范圍：0~100。 默認值：100，表示透明度100%（不透明）。 父節點：watermark |
color | string | 否 | 水印文字顏色，RGB顏色值，例如：#000000表示黑色，#FFFFFF表示白色。 默認值為#FFFFFF。 父節點：watermark |
rotate | int | 否 | 指定文字順時針旋轉角度。取值范圍：0~360。 默認值為0，表示不旋轉。 父節點：watermark |
type | string | 否 | 指定文字水印的字體，需經過URL Safe的Base64編碼。具體操作，請參見水印編碼。 支持的字體如下：
父節點：watermark |
使用REST API
編輯信息
編輯文檔名稱：example.docx
編輯頁面水印信息：
水印類型：文字水印
水印文字：內部資料
水印字號：30號字體
水印透明度：60
編輯頁面權限信息：
允許用戶導出
允許用戶打印
處理示例
GET /exmaple.docx?x-oss-process=doc/edit,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60 HTTP/1.1
Host: doc-demo.oss-cn-hangzhou.aliyuncs.com
Date: Fri, 28 Oct 2022 06:40:10 GMT
Authorization: OSS qn6q**************:77Dv****************使用SDK
以下僅列舉常見SDK通過處理參數的方式進行文檔在線編輯的代碼示例。如需使用其他SDK進行文檔在線編輯的代碼示例，請參見以下常見SDK自行調整。
Java
要求使用3.17.4及以上版本的Java SDK。
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.OSSObject;
import com.aliyun.oss.model.GetObjectRequest;
import com.aliyuncs.exceptions.ClientException;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
public class Demo1 {
public static void main(String[] args) throws ClientException, ClientException {
// yourEndpoint填寫Bucket所在地域對應的Endpoint。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 填寫Endpoint對應的Region信息，例如cn-hangzhou。
String region = "cn-hangzhou";
// 從環境變量中獲取訪問憑證。運行本代碼示例之前，請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 指定Bucket名稱。
String bucketName = "examplebucket";
// 如果文檔位于Bucket根目錄，則直接填寫文檔名稱。如果文檔不在Bucket根目錄，需攜帶文檔完整路徑，例如exampledir/example.docx。
String key = "example.docx";
// 創建OSSClient實例。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
// 構建文檔在線編輯的處理指令。
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
getObjectRequest.setProcess("doc/edit,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60");
// 使用getObject方法，并通過process參數傳入處理指令。
OSSObject ossObject = ossClient.getObject(getObjectRequest);
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buffer = new byte[1024];
int bytesRead;
while ((bytesRead = ossObject.getObjectContent().read(buffer)) != -1) {
baos.write(buffer, 0, bytesRead);
}
String docEdit = baos.toString("UTF-8");
System.out.println("Doc Edit:");
System.out.println(docEdit);
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
} finally {
// 關閉OSSClient。
ossClient.shutdown();
}
}
}
PHP
要求使用PHP SDK 2.7.0及以上版本。
<?php
if (is_file(__DIR__ . '/../autoload.php')) {
require_once __DIR__ . '/../autoload.php';
}
if (is_file(__DIR__ . '/../vendor/autoload.php')) {
require_once __DIR__ . '/../vendor/autoload.php';
}
use OSS\Credentials\EnvironmentVariableCredentialsProvider;
use OSS\OssClient;
try {
// 從環境變量中獲取訪問憑證。運行本代碼示例之前，請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
$provider = new EnvironmentVariableCredentialsProvider();
// 填寫Bucket所在地域對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
$endpoint = 'https://oss-cn-hangzhou.aliyuncs.com';
// 填寫Bucket名稱，例如examplebucket。
$bucket = 'examplebucket';
// 如果文檔位于Bucket根目錄，則直接填寫文檔名稱。如果文檔不在Bucket根目錄，需攜帶文檔完整路徑，例如exampledir/example.docx。
$key = 'example.docx';
$config = array(
"provider" => $provider,
"endpoint" => $endpoint,
"signatureVersion" => OssClient::OSS_SIGNATURE_VERSION_V4,
// 填寫阿里云通用Region ID。
"region" => "cn-hangzhou"
);
$ossClient = new OssClient($config);
// 構建文檔在線編輯的處理指令。
$options[$ossClient::OSS_PROCESS] = "doc/edit,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60";
$result = $ossClient->getObject($bucket,$key,$options);
var_dump($result);
} catch (OssException $e) {
printf($e->getMessage() . "\n");
return;
}Python
要求使用Python SDK 2.18.4及以上版本。
# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 從環境變量中獲取訪問憑證。運行本代碼示例之前，請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# 填寫Bucket所在地域對應的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = 'https://oss-cn-hangzhou.aliyuncs.com'
# 填寫阿里云通用Region ID。
region = 'cn-hangzhou'
bucket = oss2.Bucket(auth, endpoint, 'examplebucket', region=region)
# 如果文檔文件位于Bucket根目錄，則直接填寫視頻名稱。如果文檔文件不在Bucket根目錄，需攜帶文檔文件完整路徑，例如exampledir/example.docx。
key = 'example.docx'
# 構建文檔在線編輯的處理指令。
process = 'doc/edit,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60'
try:
# 使用get_object方法，并通過process參數傳入處理指令。
result = bucket.get_object(key, process=process)
doc_edit= result.read().decode('utf-8')
print("Doc Edit:")
print(doc_edit)
except oss2.exceptions.OssError as e:
print("Error:", e)Go
要求使用Go SDK 3.0.2及以上版本。
package main
import (
"fmt"
"io"
"os"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 從環境變量中獲取臨時訪問憑證。運行本代碼示例之前，請確保已設置環境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 創建OSSClient實例。
// yourEndpoint填寫Bucket對應的Endpoint，以華東1（杭州）為例，填寫為https://oss-cn-hangzhou.aliyuncs.com。其他Region請按實際情況填寫。
// yourRegion指定阿里云通用Region ID，例如cn-hangzhou。
client, err := oss.New("https://oss-cn-hangzhou.aliyuncs.com", "", "", oss.SetCredentialsProvider(&provider), oss.AuthVersion(oss.AuthV4), oss.Region("cn-hangzhou"))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 指定Bucket名稱，例如examplebucket。
bucketName := "examplebucket"
bucket, err := client.Bucket(bucketName)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
// 如果文檔位于Bucket根目錄，則直接填寫文檔名稱。如果文檔不在Bucket根目錄，需攜帶文檔完整路徑，例如exampledir/example.docx。
// 通過oss.Process方法構建文檔在線編輯的處理指令。
body, err := bucket.GetObject("example.docx", oss.Process("doc/edit,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60"))
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
defer body.Close()
data, err := io.ReadAll(body)
if err != nil {
fmt.Println("Error:", err)
os.Exit(-1)
}
fmt.Println("data:", string(data))
}文檔內容是否對您有幫助？