全部產品
Search
文件中心

Object Storage Service:Go下載到本地檔案

更新時間:Oct 26, 2024

本文介紹如何將儲存空間(Bucket)中的檔案(Object)下載到本地檔案。

注意事項

  • 本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS訪問網域名稱、資料中心、開放連接埠

  • 本文以從環境變數讀取存取憑證為例。如何配置訪問憑證,請參見配置訪問憑證

  • 本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見初始化

  • 要將檔案下載到本地,您必須有oss:GetObject許可權。具體操作,請參見為RAM使用者授權自訂的權限原則

範例程式碼

以下代碼用於將examplebucketexampledir目錄下的exampleobject.txt檔案下載到本地D:\localpath\examplefile.txt

package main

import (
	"log"

	"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 {
		log.Fatalf("Failed to create credentials provider: %v", err)
	}

	// 建立OSSClient執行個體。
	// yourEndpoint填寫Bucket對應的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其它Region請按實際情況填寫。
	// yourRegion填寫Bucket所在地區,以華東1(杭州)為例,填寫為cn-hangzhou。其它Region請按實際情況填寫。
	clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
	clientOptions = append(clientOptions, oss.Region("yourRegion"))
	// 設定簽名版本
	clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
	client, err := oss.New("yourEndpoint", "", "", clientOptions...)
	if err != nil {
		log.Fatalf("Failed to create OSS client: %v", err)
	}

	// 填寫Bucket名稱,例如examplebucket。
	bucketName := "examplebucket" // 請替換為實際的Bucket名稱
	bucket, err := client.Bucket(bucketName)
	if err != nil {
		log.Fatalf("Failed to get bucket: %v", err)
	}

	// 下載檔案到本地檔案,並儲存到指定的本地路徑中。如果指定的本地檔案存在會覆蓋,不存在則建立。
	// 如果未指定本地路徑,則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
	// 依次填寫Object完整路徑(例如exampledir/exampleobject.txt)和本地檔案的完整路徑(例如D:\\localpath\\examplefile.txt)。Object完整路徑中不能包含Bucket名稱。
	objectName := "exampledir/exampleobject.txt"
	localFilePath := "D:\\localpath\\examplefile.txt"
	err = bucket.GetObjectToFile(objectName, localFilePath)
	if err != nil {
		log.Fatalf("Failed to download file: %v", err)
	}

	log.Println("File downloaded successfully.")
}

常見使用情境

根據限定條件下載

當從Bucket中下載單個檔案(Object)時,您可以指定基於檔案最後修改時間或ETag(檔案內容標識符)的條件限制。只有當這些條件得到滿足時才會執行下載操作;如果不滿足,則會返回錯誤並且不會觸發下載。利用條件下載不僅可以減少不必要的網路傳輸和資源消耗,還能提高下載效率。

OSS支援的限定條件如下:

說明
  • If-Modified-Since和If-Unmodified-Since可以同時存在。If-Match和If-None-Match也可以同時存在。

  • 您可以通過ossClient.getObjectMeta方法擷取ETag。

參數

描述

如何設定

IfModifiedSince

如果指定的時間早於實際修改時間,則正常傳輸檔案,否則返回錯誤(304 Not modified)。

oss.IfModifiedSince

IfUnmodifiedSince

如果指定的時間等於或者晚於檔案實際修改時間,則正常傳輸檔案,否則返回錯誤(412 Precondition failed)。

oss.IfUnmodifiedSince

IfMatch

如果指定的ETag和OSS檔案的ETag匹配,則正常傳輸檔案,否則返回錯誤(412 Precondition failed)。

oss.IfMatch

IfNoneMatch

如果指定的ETag和OSS檔案的ETag不匹配,則正常傳輸檔案,否則返回錯誤(304 Not modified)。

oss.IfNoneMatch

以下代碼用於限定條件下載。

package main

