本文介紹如何使用範圍下載方法,協助您高效地擷取檔案中的特定部分資料。
注意事項
本文範例程式碼以華東1(杭州)的地區ID
cn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
許可權說明
阿里雲帳號預設擁有全部許可權。阿里雲帳號下的RAM使用者或RAM角色預設沒有任何許可權,需要阿里雲帳號或帳號管理員通過RAM Policy或Bucket Policy授予操作許可權。
API | Action | 說明 |
GetObject |
| 下載Object。 |
| 下載Object時,如果通過versionId指定了Object的版本,則需要授予此操作的許可權。 | |
| 下載Object時,如果Object的中繼資料套件含X-Oss-Server-Side-Encryption: KMS,則需要此操作的許可權。 |
方法定義
func (c *Client) GetObject(ctx context.Context, request *GetObjectRequest, optFns ...func(*Options)) (*GetObjectResult, error)請求參數列表
參數名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文,可以用來佈建要求的總時限 |
request | *GetObjectRequest | 設定具體介面的請求參數,例如設定Range指定下載範圍,RangeBehavior指定標準行為範圍下載,具體請參見GetObjectRequest |
optFns | ...func(*Options) | (可選)介面級的配置參數, 具體請參見Options |
傳回值列表
傳回值名 | 類型 | 說明 |
result | *GetObjectResult | 介面傳回值,當 err 為nil 時有效,具體請參見GetObjectResult |
err | error | 請求的狀態,當請求失敗時,err 不為 nil |
假設現有大小為1000 Bytes的Object,則指定的正常下載範圍應為0~999。如果指定範圍不在有效區間,會導致Range不生效,響應傳回值為200,並傳送整個Object的內容。請求不合法的樣本及返回說明如下:
若指定了Range: bytes=500-2000,此時範圍末端取值不在有效區間,返回整個檔案的內容,且HTTP Code為200。
若指定了Range: bytes=1000-2000,此時範圍首端取值不在有效區間,返回整個檔案的內容,且HTTP Code為200。
您可以在請求中增加要求標頭x-oss-range-behavior:standard指定標準行為範圍下載,改變指定範圍不在有效區間時OSS的下載行為。假設現有大小為1000 Bytes的Object:
若指定了Range: bytes=500-2000,此時範圍末端取值不在有效區間,返回500~999位元組範圍內容,且HTTP Code為206。
若指定了Range: bytes=1000-2000,此時範圍首端取值不在有效區間,返回HTTP Code為416,錯誤碼為InvalidRange。
範例程式碼
以下代碼展示了在請求中增加要求標頭RangeBehavior:standard來指定標準下載行為,下載指定範圍內的檔案資料。
package main
import (
"context"
"flag"
"io"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全域變數
var (
region string // 儲存地區
bucketName string // 儲存空間名稱
objectName string // 對象名稱
)
// init函數用於初始化命令列參數
func init() {
flag.StringVar(®ion, "region", "", "The region in which the bucket is located.")
flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
flag.StringVar(&objectName, "object", "", "The name of the object.")
}
func main() {
// 解析命令列參數
flag.Parse()
// 檢查bucket名稱是否為空白
if len(bucketName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, bucket name required")
}
// 檢查region是否為空白
if len(region) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, region required")
}
// 檢查object名稱是否為空白
if len(objectName) == 0 {
flag.PrintDefaults()
log.Fatalf("invalid parameters, object name required")
}
// 載入預設配置並設定憑證提供者和地區
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 建立OSS用戶端
client := oss.NewClient(cfg)
// 建立擷取對象的請求
request := &oss.GetObjectRequest{
Bucket: oss.Ptr(bucketName), // 儲存空間名稱
Key: oss.Ptr(objectName), // 對象名稱
Range: oss.Ptr("bytes=15-35"), // 指定下載範圍
RangeBehavior: oss.Ptr("standard"), // 指定標準行為範圍下載
}
// 執行擷取對象的操作並處理結果
result, err := client.GetObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to get object %v", err)
}
defer result.Body.Close() // 確保在函數結束時關閉響應體
log.Printf("get object result:%#v\n", result)
// 讀取對象的內容
data, _ := io.ReadAll(result.Body)
log.Printf("body:%s\n", data)
}