使用場(chǎng)景

• 企業(yè)知識(shí)庫(kù)或文檔管理系統(tǒng)：?jiǎn)T工可將文件上傳并轉(zhuǎn)化為網(wǎng)頁(yè)格式，方便快速查看，提升信息訪問(wèn)效率和安全性。

• 在線教育平臺(tái)：教師和學(xué)生可以實(shí)時(shí)查看教材、講義和作業(yè)，促進(jìn)互動(dòng)和學(xué)習(xí)體驗(yàn)。

• 協(xié)同辦公與項(xiàng)目管理工具：團(tuán)隊(duì)成員共享的工作計(jì)劃、設(shè)計(jì)稿和報(bào)告文檔可直接在瀏覽器中查看，提升團(tuán)隊(duì)協(xié)作效率。

前提條件

• 已通過(guò)配額中心申請(qǐng)開啟新版本IMM Get和Post數(shù)據(jù)處理能力。

• 已綁定IMM Project。您可以通過(guò)OSS控制臺(tái)或API綁定IMM Project。

  • 通過(guò)OSS控制臺(tái)綁定的具體操作，請(qǐng)參見步驟一：綁定IMM。

  • 通過(guò)API綁定的具體操作，請(qǐng)參見AttachOSSBucket。

注意事項(xiàng)

• 文檔在線預(yù)覽僅支持同步處理（x-oss-process處理方式）。

• 不支持匿名訪問(wèn)

• 必須擁有IMM處理所需的相關(guān)權(quán)限。更多信息，請(qǐng)參見權(quán)限。

• 如果使用OSS默認(rèn)域名訪問(wèn)文件，將下載文檔預(yù)覽HTML頁(yè)面。如果使用自定義域名文檔在線預(yù)覽操作需要您在OSS Bucket綁定自定義域名，通過(guò)自定義域名訪問(wèn)文件時(shí)才能打開預(yù)覽。關(guān)于綁定自定義域名更多信息，請(qǐng)參見綁定自定義域名至Bucket默認(rèn)域名。

參數(shù)說(shuō)明

操作名稱：doc/preview

使用REST API預(yù)覽文檔時(shí)，可根據(jù)以下參數(shù)配置預(yù)覽效果。

使用REST API

GET /exmaple.docx?x-oss-process=doc/preview,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通過(guò)處理參數(shù)的方式在線預(yù)覽文檔的代碼示例。如需使用其他SDK在線預(yù)覽文檔的代碼示例，請(qǐng)參見以下常見SDK自行調(diào)整。

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 Demo {
    public static void main(String[] args) throws ClientException, ClientException {
        // yourEndpoint填寫B(tài)ucket所在地域?qū)?yīng)的Endpoint。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 填寫Endpoint對(duì)應(yīng)的Region信息，例如cn-hangzhou。
        String region = "cn-hangzhou";
        // 從環(huán)境變量中獲取訪問(wèn)憑證。運(yùn)行本代碼示例之前，請(qǐng)確保已設(shè)置環(huán)境變量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";

        // 創(chuàng)建OSSClient實(shí)例。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(credentialsProvider)
                .clientConfiguration(clientBuilderConfiguration)
                .region(region)
                .build();

        try {
            // 構(gòu)建在線預(yù)覽文檔的處理指令。
            GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
            getObjectRequest.setProcess("doc/preview,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60");

            // 使用getObject方法，并通過(guò)process參數(shù)傳入處理指令。
            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 docPreview = baos.toString("UTF-8");
            System.out.println("Doc Preview:");
            System.out.println(docPreview);
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        } finally {
            // 關(guān)閉OSSClient。
            ossClient.shutdown();
        }
    }
}

<?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 {
    // 從環(huán)境變量中獲取訪問(wèn)憑證。運(yùn)行本代碼示例之前，請(qǐng)確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
    $provider = new EnvironmentVariableCredentialsProvider(); 
    // 填寫B(tài)ucket所在地域?qū)?yīng)的Endpoint。以華東1（杭州）為例，Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
    $endpoint = 'https://oss-cn-hangzhou.aliyuncs.com';
    // 填寫B(tài)ucket名稱，例如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);
  // 構(gòu)建在線預(yù)覽文檔的處理指令。
  $options[$ossClient::OSS_PROCESS] = "doc/preview,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;
}

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider

# 從環(huán)境變量中獲取訪問(wèn)憑證。運(yùn)行本代碼示例之前，請(qǐng)確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())

# 填寫B(tài)ucket所在地域?qū)?yīng)的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'

# 構(gòu)建在線預(yù)覽文檔的處理指令。
process = 'doc/preview,export_1,print_1/watermark,text_5YaF6YOo6LWE5paZ,size_30,t_60'

try:
    # 使用get_object方法，并通過(guò)process參數(shù)傳入處理指令來(lái)提取視頻信息。
    result = bucket.get_object(key, process=process)
    # 讀取文檔信息。
    doc_preview= result.read().decode('utf-8')
    print("Doc Preview:")
    print(doc_preview)
except oss2.exceptions.OssError as e:
    print("Error:", e)

package main

import (
	"fmt"
	"io"
	"os"

	"github.com/aliyun/aliyun-oss-go-sdk/oss"
)

func main() {
	// 從環(huán)境變量中獲取臨時(shí)訪問(wèn)憑證。運(yùn)行本代碼示例之前，請(qǐng)確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		fmt.Println("Error:", err)
		os.Exit(-1)
	}
	// 創(chuàng)建OSSClient實(shí)例。
	// yourEndpoint填寫B(tài)ucket對(duì)應(yīng)的Endpoint，以華東1（杭州）為例，填寫為https://oss-cn-hangzhou.aliyuncs.com。其他Region請(qǐng)按實(shí)際情況填寫。
	// 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。
        // 通過(guò)oss.Process方法構(gòu)建在線預(yù)覽文檔的處理指令。
	body, err := bucket.GetObject("example.docx", oss.Process("doc/preview,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))
}

常見問(wèn)題

是否支持預(yù)覽動(dòng)態(tài)PPT中的動(dòng)畫和視頻？

支持。在線預(yù)覽功能最大支持200 MB的文檔，超過(guò)200 MB則無(wú)法訪問(wèn)。

是否支持預(yù)覽圖片文件？

不支持。