# 断点续传下载
![](https://support.huaweicloud.com/sdk-dotnet-devg-obs/public_sys-resources/notice_3.0-zh-cn.png)
开发过程中，您有任何问题可以在github上[提交issue](https://github.com/huaweicloud/huaweicloud-sdk-dotnet-obs/issues)，或者在[华为云对象存储服务论坛](https://bbs.huaweicloud.com/forum/forum-620-1.html)中发帖求助。[接口参考文档](https://obssdk.obs.cn-north-1.myhuaweicloud.com/apidoc/cn/dotnet/html/G_OBS.htm)详细介绍了每个接口的参数和使用方法。
当下载大对象到本地文件时，经常出现因网络不稳定或程序崩溃导致下载失败的情况。失败后再次重新下载不仅浪费资源，而且当网络不稳定时仍然有下载失败的风险。断点续传下载接口能有效地解决此类问题引起的下载失败，其原理是将待下载的对象分成若干个分段分别下载，并实时地将每段下载结果统一记录在Checkpoint文件中，仅当所有分段都下载成功时返回下载成功的结果，否则抛出异常提醒用户再次调用接口进行重新下载（重新下载时因为有Checkpoint文件记录当前的下载进度，避免重新下载所有分段，从而节省资源提高效率）。
您可以通过ObsClient.DownloadFile进行断点续传下载。该接口可设置的主要参数如下：
| **参数**               | **作用**                                          | **OBS .NET SDK对应属性**                     |
|:---|:---|:---|
| BucketName           | 桶名，必选参数。                                        | DownloadFileRequest.BucketName           |
| ObjectKey            | 对象名，必选参数。                                       | DownloadFileRequest.ObjectKey            |
| DownloadFile         | 下载对象的本地文件全路径。当该值为空时，默认为当前程序的运行目录。               | DownloadFileRequest.DownloadFile         |
| DownloadPartSize     | 分段大小，单位字节，取值范围是5MB\~5GB，默认为5MB。                 | DownloadFileRequest.DownloadPartSize     |
| EnableCheckpoint     | 是否开启断点续传模式，默认为false，表示不开启。                      | DownloadFileRequest.EnableCheckpoint     |
| CheckpointFile       | 记录下载进度的文件，只在断点续传模式下有效。当该值为空时，默认与下载对象的本地文件路径同目录。 | DownloadFileRequest.CheckpointFile       |
| VersionId            | 对象的版本号。                                         | DownloadFileRequest.VersionId            |
| TaskNum              | 分段下载时的最大并发数，默认为1。                               | DownloadFileRequest.TaskNum              |
| DownloadProgress     | 下载进度回调函数。                                       | DownloadFileRequest.DownloadProgress     |
| ProgressType         | 下载进度反馈方式。                                       | DownloadFileRequest.ProgressType         |
| ProgressInterval     | 下载进度反馈间隔。                                       | DownloadFileRequest.ProgressInterval     |
| DownloadEventHandler | 下载事件回调函数。                                       | DownloadFileRequest.DownloadEventHandler |
   
以下代码展示了如何使用断点续传下载接口下载对象到本地文件：
```
// 初始化配置参数
ObsConfig config = new ObsConfig();
config.Endpoint = "https://your-endpoint";
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 您可以登录访问管理控制台获取访问密钥AK/SK，获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
string accessKey= Environment.GetEnvironmentVariable("AccessKeyID", EnvironmentVariableTarget.Machine);
string secretKey= Environment.GetEnvironmentVariable("SecretAccessKey", EnvironmentVariableTarget.Machine);
// 创建ObsClient实例
ObsClient client = new ObsClient(accessKey, secretKey, config);
// 断点续传下载文件
try
{
    DownloadFileRequest request = new DownloadFileRequest
    {
        BucketName = "bucketname",
        ObjectKey = "objectname",
        // 待下载的本地文件路径
        DownloadFile = "savepath",
        // 下载段大小为10MB
        DownloadPartSize = 1024 * 1024 * 10,
        // 开启断点续传模式
        EnableCheckpoint = true,
    };
   
    // 以传输字节数为基准反馈下载进度
    request.ProgressType = ProgressTypeEnum.ByBytes;
    // 每下载1MB数据反馈下载进度
    request.ProgressInterval = 1024 * 1024;
    // 注册下载进度回调函数
    request.DownloadProgress += delegate(object sender, TransferStatus status){
        // 获取下载平均速率
        Console.WriteLine("AverageSpeed: {0}", status.AverageSpeed / 1024  + "KB/S");
        // 获取下载进度百分比
        Console.WriteLine("TransferPercentage: {0}", status.TransferPercentage);
    };
    
    // 注册下载事件回调函数
    request.DownloadEventHandler += delegate(object sender, ResumableDownloadEvent e){       
        // 获取下载事件
        Console.WriteLine("EventType: {0}", e.EventType);
    };
    GetObjectMetadataResponse response = client.DownloadFile(request);
    Console.WriteLine("Download File response: {0}", response.StatusCode);
}
catch (ObsException ex)
{
   Console.WriteLine("ErrorCode: {0}", ex.ErrorCode);
   Console.WriteLine("ErrorMessage: {0}", ex.ErrorMessage);
}
```
![](https://support.huaweicloud.com/sdk-dotnet-devg-obs/public_sys-resources/note_3.0-zh-cn.png)
- 断点续传下载接口是利用[范围下载](https://support.huaweicloud.com/sdk-dotnet-devg-obs/obs_25_0503.html)特性实现的，是对范围下载的封装和加强。
- 断点续传下载接口不仅能在失败重下时节省资源提高效率，还因其对分段进行并发下载的机制能加快下载速度，帮助用户快速完成下载业务；且其对用户透明，用户不用关心CheckpointFile文件的创建和删除、分段任务的切分、并发下载的实现等内部细节。

- **EnableCheckpoint** **参数**默认是false，代表不启用断点续传模式，此时断点续传下载接口退化成对范围下载的简单封装，不会产生CheckpointFile文件。
- **CheckpointFile** **参数** 仅在**EnableCheckpoint** **参数**为true时有效。