# 断点续传上传
当上传大文件时，经常出现因网络不稳定或程序崩溃导致上传失败的情况。失败后再次重新上传不仅浪费资源，而且当网络不稳定时仍然有上传失败的风险。断点续传上传接口能有效地解决此类问题引起的上传失败，其原理是将待上传的文件分成若干个分段分别上传，并实时地将每段上传结果统一记录在checkpoint文件中，仅当所有分段都上传成功时返回上传成功的结果，否则抛出异常提醒用户再次调用接口进行重新上传（重新上传时因为有checkpoint文件记录当前的上传进度，避免重新上传所有分段，从而节省资源提高效率）。
您可以通过uploadFile进行断点续传上传。该接口可设置的参数如下：
| **参数**                  | **作用**                                                                    | **OBS iOS SDK对应方法**             |
|:---|:---|:---|
| bucketName              | 桶名，必选参数。                                                                  | request.bucketName              |
| objectKey               | 对象名，必选参数。                                                                 | request.objectKey               |
| objectACLPolicy         | 对象访问策略。                                                                   | request.objectACLPolicy         |
| storageClass            | 对象存储类型。                                                                   | request.storageClass            |
| metaDataDict            | 对象元数据。                                                                    | request.metaDataDict            |
| websiteRedirectLocation | 网址重定向位置。                                                                  | request.websiteRedirectLocation |
| encryption              | 加密方式。                                                                     | request.encryption              |
| enableCheckpoint        | 是否开启断点续传模式，默认为NO，表示不开启。                                                   | request.enableCheckpoint        |
| enableMD5Check          | 是否开启MD5校验，默认为NO，表示不开启。                                                    | request.enableMD5Check          |
| checkpointFilePath      | 记录上传进度的文件，只在断点续传模式下有效。当该值为空时，默认与待上传的本地文件同目录。文件名后缀可指定为obsuploadcheckpoint。 | request.checkpointFilePath      |
| partSize                | 分段大小，单位字节，取值范围是100KB\~5GB，默认为5MB。                                         | request.partSize                |
   
以下代码展示了如何使用断点续传上传接口上传文件：
```
static OBSClient *client;
NSString *endPoint = @"https://your-endpoint";
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
char* ak_env = getenv("AccessKeyID");
char* sk_env = getenv("SecretAccessKey");
if (ak_env == NULL || sk_env == NULL) {
    NSLog(@"Error: AccessKeyID or SecretAccessKey environment variable not set");
    return;
}
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:@"fileName" ofType:@"Type"];
OBSUploadFileRequest *request = [[OBSUploadFileRequest alloc]initWithBucketName:@"bucketname" objectKey:@"objectname" uploadFilePath:filePath];
// 分段大小为5MB
request.partSize = [NSNumber numberWithInteger: 5 * 1024*1024];
// 开启断点续传模式
request.enableCheckpoint = YES;
// 指定checkpoint文件路径
request.checkpointFilePath = @"/Documents/checkpoint.json";
    
// 上传文件
request.uploadProgressBlock =  ^(int64_t bytesSent, int64_t totalBytesSent, int64_t totalBytesExpectedToSend) {
    NSLog(@"%0.1f%%",(float)floor((totalBytesExpectedToSend > 0) ? (totalBytesSent*10000/totalBytesExpectedToSend) : 0)/100);
};
    
[client uploadFile:request completionHandler:^(OBSUploadFileResponse *response, NSError *error) {
     NSLog(@"%@",response);
    if(error){
        // 再次上传
    }
}];
```
![](https://support.huaweicloud.com/sdk-ios-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
当前SDK的文件上传接口（OBSPutObjectWithFileRequest、OBSUploadFileRequest）的uploadFilePath参数仅接受NSString类型的文件路径，不支持直接传入\[NSURL fileURLWithPath:@"xxx"\]构造的NSURL对象。如需使用NSURL，请先通过\[fileURL path\]获取文件路径字符串，再传入uploadFilePath参数。
![](https://support.huaweicloud.com/sdk-ios-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 断点续传上传接口是利用分段上传特性实现的，是对[分段上传](https://support.huaweicloud.com/sdk-ios-devg-obs/obs_27_0406.html)的封装和加强。
- 断点续传上传接口不仅能在失败重传时节省资源提高效率，还因其对分段进行并发上传的机制能加快上传速度，帮助用户快速完成上传业务；且其对用户透明，用户不用关心checkpoint文件的创建和删除、分段任务的切分、并发上传的实现等内部细节。
- **enableCheckpoint**参数默认是NO，代表不启用断点续传模式，此时断点续传上传接口退化成对分段上传的简单封装，不会产生checkpoint文件。
- **checkpointFile**参数仅在enableCheckpoint参数为YES时有效。
- 当前，当有多个上传任务需要并发执行时，需为每个上传任务初始化一个client及request进行处理。