异步断点续传上传(Java SDK)

本示例展示了如何异步断点续传，将本地文件localfile上传到examplebucket桶下的objectKey对象中。同时演示了暂停上传和继续上传的功能。

import com.obs.services.ObsClientAsync;
import com.obs.services.exception.ObsException;
import com.obs.services.internal.task.UploadFileTask;
import com.obs.services.internal.utils.CallCancelHandler;
import com.obs.services.model.CompleteMultipartUploadResult;
import com.obs.services.model.TaskCallback;
import com.obs.services.model.UploadFileRequest;

import java.io.IOException;
import java.util.Map;
import java.util.Optional;

public class TestUploadFileCancel
{
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。
        String securityToken = System.getenv("SECURITY_TOKEN");
        // endpoint填写桶所在的endpoint, 此处以中国-香港为例，其他地区请按实际情况填写。
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT");

        // 创建ObsClient实例
        try (ObsClientAsync obsClientAsync = new ObsClientAsync(ak, sk, securityToken, endPoint)) {
            String bucketName = "examplebucket";
            String objectKey = "objectKey";
            String localFile = "localfile";
            UploadFileRequest uploadFileRequest1 = new UploadFileRequest(bucketName, objectKey, localFile);
            uploadFileRequest1.setProgressListener(status -> {
                // 获取上传平均速率
                System.out.println("AverageSpeed:" + status.getAverageSpeed());
                // 获取上传进度百分比
                System.out.println("TransferPercentage:" + status.getTransferPercentage());
            });
            CallCancelHandler callCancelHandler = new CallCancelHandler();
            uploadFileRequest1.setCancelHandler(callCancelHandler);
            // 每上传5MB数据反馈上传进度
            uploadFileRequest1.setProgressInterval(5 * 1024 * 1024L);
            // 开启进度记录，用于断点续传
            uploadFileRequest1.setEnableCheckpoint(true);
            // 5个并发线程上传
            uploadFileRequest1.setTaskNum(5);
            // 分段大小5MB
            uploadFileRequest1.setPartSize(5 * 1024 * 1024L);
            //暂停上传后不取消上传任务，不影响已经成功上传的分段
            uploadFileRequest1.setNeedAbortUploadFileAfterCancel(false);
            // 成功回调和异常回调
            TaskCallback<CompleteMultipartUploadResult,UploadFileRequest> completeCallback = new TaskCallback<CompleteMultipartUploadResult, UploadFileRequest>()
            {
                @Override
                public void onSuccess(CompleteMultipartUploadResult result)
                {}
                @Override
                public void onException(ObsException e, UploadFileRequest singleRequest)
                {
                    System.out.println("uploadFileAsync failed");
                    if(singleRequest.getCancelHandler()!=null) {
                        System.out.println("UploadFileRequest isCanceled ? " + singleRequest.getCancelHandler().isCancelled());
                    }
                    // 请求失败,打印http状态码
                    System.out.println("HTTP Code:" + e.getResponseCode());
                    // 请求失败,打印服务端错误码
                    System.out.println("Error Code:" + e.getErrorCode());
                    // 请求失败,打印详细错误信息
                    System.out.println("Error Message:" + e.getErrorMessage());
                    // 请求失败,打印请求id
                    System.out.println("Request ID:" + e.getErrorRequestId());
                    System.out.println("Host ID:" + e.getErrorHostId());
                    // 遍历Map的entry,打印所有报错相关头域
                    Map<String, String> headers = e.getResponseHeaders();
                    if(headers != null){
                        for (Map.Entry<String, String> header : headers.entrySet()) {
                            if(header.getKey().contains("error")){
                                System.out.println("errorHeaderKey:"+header.getKey()+", errorHeaderValue:"+header.getValue());
                            }
                        }
                    }
                    e.printStackTrace();
                }
            };
            // 开始异步断点续传上传
            UploadFileTask uploadFileTask = obsClientAsync.uploadFileAsync(uploadFileRequest1, completeCallback);
            Thread.sleep(1000);
            // 异步上传一段时间后，暂停上传， 已经上传完的分段无法暂停
            uploadFileTask.cancel();
            // 等待异步上传任务结束
            uploadFileTask.waitUntilFinished();
            // 继续上次的进度进行断点续传上传
            uploadFileTask = obsClientAsync.uploadFileAsync(uploadFileRequest1, completeCallback);
            Optional<CompleteMultipartUploadResult> result = uploadFileTask.getResult();
            if (result.isPresent()) {
                System.out.println("uploadFileAsync Successfully！");
                System.out.println("HTTP StatusCode:"+result.get().getStatusCode());
                System.out.println("ObjectUrl:"+result.get().getObjectUrl());
                System.out.println("Etag:"+result.get().getEtag());
            }
        }
        catch (IOException | InterruptedException e)
        {
            e.printStackTrace();
        }
    }
}

