Go下載到本地文件
本文介紹如何將存儲空間(Bucket)中的文件(Object)下載到本地文件。
注意事項
本文以華東1(杭州)外網(wǎng)Endpoint為例。如果您希望通過與OSS同地域的其他阿里云產(chǎn)品訪問OSS,請使用內(nèi)網(wǎng)Endpoint。關(guān)于OSS支持的Region與Endpoint的對應(yīng)關(guān)系,請參見OSS訪問域名、數(shù)據(jù)中心、開放端口。
本文以從環(huán)境變量讀取訪問憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
本文以OSS域名新建OSSClient為例。如果您希望通過自定義域名、STS等方式新建OSSClient,請參見初始化。
要將文件下載到本地,您必須有
oss:GetObject
權(quán)限。具體操作,請參見為RAM用戶授權(quán)自定義的權(quán)限策略。
示例代碼
以下代碼用于將examplebucket
中exampledir
目錄下的exampleobject.txt
文件下載到本地D:\localpath\examplefile.txt
。
package main
import (
"log"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
func main() {
// 從環(huán)境變量中獲取訪問憑證。運(yùn)行本代碼示例之前,請確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 創(chuàng)建OSSClient實例。
// yourEndpoint填寫B(tài)ucket對應(yīng)的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其它Region請按實際情況填寫。
// yourRegion填寫B(tài)ucket所在地域,以華東1(杭州)為例,填寫為cn-hangzhou。其它Region請按實際情況填寫。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 設(shè)置簽名版本
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)
}
// 填寫B(tài)ucket名稱,例如examplebucket。
bucketName := "examplebucket" // 請?zhí)鎿Q為實際的Bucket名稱
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Failed to get bucket: %v", err)
}
// 下載文件到本地文件,并保存到指定的本地路徑中。如果指定的本地文件存在會覆蓋,不存在則新建。
// 如果未指定本地路徑,則下載后的文件默認(rèn)保存到示例程序所屬項目對應(yīng)本地路徑中。
// 依次填寫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.")
}
常見使用場景
當(dāng)從Bucket中下載單個文件(Object)時,您可以指定基于文件最后修改時間或ETag(文件內(nèi)容標(biāo)識符)的條件限制。只有當(dāng)這些條件得到滿足時才會執(zhí)行下載操作;如果不滿足,則會返回錯誤并且不會觸發(fā)下載。利用條件下載不僅可以減少不必要的網(wǎng)絡(luò)傳輸和資源消耗,還能提高下載效率。
OSS支持的限定條件如下:
If-Modified-Since和If-Unmodified-Since可以同時存在。If-Match和If-None-Match也可以同時存在。
您可以通過ossClient.getObjectMeta方法獲取ETag。
參數(shù) | 描述 | 如何設(shè)置 |
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() {
// 從環(huán)境變量中獲取訪問憑證。運(yùn)行本代碼示例之前,請確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Failed to create credentials provider: %v", err)
}
// 創(chuàng)建OSSClient實例。
// yourEndpoint填寫B(tài)ucket對應(yīng)的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其它Region請按實際情況填寫。
// yourRegion填寫B(tài)ucket所在地域,以華東1(杭州)為例,填寫為cn-hangzhou。其它Region請按實際情況填寫。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 設(shè)置簽名版本
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" // 請?zhí)鎿Q為實際的Bucket名稱
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Failed to get bucket: %v", err)
}
// 假設(shè)Object最后修改時間為2023年11月21日18:43:02,則填寫的UTC早于該時間時,將滿足IfModifiedSince的限定條件,并觸發(fā)下載行為。
date := time.Date(2023, time.November, 21, 18, 43, 2, 0, time.UTC)
// yourObjectName填寫不包含Bucket名稱在內(nèi)的Object的完整路徑。
objectName := "yourObjectName" // 請?zhí)鎿Q為實際的對象名稱
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.")
}
當(dāng)您在下載文件時,可以使用進(jìn)度條實時了解下載進(jìn)度,避免因為等待時間過長而感到不安或懷疑任務(wù)是否卡住。
以下代碼用于打印從examplebucket下載exampleobject.txt文件的進(jìn)度條。
package main
import (
"log"
"sync/atomic"
"github.com/aliyun/aliyun-oss-go-sdk/oss"
)
// 定義進(jìn)度條監(jiān)聽器。
type OssProgressListener struct {
lastProgress int64
}
// 定義進(jìn)度變更事件處理函數(shù)。
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() {
// 從環(huán)境變量中獲取訪問憑證。運(yùn)行本代碼示例之前,請確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
provider, err := oss.NewEnvironmentVariableCredentialsProvider()
if err != nil {
log.Fatalf("Error: %v", err)
}
// 創(chuàng)建OSSClient實例。
// yourEndpoint填寫B(tài)ucket對應(yīng)的Endpoint,以華東1(杭州)為例,填寫為https://oss-cn-hangzhou.aliyuncs.com。其它Region請按實際情況填寫。
// yourRegion填寫B(tài)ucket所在地域,以華東1(杭州)為例,填寫為cn-hangzhou。其它Region請按實際情況填寫。
clientOptions := []oss.ClientOption{oss.SetCredentialsProvider(&provider)}
clientOptions = append(clientOptions, oss.Region("yourRegion"))
// 設(shè)置簽名版本
clientOptions = append(clientOptions, oss.AuthVersion(oss.AuthV4))
client, err := oss.New("yourEndpoint", "", "", clientOptions...)
if err != nil {
log.Fatalf("Error: %v", err)
}
// 填寫B(tài)ucket名稱。
bucketName := "examplebucket"
// 填寫Object完整路徑。Object完整路徑中不能包含Bucket名稱。
objectName := "exampleobject.txt"
// 填寫本地文件的完整路徑。如果指定的本地文件存在會覆蓋,不存在則新建。
// 如果未指定本地路徑,則下載后的文件默認(rèn)保存到示例程序所屬項目對應(yīng)本地路徑中。
localFile := "D:\\localpath\\examplefile.txt"
// 獲取存儲空間。
bucket, err := client.Bucket(bucketName)
if err != nil {
log.Fatalf("Error: %v", err)
}
// 帶進(jìn)度條的下載。
err = bucket.GetObjectToFile(objectName, localFile, oss.Progress(&OssProgressListener{}))
if err != nil {
log.Fatalf("Error: %v", err)
}
log.Println("Transfer Completed.")
}
相關(guān)文檔
關(guān)于下載到本地文件的完整示例代碼,請參見GitHub示例。
關(guān)于下載到本地文件的API接口說明,請參見GetObjectToFile。