暂停、继续、取消断点续传上传

当上传大文件时，经常出现因网络不稳定或程序崩溃导致上传失败的情况。失败后再次重新上传不仅浪费资源，而且当网络不稳定时仍然有上传失败的风险。断点续传上传接口能有效地解决此类问题引起的上传失败，其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则抛出异常提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。

您可以通过uploadFile进行断点续传上传。该接口可设置的参数如下：

以下代码展示了如何暂停、继续断点续传上传接口：

#import <OBS/OBS.h>
void testPauseAndResumeUploadFile(){
    static OBSClient *client;
    NSString *endPoint = @"your-endpoint";
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
    // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
    char* ak_env = getenv("AccessKeyID");
    char* sk_env = getenv("SecretAccessKey");
    NSString *AK = [NSString stringWithUTF8String:ak_env];
    NSString *SK = [NSString stringWithUTF8String:sk_env];
        
    // 初始化身份验证
    OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK];
        
    //初始化服务配置
    OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider];
        
    // 初始化client
    client = [[OBSClient alloc] initWithConfiguration:conf];
        
    // 分段上传的最大并发数
    client.configuration.maxConcurrentUploadRequestCount = 5;
    // 分段上传请求的最大连接数
    client.configuration.uploadSessionConfiguration.HTTPMaximumConnectionsPerHost = 10;
    NSString *filePath = [[NSBundle mainBundle]pathForResource:@"localFile" ofType:@"fileType"];
    OBSUploadFileRequest *request = [[OBSUploadFileRequest alloc]initWithBucketName:@"your-bucket-name" objectKey:@"objectname" uploadFilePath:filePath];
    // 分段大小为5MB
    request.partSize = [NSNumber numberWithInteger: 5 * 1024*1024];
    // 开启断点续传模式
    request.enableCheckpoint = YES;
    // 指定checkpoint文件路径，可以不设置
//    request.checkpointFilePath = @"Your CheckPoint File";
        
    // 上传文件
    request.uploadProgressBlock =  ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) {
        NSLog(@"%0.1f%%",(float)floor(totalBytesSent*10000/totalBytesExpectedToSend)/100);
    };
        
    OBSBFTask  *task = [client uploadFile:request completionHandler:^(OBSUploadFileResponse *response, NSError *error) {
        if(error){
            // 暂停时此处会打印暂停导致的报错信息
            NSLog(@"upload file failed:%@", error);
        }
        if(response){
            NSLog(@"upload file response:%@", response);
        }
    }];
    // 上传1秒后暂停
    sleep(1);
    [request cancel];
    // 暂停上传后，可以继续上传
    [task waitUntilFinished];
    task = [client uploadFile:request completionHandler:^(OBSUploadFileResponse *response, NSError *error) {
        if(error){
            NSLog(@"upload file failed:%@", error);
            // 再次上传
        }
        if(response){
            NSLog(@"upload file response:%@", response);
        }
    }];
    [task waitUntilFinished];
}

以下代码展示了如何暂停并取消断点续传上传接口：

#import <OBS/OBS.h>
void testPauseAndAbortUploadFile() {
    static OBSClient *client;
    NSString *endPoint = @"your-endpoint";
    // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
    // 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html
    char* ak_env = getenv("AccessKeyID");
    char* sk_env = getenv("SecretAccessKey");
    NSString *AK = [NSString stringWithUTF8String:ak_env];
    NSString *SK = [NSString stringWithUTF8String:sk_env];
        
    // 初始化身份验证
    OBSStaticCredentialProvider *credentialProvider = [[OBSStaticCredentialProvider alloc] initWithAccessKey:AK secretKey:SK];
        
    //初始化服务配置
    OBSServiceConfiguration *conf = [[OBSServiceConfiguration alloc] initWithURLString:endPoint credentialProvider:credentialProvider];
        
    // 初始化client
    client = [[OBSClient alloc] initWithConfiguration:conf];
        
    // 分段上传的最大并发数
    client.configuration.maxConcurrentUploadRequestCount = 5;
    // 分段上传请求的最大连接数
    client.configuration.uploadSessionConfiguration.HTTPMaximumConnectionsPerHost = 10;
    NSString *filePath = [[NSBundle mainBundle]pathForResource:@"localFile" ofType:@"fileType"];
    OBSUploadFileRequest *request = [[OBSUploadFileRequest alloc]initWithBucketName:@"your-bucket-name" objectKey:@"objectname" uploadFilePath:filePath];
    // 分段大小为5MB
    request.partSize = [NSNumber numberWithInteger: 5 * 1024*1024];
    // 开启断点续传模式
    request.enableCheckpoint = YES;
    // 指定checkpoint文件路径，可以不设置
//    request.checkpointFilePath = @"Your CheckPoint File";
        
    // 上传文件
    request.uploadProgressBlock =  ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) {
        NSLog(@"%0.1f%%",(float)floor(totalBytesSent*10000/totalBytesExpectedToSend)/100);
    };
    // 暂停后自动取消分段上传任务
    request.needAbortUploadFileAfterCancel = YES;
        
    OBSBFTask  *task = [client uploadFile:request completionHandler:^(OBSUploadFileResponse *response, NSError *error) {
        if(error){
            // 暂停时此处会打印暂停导致的报错信息
            NSLog(@"upload file failed:%@", error);
        }
        if(response){
            NSLog(@"upload file response:%@", response);
        }
    }];
    // 上传1秒后暂停，并会自动取消分段上传任务
    sleep(1);
    [request cancel];
    // 暂停上传后，可以重新继续上传，但是由于取消了分段上传任务，进度会清零，从头开始
    [task waitUntilFinished];
    task = [client uploadFile:request completionHandler:^(OBSUploadFileResponse *response, NSError *error) {
        if(error){
            NSLog(@"upload file failed:%@", error);
            // 再次上传
        }
        if(response){
            NSLog(@"upload file response:%@", response);
        }
    }];
    [task waitUntilFinished];
}

• 断点续传上传接口是利用分段上传特性实现的，是对分段上传的封装和加强。
• 断点续传上传接口不仅能在失败重传时节省资源提高效率，还因其对分段进行并发上传的机制能加快上传速度，帮助用户快速完成上传业务；且其对用户透明，用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发上传的实现等内部细节。
• enableCheckpoint参数默认是NO，代表不启用断点续传模式，此时断点续传上传接口退化成对分段上传的简单封装，不会产生checkpoint文件。
• checkpointFile参数仅在enableCheckpoint参数为YES时有效。
• 当前，当有多个上传任务需要并发执行时，需为每个上传任务初始化一个client及request进行处理。
• needAbortUploadFileAfterCancel参数默认为NO，如果同时开启了断点续传（enableCheckpoint为YES）那么暂停断点续传时不会取消整个分段上传任务，不会丢弃已经上传的段，其他情况暂停时都会取消整个上传段任务。