import com.obs.services.ObsClientAsync;
import com.obs.services.exception.ObsException;
import com.obs.services.internal.task.UploadFileTask;
import com.obs.services.internal.utils.CallCancelHandler;
import com.obs.services.model.CompleteMultipartUploadResult;
import com.obs.services.model.TaskCallback;
import com.obs.services.model.UploadFileRequest;

import java.io.IOException;
import java.util.Map;

public class TestUploadFileCancelAndAbort
{
    public static void main(String[] args) {
        // 您可以通过环境变量获取访问密钥AK/SK，也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。
        // 您可以登录访问管理控制台获取访问密钥AK/SK
        String ak = System.getenv("ACCESS_KEY_ID");
        String sk = System.getenv("SECRET_ACCESS_KEY_ID");
        // 【可选】如果使用临时AK/SK和SecurityToken访问OBS，同样建议您尽量避免使用硬编码，以降低信息泄露风险。
        // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken，也可以使用其他外部引入方式传入。
        String securityToken = System.getenv("SECURITY_TOKEN");

        // endpoint填写桶所在的endpoint, 此处以中国-香港为例，其他地区请按实际情况填写。
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // 您可以通过环境变量获取endPoint，也可以使用其他外部引入方式传入。
        //String endPoint = System.getenv("ENDPOINT");

        // 创建ObsClient实例
        try (ObsClientAsync obsClientAsync = new ObsClientAsync(ak, sk, securityToken, endPoint)) {
            String bucketName = "examplebucket";
            String objectKey = "objectKey";
            String localFile = "localfile";
            UploadFileRequest uploadFileRequest1 = new UploadFileRequest(bucketName, objectKey, localFile);
            uploadFileRequest1.setProgressListener(status -> {
                // 获取上传平均速率
                System.out.println("AverageSpeed:" + status.getAverageSpeed());
                // 获取上传进度百分比
                System.out.println("TransferPercentage:" + status.getTransferPercentage());
            });
            CallCancelHandler callCancelHandler = new CallCancelHandler();
            uploadFileRequest1.setCancelHandler(callCancelHandler);
            // 每上传5MB数据反馈上传进度
            uploadFileRequest1.setProgressInterval(5 * 1024 * 1024L);
            // 5个并发线程上传
            uploadFileRequest1.setTaskNum(5);
            // 分段大小5mb
            uploadFileRequest1.setPartSize(5 * 1024 * 1024L);
            //暂停上传后同时取消分段上传任务，删除已经成功上传的分段
            uploadFileRequest1.setNeedAbortUploadFileAfterCancel(true);
            // 成功回调和异常回调
            TaskCallback<CompleteMultipartUploadResult,UploadFileRequest> completeCallback =
                    new TaskCallback<CompleteMultipartUploadResult, UploadFileRequest>()
            {
                @Override
                public void onSuccess(CompleteMultipartUploadResult result)
                {}
                @Override
                public void onException(ObsException e, UploadFileRequest singleRequest)
                {
                    System.out.println("uploadFileAsync failed");
                    if(singleRequest.getCancelHandler()!=null) {
                        System.out.println("UploadFileRequest isCanceled ? " + singleRequest.getCancelHandler().isCancelled());
                    }
                    // 请求失败,打印http状态码
                    System.out.println("HTTP Code:" + e.getResponseCode());
                    // 请求失败,打印服务端错误码
                    System.out.println("Error Code:" + e.getErrorCode());
                    // 请求失败,打印详细错误信息
                    System.out.println("Error Message:" + e.getErrorMessage());
                    // 请求失败,打印请求id
                    System.out.println("Request ID:" + e.getErrorRequestId());
                    System.out.println("Host ID:" + e.getErrorHostId());
                    // 遍历Map的entry,打印所有报错相关头域
                    Map<String, String> headers = e.getResponseHeaders();
                    if(headers != null){
                        for (Map.Entry<String, String> header : headers.entrySet()) {
                            if(header.getKey().contains("error")){
                                System.out.println("errorHeaderKey:"+header.getKey()+", errorHeaderValue:"+header.getValue());
                            }
                        }
                    }
                    e.printStackTrace();
                }
            };
            // 开始异步断点续传上传
            UploadFileTask uploadFileTask = obsClientAsync.uploadFileAsync(uploadFileRequest1, completeCallback);
            Thread.sleep(1000);
            // 异步上传一段时间后，暂停上传, 自动取消分段上传任务，删除已经成功上传的分段， 如果上传已经完成则不能取消
            uploadFileTask.cancel();
            // 等待异步上传任务结束
            uploadFileTask.waitUntilFinished();
        }
        catch (IOException | InterruptedException e)
        {
            e.printStackTrace();
        }
    }
}