multipart.go 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. package oss
  2. import (
  3. "bytes"
  4. "encoding/xml"
  5. "io"
  6. "net/http"
  7. "os"
  8. "sort"
  9. "strconv"
  10. )
  11. //
  12. // InitiateMultipartUpload 初始化分片上传任务。
  13. //
  14. // objectKey Object名称。
  15. // options 上传时可以指定Object的属性,可选属性有CacheControl、ContentDisposition、ContentEncoding、Expires、
  16. // ServerSideEncryption、Meta,具体含义请参考
  17. // https://help.aliyun.com/document_detail/oss/api-reference/multipart-upload/InitiateMultipartUpload.html
  18. //
  19. // InitiateMultipartUploadResult 初始化后操作成功的返回值,用于后面的UploadPartFromFile、UploadPartCopy等操作。error为nil时有效。
  20. // error 操作成功error为nil,非nil为错误信息。
  21. //
  22. func (bucket Bucket) InitiateMultipartUpload(objectKey string, options ...Option) (InitiateMultipartUploadResult, error) {
  23. var imur InitiateMultipartUploadResult
  24. opts := addContentType(options, objectKey)
  25. resp, err := bucket.do("POST", objectKey, "uploads", "uploads", opts, nil)
  26. if err != nil {
  27. return imur, err
  28. }
  29. defer resp.Body.Close()
  30. err = xmlUnmarshal(resp.Body, &imur)
  31. return imur, err
  32. }
  33. //
  34. // UploadPart 上传分片。
  35. //
  36. // 初始化一个Multipart Upload之后,可以根据指定的Object名和Upload ID来分片(Part)上传数据。
  37. // 每一个上传的Part都有一个标识它的号码(part number,范围是1~10000)。对于同一个Upload ID,
  38. // 该号码不但唯一标识这一片数据,也标识了这片数据在整个文件内的相对位置。如果您用同一个part号码,上传了新的数据,
  39. // 那么OSS上已有的这个号码的Part数据将被覆盖。除了最后一片Part以外,其他的part最小为100KB;
  40. // 最后一片Part没有大小限制。
  41. //
  42. // imur InitiateMultipartUpload成功后的返回值。
  43. // reader io.Reader 需要分片上传的reader。
  44. // size 本次上传片Part的大小。
  45. // partNumber 本次上传片(Part)的编号,范围是1~10000。如果超出范围,OSS将返回InvalidArgument错误。
  46. //
  47. // UploadPart 上传成功的返回值,两个成员PartNumber、ETag。PartNumber片编号,即传入参数partNumber;
  48. // ETag及上传数据的MD5。error为nil时有效。
  49. // error 操作成功error为nil,非nil为错误信息。
  50. //
  51. func (bucket Bucket) UploadPart(imur InitiateMultipartUploadResult, reader io.Reader,
  52. partSize int64, partNumber int) (UploadPart, error) {
  53. request := &UploadPartRequest{
  54. InitResult: &imur,
  55. Reader: reader,
  56. PartSize: partSize,
  57. PartNumber: partNumber,
  58. }
  59. result, err := bucket.DoUploadPart(request)
  60. return result.Part, err
  61. }
  62. //
  63. // UploadPartFromFile 上传分片。
  64. //
  65. // imur InitiateMultipartUpload成功后的返回值。
  66. // filePath 需要分片上传的本地文件。
  67. // startPosition 本次上传文件片的起始位置。
  68. // partSize 本次上传文件片的大小。
  69. // partNumber 本次上传文件片的编号,范围是1~10000。
  70. //
  71. // UploadPart 上传成功的返回值,两个成员PartNumber、ETag。PartNumber片编号,传入参数partNumber;
  72. // ETag上传数据的MD5。error为nil时有效。
  73. // error 操作成功error为nil,非nil为错误信息。
  74. //
  75. func (bucket Bucket) UploadPartFromFile(imur InitiateMultipartUploadResult, filePath string,
  76. startPosition, partSize int64, partNumber int) (UploadPart, error) {
  77. var part = UploadPart{}
  78. fd, err := os.Open(filePath)
  79. if err != nil {
  80. return part, err
  81. }
  82. defer fd.Close()
  83. fd.Seek(startPosition, os.SEEK_SET)
  84. request := &UploadPartRequest{
  85. InitResult: &imur,
  86. Reader: fd,
  87. PartSize: partSize,
  88. PartNumber: partNumber,
  89. }
  90. result, err := bucket.DoUploadPart(request)
  91. return result.Part, err
  92. }
  93. //
  94. // DoUploadPart 上传分片。
  95. //
  96. // request 上传分片请求。
  97. //
  98. // UploadPartResult 上传分片请求返回值。
  99. // error 操作无错误为nil,非nil为错误信息。
  100. //
  101. func (bucket Bucket) DoUploadPart(request *UploadPartRequest) (*UploadPartResult, error) {
  102. params := "partNumber=" + strconv.Itoa(request.PartNumber) + "&uploadId=" + request.InitResult.UploadID
  103. opts := []Option{ContentLength(request.PartSize)}
  104. resp, err := bucket.do("PUT", request.InitResult.Key, params, params, opts,
  105. &io.LimitedReader{R: request.Reader, N: request.PartSize})
  106. if err != nil {
  107. return &UploadPartResult{}, err
  108. }
  109. defer resp.Body.Close()
  110. part := UploadPart{
  111. ETag: resp.Headers.Get(HTTPHeaderEtag),
  112. PartNumber: request.PartNumber,
  113. }
  114. if bucket.getConfig().IsEnableCRC {
  115. err = checkCRC(resp, "DoUploadPart")
  116. if err != nil {
  117. return &UploadPartResult{part}, err
  118. }
  119. }
  120. return &UploadPartResult{part}, nil
  121. }
  122. //
  123. // UploadPartCopy 拷贝分片。
  124. //
  125. // imur InitiateMultipartUpload成功后的返回值。
  126. // copySrc 源Object名称。
  127. // startPosition 本次拷贝片(Part)在源Object的起始位置。
  128. // partSize 本次拷贝片的大小。
  129. // partNumber 本次拷贝片的编号,范围是1~10000。如果超出范围,OSS将返回InvalidArgument错误。
  130. // options copy时源Object的限制条件,满足限制条件时copy,不满足时返回错误。可选条件有CopySourceIfMatch、
  131. // CopySourceIfNoneMatch、CopySourceIfModifiedSince CopySourceIfUnmodifiedSince,具体含义请参看
  132. // https://help.aliyun.com/document_detail/oss/api-reference/multipart-upload/UploadPartCopy.html
  133. //
  134. // UploadPart 上传成功的返回值,两个成员PartNumber、ETag。PartNumber片(Part)编号,即传入参数partNumber;
  135. // ETag及上传数据的MD5。error为nil时有效。
  136. // error 操作成功error为nil,非nil为错误信息。
  137. //
  138. func (bucket Bucket) UploadPartCopy(imur InitiateMultipartUploadResult, srcBucketName, srcObjectKey string,
  139. startPosition, partSize int64, partNumber int, options ...Option) (UploadPart, error) {
  140. var out UploadPartCopyResult
  141. var part UploadPart
  142. opts := []Option{CopySource(srcBucketName, srcObjectKey),
  143. CopySourceRange(startPosition, partSize)}
  144. opts = append(opts, options...)
  145. params := "partNumber=" + strconv.Itoa(partNumber) + "&uploadId=" + imur.UploadID
  146. resp, err := bucket.do("PUT", imur.Key, params, params, opts, nil)
  147. if err != nil {
  148. return part, err
  149. }
  150. defer resp.Body.Close()
  151. err = xmlUnmarshal(resp.Body, &out)
  152. if err != nil {
  153. return part, err
  154. }
  155. part.ETag = out.ETag
  156. part.PartNumber = partNumber
  157. return part, nil
  158. }
  159. //
  160. // CompleteMultipartUpload 提交分片上传任务。
  161. //
  162. // imur InitiateMultipartUpload的返回值。
  163. // parts UploadPart/UploadPartFromFile/UploadPartCopy返回值组成的数组。
  164. //
  165. // CompleteMultipartUploadResponse 操作成功后的返回值。error为nil时有效。
  166. // error 操作成功error为nil,非nil为错误信息。
  167. //
  168. func (bucket Bucket) CompleteMultipartUpload(imur InitiateMultipartUploadResult,
  169. parts []UploadPart) (CompleteMultipartUploadResult, error) {
  170. var out CompleteMultipartUploadResult
  171. sort.Sort(uploadParts(parts))
  172. cxml := completeMultipartUploadXML{}
  173. cxml.Part = parts
  174. bs, err := xml.Marshal(cxml)
  175. if err != nil {
  176. return out, err
  177. }
  178. buffer := new(bytes.Buffer)
  179. buffer.Write(bs)
  180. params := "uploadId=" + imur.UploadID
  181. resp, err := bucket.do("POST", imur.Key, params, params, nil, buffer)
  182. if err != nil {
  183. return out, err
  184. }
  185. defer resp.Body.Close()
  186. err = xmlUnmarshal(resp.Body, &out)
  187. return out, err
  188. }
  189. //
  190. // AbortMultipartUpload 取消分片上传任务。
  191. //
  192. // imur InitiateMultipartUpload的返回值。
  193. //
  194. // error 操作成功error为nil,非nil为错误信息。
  195. //
  196. func (bucket Bucket) AbortMultipartUpload(imur InitiateMultipartUploadResult) error {
  197. params := "uploadId=" + imur.UploadID
  198. resp, err := bucket.do("DELETE", imur.Key, params, params, nil, nil)
  199. if err != nil {
  200. return err
  201. }
  202. defer resp.Body.Close()
  203. return checkRespCode(resp.StatusCode, []int{http.StatusNoContent})
  204. }
  205. //
  206. // ListUploadedParts 列出指定上传任务已经上传的分片。
  207. //
  208. // imur InitiateMultipartUpload的返回值。
  209. //
  210. // ListUploadedPartsResponse 操作成功后的返回值,成员UploadedParts已经上传/拷贝的片。error为nil时该返回值有效。
  211. // error 操作成功error为nil,非nil为错误信息。
  212. //
  213. func (bucket Bucket) ListUploadedParts(imur InitiateMultipartUploadResult) (ListUploadedPartsResult, error) {
  214. var out ListUploadedPartsResult
  215. params := "uploadId=" + imur.UploadID
  216. resp, err := bucket.do("GET", imur.Key, params, params, nil, nil)
  217. if err != nil {
  218. return out, err
  219. }
  220. defer resp.Body.Close()
  221. err = xmlUnmarshal(resp.Body, &out)
  222. return out, err
  223. }
  224. //
  225. // ListMultipartUploads 列出所有未上传完整的multipart任务列表。
  226. //
  227. // options ListObject的筛选行为。Prefix返回object的前缀,KeyMarker返回object的起始位置,MaxUploads最大数目默认1000,
  228. // Delimiter用于对Object名字进行分组的字符,所有名字包含指定的前缀且第一次出现delimiter字符之间的object。
  229. //
  230. // ListMultipartUploadResponse 操作成功后的返回值,error为nil时该返回值有效。
  231. // error 操作成功error为nil,非nil为错误信息。
  232. //
  233. func (bucket Bucket) ListMultipartUploads(options ...Option) (ListMultipartUploadResult, error) {
  234. var out ListMultipartUploadResult
  235. options = append(options, EncodingType("url"))
  236. params, err := handleParams(options)
  237. if err != nil {
  238. return out, err
  239. }
  240. resp, err := bucket.do("GET", "", "uploads&"+params, "uploads", nil, nil)
  241. if err != nil {
  242. return out, err
  243. }
  244. defer resp.Body.Close()
  245. err = xmlUnmarshal(resp.Body, &out)
  246. if err != nil {
  247. return out, err
  248. }
  249. err = decodeListMultipartUploadResult(&out)
  250. return out, err
  251. }