Go簡單上傳
本文介紹如何通過簡單上傳方法將本地文件快速上傳到OSS,此方法操作簡便,適合快速將本地文件上傳到云端存儲。
注意事項
本文示例代碼以華東1(杭州)的地域ID
cn-hangzhou
為例,默認使用外網(wǎng)Endpoint,如果您希望通過與OSS同地域的其他阿里云產(chǎn)品訪問OSS,請使用內(nèi)網(wǎng)Endpoint。關(guān)于OSS支持的Region與Endpoint的對應(yīng)關(guān)系,請參見OSS地域和訪問域名。本文以從環(huán)境變量讀取訪問憑證為例。如何配置訪問憑證,請參見配置訪問憑證。
要進行簡單上傳,您必須有
oss:PutObject
權(quán)限。具體操作,請參見為RAM用戶授權(quán)自定義的權(quán)限策略。
方法定義
func (c *Client) PutObject(ctx context.Context, request *PutObjectRequest, optFns ...func(*Options)) (*PutObjectResult, error)
func (c *Client) PutObjectFromFile(ctx context.Context, request *PutObjectRequest, filePath string, optFns ...func(*Options)) (*PutObjectResult, error)
接口名 | 說明 |
Client.PutObject | 簡單上傳, 最大支持5GiB 支持CRC64數(shù)據(jù)校驗(默認啟用) 支持進度條 請求body類型為io.Reader, 當支持io.Seeker類型時,具備失敗重傳 |
Client.PutObjectFromFile | 與Client.PutObject接口能力一致 請求body數(shù)據(jù)來源于文件路徑 |
請求參數(shù)列表
參數(shù)名 | 類型 | 說明 |
ctx | context.Context | 請求的上下文,可以用來設(shè)置請求的總時限 |
request | *PutObjectRequest | 設(shè)置具體接口的請求參數(shù),例如設(shè)置對象的過期時間(Expires)、訪問控制方式(Acl)、禁止覆蓋寫(ForbidOverwrite)、自定義元數(shù)據(jù)(Metadata)等,具體請參見PutObjectRequest |
optFns | ...func(*Options) | (可選)接口級的配置參數(shù), 具體請參見Options |
返回值列表
返回值名 | 類型 | 說明 |
result | *PutObjectResult | 接口返回值,當 err 為nil 時有效,具體請參見PutObjectResult |
err | error | 請求的狀態(tài),當請求失敗時,err 不為 nil |
示例代碼
您可以使用以下代碼將本地文件上傳到目標存儲空間。
package main
import (
"context"
"flag"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 填寫要上傳的本地文件路徑和文件名稱,例如 /Users/localpath/exampleobject.txt
localFile := "/Users/localpath/exampleobject.txt"
// 創(chuàng)建上傳對象的請求
putRequest := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
StorageClass: oss.StorageClassStandard, // 指定對象的存儲類型為標準存儲
Acl: oss.ObjectACLPrivate, // 指定對象的訪問權(quán)限為私有訪問
Metadata: map[string]string{
"yourMetadataKey1": "yourMetadataValue1", // 設(shè)置對象的元數(shù)據(jù)
},
}
// 執(zhí)行上傳對象的請求
result, err := client.PutObjectFromFile(context.TODO(), putRequest, localFile)
if err != nil {
log.Fatalf("failed to put object from file %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object from file result:%#v\n", result)
}
常見使用場景
上傳字符串
您可以使用以下代碼將字符串上傳至目標存儲空間。
package main
import (
"context"
"flag"
"log"
"strings"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 定義要上傳的字符串內(nèi)容
body := strings.NewReader("hi oss")
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 創(chuàng)建上傳對象的請求
request := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
Body: body, // 要上傳的字符串內(nèi)容
}
// 發(fā)送上傳對象的請求
result, err := client.PutObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to put object %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object result:%#v\n", result)
}
上傳Byte數(shù)組
您可以使用以下代碼將Byte數(shù)組上傳至目標存儲空間。
package main
import (
"bytes"
"context"
"flag"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 定義要上傳的byte數(shù)組內(nèi)容
body := bytes.NewReader([]byte("yourObjectValueByteArray"))
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 創(chuàng)建上傳對象的請求
request := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
Body: body, // 要上傳的字符串內(nèi)容
}
// 發(fā)送上傳對象的請求
result, err := client.PutObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to put object %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object result:%#v\n", result)
}
上傳文件流
您可以使用以下代碼將文件流上傳至目標存儲空間。
package main
import (
"context"
"flag"
"io"
"log"
"os"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 定義本地文件名
localFile := "upload.file"
// 創(chuàng)建本地文件
file, err := os.Create(localFile)
if err != nil {
log.Fatalf("failed to create file %v", err)
}
defer file.Close()
// 寫入內(nèi)容到本地文件
_, err = io.WriteString(file, "hi oss")
if err != nil {
log.Fatalf("failed to write content %v", err)
}
// 創(chuàng)建上傳對象的請求
putRequest := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
}
// 發(fā)送上傳對象的請求
result, err := client.PutObjectFromFile(context.TODO(), putRequest, localFile)
if err != nil {
log.Fatalf("failed to put object from file %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object from file result:%#v\n", result)
}
上傳網(wǎng)絡(luò)流
您可以使用以下代碼將網(wǎng)絡(luò)流上傳至目標存儲空間。
package main
import (
"context"
"flag"
"io"
"log"
"net/http"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 指定待上傳的網(wǎng)絡(luò)流
resp, err := http.Get("https://www.aliyun.com/")
if err != nil {
log.Fatalf("Failed to fetch URL: %v", err)
}
defer resp.Body.Close()
// 創(chuàng)建上傳對象的請求
request := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
Body: io.Reader(resp.Body), // 要上傳的網(wǎng)絡(luò)流內(nèi)容
}
// 發(fā)送上傳對象的請求
result, err := client.PutObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to put object %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object result:%#v\n", result)
}
上傳文件時使用進度條
當您在上傳文件時,可以使用進度條實時了解上傳進度,避免因為等待時間過長而感到不安或懷疑任務(wù)是否卡住。
您可以通過以下代碼使用進度條查看上傳文件的進度。
package main
import (
"context"
"flag"
"fmt"
"log"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 填寫要上傳的本地文件路徑和文件名稱,例如 /Users/localpath/exampleobject.txt
localFile := "/Users/localpath/exampleobject.txt"
// 創(chuàng)建上傳對象的請求
putRequest := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
ProgressFn: func(increment, transferred, total int64) {
fmt.Printf("increment:%v, transferred:%v, total:%v\n", increment, transferred, total)
}, // 進度回調(diào)函數(shù),用于顯示上傳進度
}
// 發(fā)送上傳對象的請求
result, err := client.PutObjectFromFile(context.TODO(), putRequest, localFile)
if err != nil {
log.Fatalf("failed to put object from file %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object from file result:%#v\n", result)
}
上傳文件時設(shè)置回調(diào)函數(shù)
OSS在完成簡單上傳(PutObject和PutObjectFromFile)時可以提供回調(diào)(Callback)給應(yīng)用服務(wù)器。您只需要在發(fā)送給OSS的請求中攜帶相應(yīng)的Callback參數(shù),即可實現(xiàn)回調(diào)。
您可以使用以下代碼在上傳文件時設(shè)置回調(diào)函數(shù)。
package main
import (
"context"
"encoding/base64"
"encoding/json"
"flag"
"log"
"strings"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)
// 定義全局變量
var (
region string // 存儲區(qū)域
bucketName string // 存儲空間名稱
objectName string // 對象名稱
)
// init函數(shù)用于初始化命令行參數(shù)
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() {
// 解析命令行參數(shù)
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")
}
// 加載默認配置并設(shè)置憑證提供者和區(qū)域
cfg := oss.LoadDefaultConfig().
WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
WithRegion(region)
// 創(chuàng)建OSS客戶端
client := oss.NewClient(cfg)
// 定義回調(diào)參數(shù)
callbackMap := map[string]string{
"callbackUrl": "http://your.callback.server.address", // 設(shè)置回調(diào)服務(wù)器的URL
"callbackBody": "bucket=${bucket}&object=${object}&my_var_1=${x:my_var1}&my_var_2=${x:my_var2}", // 設(shè)置回調(diào)請求體
"callbackBodyType": "application/json", // 設(shè)置回調(diào)請求體類型
}
// 將回調(diào)參數(shù)轉(zhuǎn)換為JSON并進行Base64編碼,以便將其作為回調(diào)參數(shù)傳遞
callbackStr, err := json.Marshal(callbackMap)
if err != nil {
log.Fatalf("failed to marshal callback map: %v", err)
}
callbackBase64 := base64.StdEncoding.EncodeToString(callbackStr)
// 定義自定義回調(diào)參數(shù)
callbackVarMap := map[string]string{}
callbackVarMap["x:my_var1"] = "thi is var 1"
callbackVarMap["x:my_var2"] = "thi is var 2"
// 將回調(diào)參數(shù)轉(zhuǎn)換為JSON并進行Base64編碼,以便將其作為回調(diào)參數(shù)傳遞
callbackVarStr, err := json.Marshal(callbackVarMap)
if err != nil {
log.Fatalf("failed to marshal callback var: %v", err)
}
callbackVarBase64 := base64.StdEncoding.EncodeToString(callbackVarStr)
// 定義要上傳的字符串內(nèi)容
body := strings.NewReader("Hello, OSS!") // 替換為要上傳的字符串內(nèi)容
// 創(chuàng)建上傳對象的請求
request := &oss.PutObjectRequest{
Bucket: oss.Ptr(bucketName), // 存儲空間名稱
Key: oss.Ptr(objectName), // 對象名稱
Body: body, // 對象內(nèi)容
Callback: oss.Ptr(callbackBase64), // 填寫回調(diào)參數(shù)
CallbackVar: oss.Ptr(callbackVarBase64), // 填寫自定義回調(diào)參數(shù)
}
// 發(fā)送上傳對象的請求
result, err := client.PutObject(context.TODO(), request)
if err != nil {
log.Fatalf("failed to put object %v", err)
}
// 打印上傳對象的結(jié)果
log.Printf("put object result:%#v\n", result)
}
相關(guān)文檔
關(guān)于簡單上傳的完整示例代碼,請參見GitHub示例put_object.go和put_object_from_file.go。
關(guān)于簡單上傳的API接口說明,請參見PutObject和PutObjectFromFile。