:zap:优化

README.md

@@ -44,6 +44,4 @@ go get github.com/cowardmrx/go_aliyun_oss
     })
     fmt.Println(isSuccess)
 	
-
-
-
+#详细使用方法请参照oss_test.go文件中的示例

file.go

@@ -1,6 +1,7 @@
 package go_aliyun_oss
 
 import (
+	"errors"
 	"fmt"
 	uuid "github.com/satori/go.uuid"
 	"io/ioutil"
@@ -12,39 +13,39 @@ import (
 )
 
 type OssFile struct {
-	FileByte []byte
+	FileByte    []byte
 	FileOldName string
 	FileNewName string
-	FileType string
-	File	interface{}
+	FileType    string
+	File        interface{}
 }
 
 type OssFileInterface interface {
-	FileTypeTransForm() (*OssFile,error)
+	FileTypeTransForm() (*OssFile, error)
 	GetFileType() *OssFile
 }
 
-// file type transform
-//@title 文件类型转换
-func (ossFile *OssFile) FileTypeTransForm() (*OssFile,error) {
+// FileTypeTransForm file type transform
+// @title 文件类型转换
+func (ossFile *OssFile) FileTypeTransForm() (*OssFile, error) {
 	var err error
 
 	switch ossFile.File.(type) {
 	case *os.File:
 
-		ossFile.FileByte,err = ioutil.ReadAll(ossFile.File.(*os.File))
+		ossFile.FileByte, err = ioutil.ReadAll(ossFile.File.(*os.File))
 
 		if err != nil {
-			panic("read os type file failed:" + err.Error())
+			return nil, errors.New("read os type file failed:" + err.Error())
 		}
 
-		_,ossFile.FileOldName = filepath.Split(ossFile.File.(*os.File).Name())
+		_, ossFile.FileOldName = filepath.Split(ossFile.File.(*os.File).Name())
 
 		break
 
 	case *multipart.FileHeader:
 
-		fileResources,err := ossFile.File.(*multipart.FileHeader).Open()
+		fileResources, err := ossFile.File.(*multipart.FileHeader).Open()
 
 		if err != nil {
 			panic("open multipart file failed:" + err.Error())
@@ -52,10 +53,10 @@ func (ossFile *OssFile) FileTypeTransForm() (*OssFile,error) {
 
 		defer fileResources.Close()
 
-		ossFile.FileByte,err = ioutil.ReadAll(fileResources)
+		ossFile.FileByte, err = ioutil.ReadAll(fileResources)
 
 		if err != nil {
-			panic("read multipart file failed:" + err.Error())
+			return nil, errors.New("read multipart file failed:" + err.Error())
 		}
 
 		ossFile.FileOldName = ossFile.File.(*multipart.FileHeader).Filename
@@ -63,17 +64,17 @@ func (ossFile *OssFile) FileTypeTransForm() (*OssFile,error) {
 		break
 
 	case string:
-		newFile,err := os.Open(ossFile.File.(string))
+		newFile, err := os.Open(ossFile.File.(string))
 
 		if err != nil {
-			panic("open file path failed:" + err.Error())
+			return nil, errors.New("open file path failed:" + err.Error())
 		}
 
 		defer newFile.Close()
 
-		ossFile.FileByte,err = ioutil.ReadAll(newFile)
+		ossFile.FileByte, err = ioutil.ReadAll(newFile)
 
-		_,ossFile.FileOldName = filepath.Split(newFile.Name())
+		_, ossFile.FileOldName = filepath.Split(newFile.Name())
 
 		break
 
@@ -92,22 +93,22 @@ func (ossFile *OssFile) FileTypeTransForm() (*OssFile,error) {
 
 	default:
 		fmt.Println(reflect.TypeOf(ossFile.File))
-		panic("file type is not support" )
+		return nil, errors.New("file type is not support")
 	}
 
 	ossFile.GetFileType()
 
-	return ossFile,nil
+	return ossFile, nil
 }
 
-//split file type and generate file name
-//截取文件类型
+// GetFileType split file type and generate file name
+// 截取文件类型
 func (ossFile *OssFile) GetFileType() *OssFile {
 
 	// 当没有传递文件类型时去文件名中截取出文件类型
 	if ossFile.FileType == "" || len(ossFile.FileType) <= 0 {
 		//from oldFileName split file type
-		fileTypeSufIndex := strings.Index(ossFile.FileOldName,".")
+		fileTypeSufIndex := strings.Index(ossFile.FileOldName, ".")
 
 		fileType := ossFile.FileOldName[fileTypeSufIndex:]
 
@@ -115,7 +116,7 @@ func (ossFile *OssFile) GetFileType() *OssFile {
 	}
 
 	//generate only file name
-	ossFile.FileNewName = uuid.NewV5(uuid.NewV4(),ossFile.FileOldName).String() + ossFile.FileType
+	ossFile.FileNewName = uuid.NewV5(uuid.NewV4(), ossFile.FileOldName).String() + ossFile.FileType
 
 	return ossFile
-}
+}

go.mod

@@ -3,7 +3,7 @@ module github.com/cowardmrx/go_aliyun_oss
 go 1.15
 
 require (
-	github.com/aliyun/aliyun-oss-go-sdk v2.1.5+incompatible
+	github.com/aliyun/aliyun-oss-go-sdk v2.2.5+incompatible
 	github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f // indirect
 	github.com/satori/go.uuid v1.2.0
 	golang.org/x/time v0.0.0-20200630173020-3af7569d3a1e // indirect

go.sum

@@ -1,5 +1,7 @@
 github.com/aliyun/aliyun-oss-go-sdk v2.1.5+incompatible h1:v5yDfjkRY/kOxu05gkh0/D/2wYxbTFCoTr3JqFI0FLE=
 github.com/aliyun/aliyun-oss-go-sdk v2.1.5+incompatible/go.mod h1:T/Aws4fEfogEE9v+HPhhw+CntffsBHJ8nXQCwKr0/g8=
+github.com/aliyun/aliyun-oss-go-sdk v2.2.5+incompatible h1:QoRMR0TCctLDqBCMyOu1eXdZyMw3F7uGA9qPn2J4+R8=
+github.com/aliyun/aliyun-oss-go-sdk v2.2.5+incompatible/go.mod h1:T/Aws4fEfogEE9v+HPhhw+CntffsBHJ8nXQCwKr0/g8=
 github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f h1:ZNv7On9kyUzm7fvRZumSyy/IUiSC7AzL0I1jKKtwooA=
 github.com/baiyubin/aliyun-sts-go-sdk v0.0.0-20180326062324-cfa1a18b161f/go.mod h1:AuiFmCCPBSrqvVMvuqFuk0qogytodnVFVSN5CeJB8Gc=
 github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=

oss_client.go

@@ -20,7 +20,7 @@ type AliOssConfigInterface interface {
 	GetAccessibleUrl() string
 }
 
-//check AliOssConfig value is exists
+// CheckConfig check AliOssConfig value is exists
 func (coon *AliOssConfig) CheckConfig() {
 	//check endPoint
 	if coon.EndPoint == "" || len(coon.EndPoint) <= 0 {
@@ -49,7 +49,7 @@ func (coon *AliOssConfig) CheckConfig() {
 
 }
 
-//en: create oss connect client
+// CreateOssConnect en: create oss connect client
 //创建阿里云oss 链接客户端
 func (coon *AliOssConfig) CreateOssConnect() *AliOssClient {
 	//config check
@@ -82,7 +82,7 @@ func (coon *AliOssConfig) CreateOssConnect() *AliOssClient {
 	}
 }
 
-//get oss accessible url
+// GetAccessibleUrl get oss accessible url
 //拼接阿里云oss可访问地址
 func (coon *AliOssConfig) GetAccessibleUrl() string {
 	var domain string

oss_operation.go

@@ -2,40 +2,42 @@ package go_aliyun_oss
 
 import (
 	"bytes"
+	"errors"
 	"github.com/aliyun/aliyun-oss-go-sdk/oss"
 )
 
 type AliOssClient struct {
-	Domain string
+	Domain           string
 	OriginalFileName bool
-	Client *oss.Bucket
+	Client           *oss.Bucket
 }
 
-type OssResponse struct {
-	LongPath string
+type ossResponse struct {
+	Host      string
+	LongPath  string
 	ShortPath string
-	FileName string
-	Host string
+	FileName  string
 }
 
-//推送文件到oss
-//params:  ossDir string  `oss dir [要推送到的oss目录]`  example: test/20201121/
-//params:  file interface `upload file resource [文件资源]`
-//return string  `oss file accessible uri [可访问地址]`
-func (client *AliOssClient) Put(ossDir string, file interface{},fileType string) *OssResponse {
+// Put 推送文件到oss
+// params:  ossDir string  `oss dir [要推送到的oss目录]`  example: test/20201121/
+// params:  file interface `upload file resource [文件资源]`
+// return string  `oss file accessible uri [可访问地址]`
+func (client *AliOssClient) Put(ossDir string, file interface{}, fileType string) (*ossResponse, error) {
 	//file to []byte
 	//文件转字节流
 	uploadFile := &OssFile{
-		File: file,
+		File:     file,
 		FileType: fileType,
 	}
 
-	ossFile,err := uploadFile.FileTypeTransForm()
+	ossFile, err := uploadFile.FileTypeTransForm()
 
 	if err != nil {
-		panic("transfer file failed" + err.Error())
+		return nil, err
 	}
 
+	// 最终的oss名称
 	var ossFileName string
 
 	//ossPath = oss dir + upload file name
@@ -54,62 +56,85 @@ func (client *AliOssClient) Put(ossDir string, file interface{},fileType string)
 	}
 
 	//upload file to oss
-	err = client.Client.PutObject(ossPath,bytes.NewReader(ossFile.FileByte))
+	err = client.Client.PutObject(ossPath, bytes.NewReader(ossFile.FileByte))
 
 	if err != nil {
-		panic("put file to oss failed:" + err.Error())
+		return nil, errors.New("put file to oss failed:" + err.Error())
 	}
 
-	return &OssResponse{
-		Host: client.Domain,
-		LongPath: client.Domain + "/" + ossPath,
+	return &ossResponse{
+		Host:      client.Domain,
+		LongPath:  client.Domain + "/" + ossPath,
 		ShortPath: ossPath,
-		FileName: ossFileName,
-	}
+		FileName:  ossFileName,
+	}, nil
 }
 
-//校验文件是否已经存在
-//check file already exists in oss server
-//params: ossFilePath	string 	`file oss path [文件的oss的路径]`
-func (client *AliOssClient) HasExists(ossFilePath string) bool {
+// HasExists 校验文件是否已经存在
+// check file already exists in oss server
+// params: ossFilePath	string 	`file oss path [文件的oss的路径]`
+func (client *AliOssClient) HasExists(ossFilePath string) (bool, error) {
 
 	//oss check fun
-	isExists,err := client.Client.IsObjectExist(ossFilePath)
+	isExists, err := client.Client.IsObjectExist(ossFilePath)
 
 	if err != nil {
-		panic("check file in oss is exists failed:" + err.Error())
+		return false, errors.New("check file in oss is exists failed:" + err.Error())
 	}
 
-	return isExists
+	return isExists, nil
 }
 
-//删除文件-单文件删除
-//delete one file in oss
-//params ossPath string `file oss path [文件的oss路径]`
-//return bool
-func (client *AliOssClient) Delete(ossFilePath string) bool {
+// Delete 删除文件-单文件删除
+// delete one file in oss
+// params ossPath string `file oss path [文件的oss路径]`
+// return bool
+func (client *AliOssClient) Delete(ossFilePath string) (bool, error) {
 
 	//oss delete one file fun
 	err := client.Client.DeleteObject(ossFilePath)
 
 	if err != nil {
-		panic("delete file "+ ossFilePath +" failed:" + err.Error())
+		return false, errors.New("delete file " + ossFilePath + " failed:" + err.Error())
 	}
 
-	return true
+	return true, nil
 }
 
-//删除文件-多文件删除
-//delete more file in oss
-//params ossPath []string `file oss path array [文件的oss路径数组]`
-//return bool
-func (client *AliOssClient) DeleteMore(ossFilePath []string) bool {
+// DeleteMore 删除文件-多文件删除
+// delete more file in oss
+// params ossPath []string `file oss path array [文件的oss路径数组]`
+// return bool
+func (client *AliOssClient) DeleteMore(ossFilePath []string) (bool, error) {
 	//oss delete more file fun
-	_,err := client.Client.DeleteObjects(ossFilePath)
+	_, err := client.Client.DeleteObjects(ossFilePath)
 
 	if err != nil {
-		panic("delete more file in oss failed:" + err.Error())
+		return false, errors.New("delete more file in oss failed:" + err.Error())
 	}
 
-	return true
-}
+	return true, nil
+}
+
+// GetTemporaryUrl 获取文件临时地址
+// path string 文件路径
+// expireInSecond int64 多久后过期 单位: 秒，默认 60
+func (client *AliOssClient) GetTemporaryUrl(path string, expireInSecond int64) (string, error) {
+
+	var expireTime int64
+
+	if expireInSecond <= 0 {
+		expireTime = 60
+	} else {
+		expireTime = expireInSecond
+	}
+
+	signUrl, err := client.Client.SignURL(path, oss.HTTPGet, expireTime)
+
+	if err != nil {
+		return "", errors.New("generate sign url failed:" + err.Error())
+	}
+
+	return signUrl, nil
+
+}

oss_test.go

@@ -7,51 +7,49 @@ import (
 	"testing"
 )
 
-func TestPut(t *testing.T)  {
+func TestPut(t *testing.T) {
 	ossConfig := &AliOssConfig{
-		EndPoint: "",
-		AccessKeyId: "",
+		EndPoint:        "",
+		AccessKeyId:     "",
 		AccessKeySecret: "",
-		BucketName: "",
+		BucketName:      "",
 	}
 
 	client := ossConfig.CreateOssConnect()
 
-	uri := client.Put("logo/","./File/3HaqWaOzJWD86DDvZD9Pmn9VUEOBOBbuWackGOXb (2).jpeg",".png")
+	uri := client.Put("logo/", "./File/3HaqWaOzJWD86DDvZD9Pmn9VUEOBOBbuWackGOXb (2).jpeg", ".png")
 
 	fmt.Println(uri)
 }
 
-func TestPutBase64(t *testing.T)  {
+func TestPutBase64(t *testing.T) {
 	ossConfig := &AliOssConfig{
-		EndPoint: "",
-		AccessKeyId: "",
+		EndPoint:        "",
+		AccessKeyId:     "",
 		AccessKeySecret: "",
-		BucketName: "",
+		BucketName:      "",
 	}
 
 	client := ossConfig.CreateOssConnect()
 
 	// 读取base
-	file,_ := ioutil.ReadFile("./File/3HaqWaOzJWD86DDvZD9Pmn9VUEOBOBbuWackGOXb (2).jpeg")
-
+	file, _ := ioutil.ReadFile("./File/3HaqWaOzJWD86DDvZD9Pmn9VUEOBOBbuWackGOXb (2).jpeg")
 
 	fileStr := base64.StdEncoding.EncodeToString(file)
 
-	bat,_ := base64.StdEncoding.DecodeString(fileStr)
+	bat, _ := base64.StdEncoding.DecodeString(fileStr)
 
-
-	uri := client.Put("logo/",bat,".png")
+	uri := client.Put("logo/", bat, ".png")
 	//
 	fmt.Println(uri)
 }
 
-func TestExists(t *testing.T)  {
+func TestExists(t *testing.T) {
 	ossConfig := &AliOssConfig{
-		EndPoint: "oss-cn-shenzhen.aliyuncs.com",
-		AccessKeyId: "",
+		EndPoint:        "oss-cn-shenzhen.aliyuncs.com",
+		AccessKeyId:     "",
 		AccessKeySecret: "",
-		BucketName: "",
+		BucketName:      "",
 	}
 
 	client := ossConfig.CreateOssConnect()
@@ -63,10 +61,10 @@ func TestExists(t *testing.T)  {
 
 func TestDelete(t *testing.T) {
 	ossConfig := &AliOssConfig{
-		EndPoint: "oss-cn-shenzhen.aliyuncs.com",
-		AccessKeyId: "",
+		EndPoint:        "oss-cn-shenzhen.aliyuncs.com",
+		AccessKeyId:     "",
 		AccessKeySecret: "",
-		BucketName: "",
+		BucketName:      "",
 	}
 
 	client := ossConfig.CreateOssConnect()
@@ -78,10 +76,10 @@ func TestDelete(t *testing.T) {
 
 func TestAliOssClient_DeleteMore(t *testing.T) {
 	ossConfig := &AliOssConfig{
-		EndPoint: "oss-cn-shenzhen.aliyuncs.com",
-		AccessKeyId: "",
+		EndPoint:        "oss-cn-shenzhen.aliyuncs.com",
+		AccessKeyId:     "",
 		AccessKeySecret: "",
-		BucketName: "",
+		BucketName:      "",
 	}
 
 	client := ossConfig.CreateOssConnect()
@@ -94,3 +92,17 @@ func TestAliOssClient_DeleteMore(t *testing.T) {
 	fmt.Println(deleteRes)
 }
 
+func TestAliOssClient_GetTemporaryUrl(t *testing.T) {
+	ossConfig := &AliOssConfig{
+		EndPoint:        "https://oss-cn-hangzhou.aliyuncs.com",
+		AccessKeyId:     "",
+		AccessKeySecret: "",
+		BucketName:      "",
+	}
+
+	client := ossConfig.CreateOssConnect()
+
+	singUrl := client.GetTemporaryUrl("", 180)
+
+	fmt.Println(singUrl)
+}