下面演示通过分片上传文件的整个流程。

初始化分片上传

String uploadId;

InitiateMultipartUploadRequest init = new InitiateMultipartUploadRequest("<bucketName>", "<objectKey>");
InitiateMultipartUploadResult initResult = oss.initMultipartUpload(init);

uploadId = initResult.getUploadId();
  • 我们用InitiateMultipartUploadRequest来指定上传文件的名字和所属存储空间(Bucket)。
  • 在InitiateMultipartUploadRequest中,您也可以设置ObjectMeta,但是不必指定其中的ContentLength 。
  • initiateMultipartUpload 的返回结果中含有UploadId ,它是区分分片上传事件的唯一标识,在后面的操作中,我们将用到它。

上传分片

long partSize = 128 * 1024; // 设置分片大小

int currentIndex = 1; // 上传分片编号,从1开始

File uploadFile = new File("<uploadFilePath>"); // 需要分片上传的文件

InputStream input = new FileInputStream(uploadFile);
long fileLength = uploadFile.length();

long uploadedLength = 0;
List<PartETag> partETags = new ArrayList<PartETag>(); // 保存分片上传的结果
while (uploadedLength < fileLength) {

	int partLength = (int)Math.min(partSize, fileLength - uploadedLength);
	byte[] partData = IOUtils.readStreamAsBytesArray(input, partLength); // 按照分片大小读取文件的一段内容

	UploadPartRequest uploadPart = new UploadPartRequest("<bucketName>", "<objectKey>", uploadId, currentIndex);
	uploadPart.setPartContent(partData); // 设置分片内容
	UploadPartResult uploadPartResult = oss.uploadPart(uploadPart);
	partETags.add(new PartETag(currentIndex, uploadPartResult.getETag())); // 保存分片上传成功后的结果

	uploadedLength += partLength;
	currentIndex++;
}

上面程序的核心是调用UploadPart方法来上传每一个分片。

注意
  • UploadPart 方法要求除最后一个Part以外,其他的Part大小都要大于100KB。但是Upload Part接口并不会立即校验上传 Part的大小(因为不知道是否为最后一块);只有当Complete Multipart Upload的时候才会校验。
  • OSS会将服务器端收到Part数据的MD5值放在ETag头内返回给用户。
  • Part号码的范围是1~10000。如果超出这个范围,OSS将返回InvalidArgument的错误码。
  • 每次上传part时都要把流定位到此次上传片开头所对应的位置。
  • 每次上传part之后,OSS的返回结果会包含一个分片的ETag,您需要将它和块编号组合成PartEtag,保存在list中,后续完成分片上传需要用到。

MD5校验设置

因为移动端网络环境的复杂性,OSS提供了基于端到端的文件验证功能。如果要校验分片上传到OSS的文件和本地文件是否一致,可以在上传分片时携带分片的Content-MD5值,OSS服务器会帮助用户进行MD5校验,只有在OSS服务器接收到的分片MD5值和Content-MD5一致时才可以上传成功,从而保证上传分片的一致性。

UploadPartRequest uploadPart = new UploadPartRequest("<bucketName>", "<objectKey>", uploadId, currentIndex);
uploadPart.setPartContent(partData); // 设置分片内容
//设置MD5内容
uploadPart.setMd5Digest(BinaryUtil.calculateBase64Md5(data));

完成分片上传

CompleteMultipartUploadRequest complete = new CompleteMultipartUploadRequest("<bucketName>", "<objectKey>", uploadId, partETags);
CompleteMultipartUploadResult completeResult = oss.completeMultipartUpload(complete);

Log.d("multipartUpload", "multipart upload success! Location: " + completeResult.getLocation());

上面代码中的 partETags 就是进行分片上传中保存的partETag的列表,OSS收到用户提交的Part列表后,会逐一验证每个数据Part的有效性。 当所有的数据Part验证通过后,OSS会将这些part组合成一个完整的文件。

完成分片上传(设置ServerCallback)

CompleteMultipartUploadRequest complete = new CompleteMultipartUploadRequest("<bucketName>", "<objectKey>", uploadId, partETags);
CompleteMultipartUploadResult completeResult = oss.completeMultipartUpload(complete);
complete.setCallbackParam(new HashMap<String, String>() {
            {
                put("callbackUrl", "<server address>");
                put("callbackBody", "<test>");
            }
        });
Log.d("multipartUploadWithServerCallback", completeResult.getServerCallbackReturnBody());

完成分片上传请求可以设置Server Callback参数,请求完成后会向指定的Server Adress发送回调请求。

删除分片上传事件

我们可以用 abortMultipartUpload 方法取消分片上传。

AbortMultipartUploadRequest abort = new AbortMultipartUploadRequest("<bucketName>", "<objectKey>", uploadId);
oss.abortMultipartUpload(abort); // 若无异常抛出说明删除成功

列举分片

我们可以用 listParts 方法获取某个上传事件所有已上传的分片。

ListPartsRequest listParts = new ListPartsRequest("<bucketName>", "<objectKey>", uploadId);

ListPartsResult result = oss.listParts(listParts);

for (int i = 0; i < result.getParts().size(); i++) {
	Log.d("listParts", "partNum: " + result.getParts().get(i).getPartNumber());
	Log.d("listParts", "partEtag: " + result.getParts().get(i).getETag());
	Log.d("listParts", "lastModified: " + result.getParts().get(i).getLastModified());
	Log.d("listParts", "partSize: " + result.getParts().get(i).getSize());
}
  • 默认情况下,如果存储空间中的分片上传事件的数量大于1000,则只会返回1000个Multipart Upload信息,且返回结果中 IsTruncated 为false,并返回 NextPartNumberMarker作为下此读取的起点。
  • 若想增大返回分片上传事件数目,可以修改 MaxParts 参数,或者使用 PartNumberMarker 参数分次读取。