'更改了注释'

README.md

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

file.go

@@ -24,8 +24,11 @@ type OssFileInterface interface {
 	GetFileType() *OssFile
 }
 
-// file type transform
+//	@method: FileTypeTransForm
-//@title 文件类型转换
+//	@description: 文件类型转换
+//	@author: mr.x 2021-06-19 00:28:46
+//	@return: *OssFile
+//	@return: error
 func (ossFile *OssFile) FileTypeTransForm() (*OssFile,error) {
 	var err error
 
@@ -100,8 +103,10 @@ func (ossFile *OssFile) FileTypeTransForm() (*OssFile,error) {
 	return ossFile,nil
 }
 
-//split file type and generate file name
+//	@method: GetFileType
-//截取文件类型
+//	@description: 截取文件类型
+//	@author: mr.x 2021-06-19 00:28:52
+//	@return: *OssFile
 func (ossFile *OssFile) GetFileType() *OssFile {
 
 	// 当没有传递文件类型时去文件名中截取出文件类型

oss_client.go

@@ -20,7 +20,9 @@ type AliOssConfigInterface interface {
 	GetAccessibleUrl() string
 }
 
-//check AliOssConfig value is exists
+//	@method: CheckConfig
+//	@description: 校验配置
+//	@author: mr.x 2021-06-19 00:28:17
 func (coon *AliOssConfig) CheckConfig() {
 	//check endPoint
 	if coon.EndPoint == "" || len(coon.EndPoint) <= 0 {
@@ -49,8 +51,10 @@ func (coon *AliOssConfig) CheckConfig() {
 
 }
 
-//en: create oss connect client
+//	@method: CreateOssConnect
-//创建阿里云oss 链接客户端
+//	@description: 创建阿里云oss 链接客户端
+//	@author: mr.x 2021-06-19 00:28:10
+//	@return: *AliOssClient
 func (coon *AliOssConfig) CreateOssConnect() *AliOssClient {
 	//config check
 	coon.CheckConfig()
@@ -82,8 +86,10 @@ func (coon *AliOssConfig) CreateOssConnect() *AliOssClient {
 	}
 }
 
-//get oss accessible url
+//	@method: GetAccessibleUrl
-//拼接阿里云oss可访问地址
+//	@description: 拼接阿里云oss可访问地址
+//	@author: mr.x 2021-06-19 00:28:02
+//	@return: string
 func (coon *AliOssConfig) GetAccessibleUrl() string {
 	var domain string
 

oss_operation.go

@@ -11,18 +11,22 @@ type AliOssClient struct {
 	Client *oss.Bucket
 }
 
-type OssResponse struct {
+type ossResponse struct {
+	Host string
 	LongPath string
 	ShortPath string
 	FileName string
-	Host string
 }
 
-//推送文件到oss
+
-//params:  ossDir string  `oss dir [要推送到的oss目录]`  example: test/20201121/
+//	@method: Put
-//params:  file interface `upload file resource [文件资源]`
+//	@description: 推送文件到oss
-//return string  `oss file accessible uri [可访问地址]`
+//	@author: mr.x 2021-06-19 00:29:08
-func (client *AliOssClient) Put(ossDir string, file interface{},fileType string) *OssResponse {
+//	@param: ossDir string	`[要推送到的oss目录]`  example: test/20201121/
+//	@param: file interface{}	`upload file resource [文件资源]`
+//	@param: fileType string	`文件类型`
+//	@return: *ossResponse 返回oss可访问地址等
+func (client *AliOssClient) Put(ossDir string, file interface{},fileType string) *ossResponse {
 	//file to []byte
 	//文件转字节流
 	uploadFile := &OssFile{
@@ -36,6 +40,7 @@ func (client *AliOssClient) Put(ossDir string, file interface{},fileType string)
 		panic("transfer file failed" + err.Error())
 	}
 
+	// 最终的oss名称
 	var ossFileName string
 
 	//ossPath = oss dir + upload file name
@@ -60,7 +65,7 @@ func (client *AliOssClient) Put(ossDir string, file interface{},fileType string)
 		panic("put file to oss failed:" + err.Error())
 	}
 
-	return &OssResponse{
+	return &ossResponse{
 		Host: client.Domain,
 		LongPath: client.Domain + "/" + ossPath,
 		ShortPath: ossPath,
@@ -68,9 +73,11 @@ func (client *AliOssClient) Put(ossDir string, file interface{},fileType string)
 	}
 }
 
-//校验文件是否已经存在
+//	@method: HasExists
-//check file already exists in oss server
+//	@description: 校验文件是否已经存在
-//params: ossFilePath	string 	`file oss path [文件的oss的路径]`
+//	@author: mr.x 2021-06-19 00:30:21
+//	@param: ossFilePath string	file oss path [文件的oss的路径]
+//	@return: bool
 func (client *AliOssClient) HasExists(ossFilePath string) bool {
 
 	//oss check fun
@@ -83,10 +90,11 @@ func (client *AliOssClient) HasExists(ossFilePath string) bool {
 	return isExists
 }
 
-//删除文件-单文件删除
+//	@method: Delete
-//delete one file in oss
+//	@description: 删除文件-单文件删除
-//params ossPath string `file oss path [文件的oss路径]`
+//	@author: mr.x 2021-06-19 00:30:40
-//return bool
+//	@param: ossFilePath string oss 可访问路径
+//	@return: bool true - 删除成功 | false - 删除失败
 func (client *AliOssClient) Delete(ossFilePath string) bool {
 
 	//oss delete one file fun
@@ -99,10 +107,11 @@ func (client *AliOssClient) Delete(ossFilePath string) bool {
 	return true
 }
 
-//删除文件-多文件删除
+//	@method: DeleteMore
-//delete more file in oss
+//	@description: 删除文件-多文件删除
-//params ossPath []string `file oss path array [文件的oss路径数组]`
+//	@author: mr.x 2021-06-19 00:30:56
-//return bool
+//	@param: ossFilePath []string
+//	@return: bool true - 批量删除成功 | false - 批量删除失败
 func (client *AliOssClient) DeleteMore(ossFilePath []string) bool {
 	//oss delete more file fun
 	_,err := client.Client.DeleteObjects(ossFilePath)
@@ -112,4 +121,31 @@ func (client *AliOssClient) DeleteMore(ossFilePath []string) bool {
 	}
 
 	return true
+}
+
+
+//	@method: GetTemporaryUrl
+//	@description: 获取文件临时地址
+//	@author: mr.x 2021-06-19 00:31:34
+//	@param: path string 文件路径【段路径】
+//	@param: expireInSecond int64 有效时间 秒 默认 60S
+//	@return: string
+func (client *AliOssClient) GetTemporaryUrl(path string,expireInSecond int64) string {
+
+	var expireTime int64
+
+	if expireInSecond <= 0 {
+		expireTime = 60
+	} else {
+		expireTime = expireInSecond
+	}
+
+	signUrl,err := client.Client.SignURL(path,oss.HTTPGet,expireTime)
+
+	if err != nil {
+		panic("generate sign url failed:" + err.Error())
+	}
+
+	return signUrl
+
 }

oss_test.go

@@ -94,3 +94,18 @@ func TestAliOssClient_DeleteMore(t *testing.T) {
 	fmt.Println(deleteRes)
 }
 
+func TestAliOssClient_GetTemporaryUrl(t *testing.T) {
+	ossConfig := &AliOssConfig{
+		EndPoint: "",
+		AccessKeyId: "",
+		AccessKeySecret: "",
+		BucketName: "",
+	}
+
+	client := ossConfig.CreateOssConnect()
+
+	singUrl := client.GetTemporaryUrl("logo/8497b913-2a79-58a1-984b-c25827f8212e.png",180)
+
+	fmt.Println(singUrl)
+}
+