import (
	"log"
	"time"

	"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 {
		log.Fatalf("Failed to create credentials provider: %v", err)
	}

	// 建立OSSClient執行個體。
	// yourEndpoint填寫Bucket對應的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其它Region請按實際情況填寫。
	// yourRegion填寫Bucket所在地區,以華東1(杭州)為例,填寫為cn-hangzhou。其它Region請按實際情況填寫。
	clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
	clientOptions = append(clientOptions, oss.Region("yourRegion"))
	// 設定簽名版本
	clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
	client, err := oss.New("yourEndpoint", "", "", clientOptions...)
	if err != nil {
		log.Fatalf("Failed to create OSS client: %v", err)
	}

	// yourBucketName填寫儲存空間名稱。
	bucketName := "yourBucketName" // 請替換為實際的Bucket名稱
	bucket, err := client.Bucket(bucketName)
	if err != nil {
		log.Fatalf("Failed to get bucket: %v", err)
	}

	// 假設Object最後修改時間為2023年11月21日18:43:02,則填寫的UTC早於該時間時,將滿足IfModifiedSince的限定條件,並觸發下載行為。
	date := time.Date(2023, time.November, 21, 18, 43, 2, 0, time.UTC)

	// yourObjectName填寫不包含Bucket名稱在內的Object的完整路徑。
	objectName := "yourObjectName" // 請替換為實際的對象名稱
	localFilePath := "LocalFile"   // 本地檔案路徑

	// 不滿足限定條件,不下載檔案。
	err = bucket.GetObjectToFile(objectName, localFilePath, oss.IfUnmodifiedSince(date))
	if err == nil {
		log.Fatal("Expected an error when the condition is not met, but got nil")
	}

	// 滿足限定條件,下載檔案。
	err = bucket.GetObjectToFile(objectName, localFilePath, oss.IfModifiedSince(date))
	if err != nil {
		log.Fatalf("Failed to download file: %v", err)
	}

	log.Println("File has been downloaded successfully.")
}

列印下載檔案的進度條

當您在下載檔案時,可以使用進度條即時瞭解下載進度,避免因為等待時間過長而感到不安或懷疑任務是否卡住。

以下代碼用於列印從examplebucket下載exampleobject.txt檔案的進度條。

package main

import (
	"log"
	"sync/atomic"

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

// 定義進度條監聽器。
type OssProgressListener struct {
	lastProgress int64
}

// 定義進度變更事件處理函數。
func (listener *OssProgressListener) ProgressChanged(event *oss.ProgressEvent) {
	switch event.EventType {
	case oss.TransferStartedEvent:
		log.Printf("Transfer Started, ConsumedBytes: %d, TotalBytes %d.\n",
			event.ConsumedBytes, event.TotalBytes)
	case oss.TransferDataEvent:
		if event.TotalBytes != 0 {
			progress := int64(event.ConsumedBytes * 100 / event.TotalBytes)
			if progress > atomic.LoadInt64(&listener.lastProgress) {
				atomic.StoreInt64(&listener.lastProgress, progress)
				log.Printf("\rTransfer Data, ConsumedBytes: %d, TotalBytes %d, %d%%.",
					event.ConsumedBytes, event.TotalBytes, progress)
			}
		}
	case oss.TransferCompletedEvent:
		log.Printf("\nTransfer Completed, ConsumedBytes: %d, TotalBytes %d.\n",
			event.ConsumedBytes, event.TotalBytes)
	case oss.TransferFailedEvent:
		log.Printf("\nTransfer Failed, ConsumedBytes: %d, TotalBytes %d.\n",
			event.ConsumedBytes, event.TotalBytes)
	default:
	}
}

func main() {
	// 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
	provider, err := oss.NewEnvironmentVariableCredentialsProvider()
	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	// 建立OSSClient執行個體。
	// yourEndpoint填寫Bucket對應的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其它Region請按實際情況填寫。
	// yourRegion填寫Bucket所在地區,以華東1(杭州)為例,填寫為cn-hangzhou。其它Region請按實際情況填寫。
	clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
	clientOptions = append(clientOptions, oss.Region("yourRegion"))
	// 設定簽名版本
	clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
	client, err := oss.New("yourEndpoint", "", "", clientOptions...)
	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	// 填寫Bucket名稱。
	bucketName := "examplebucket"
	// 填寫Object完整路徑。Object完整路徑中不能包含Bucket名稱。
	objectName := "exampleobject.txt"
	// 填寫本地檔案的完整路徑。如果指定的本地檔案存在會覆蓋,不存在則建立。
	// 如果未指定本地路徑,則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
	localFile := "D:\\localpath\\examplefile.txt"

	// 擷取儲存空間。
	bucket, err := client.Bucket(bucketName)
	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	// 帶進度條的下載。
	err = bucket.GetObjectToFile(objectName, localFile, oss.Progress(&OssProgressListener{}))
	if err != nil {
		log.Fatalf("Error: %v", err)
	}
	log.Println("Transfer Completed.")
}

相關文檔

  • 關於下載到本地檔案的完整範例程式碼,請參見GitHub樣本

  • 關於下載到本地檔案的API介面說明,請參見GetObjectToFile