當下載大檔案時,如果網路不穩定或者程式異常退出,會導致下載失敗,甚至重試多次仍無法完成下載。為此,OSS提供了斷點續傳下載功能。斷點續傳下載將需要下載的檔案分成若干個分區分別下載,所有分區都下載完成後,將所有分區合并成完整的檔案。
注意事項
本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱。
本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見建立OssClient。
要斷點續傳下載,您必須有
oss:GetObject
許可權。具體操作,請參見為RAM使用者授權自訂的權限原則。
實現方法
您可以通過 OssClient .ResumableDownloadObject 方法實現斷點續傳下載。此方法的 DownloadObjectRequest 請求包含以下參數:
參數 | 描述 | 是否必需 | 預設值 | 如何設定 |
bucket | 儲存空間名稱。 | 是 | 無 | 通過構造方法設定。 |
key | OSS檔案完整路徑。 | 是 | 無 | 通過構造方法設定。 |
filePath | 本地檔案完整路徑。 | 否 | OSS檔案名稱 | 通過構造方法設定。 |
partSize | 分區大小,取值範圍為100 KB~5 GB。 | 否 | 8 MB | 通過setPartSize設定。 |
threadNum | 分區下載的並發數。 | 否 | 3 | 通過構造方法或者 setThreadNum 設定。 |
checkpointDir | 記錄本地分區下載結果的檔案。開啟斷點續傳功能時需要設定此參數。下載過程中的進度資訊會儲存在該檔案中,如果某一分區下載失敗,再次下載時會根據檔案中記錄的點繼續下載。下載完成後,該檔案會被刪除。 | 否 | 與DownloadFile同目錄。 | 通過構造方法或者 setCheckpointDir 設定。 |
範例程式碼
以下代碼用於斷點續傳下載:
#include <alibabacloud/oss/OssClient.h>
using namespace AlibabaCloud::OSS;
int main(void)
{
/* 初始化OSS帳號資訊 */
/* yourEndpoint填寫Bucket所在地區對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。*/
std::string Endpoint = "yourEndpoint";
/* yourRegion填寫Bucket所在地區對應的Region。以華東1(杭州)為例,Region填寫為cn-hangzhou。*/
std::string Region = "yourRegion";
/* 填寫Bucket名稱,例如examplebucket。*/
std::string BucketName = "examplebucket";
/* 填寫Object完整路徑,完整路徑中不能包含Bucket名稱,例如exampledir/exampleobject.txt。*/
std::string ObjectName = "exampledir/exampleobject.txt";
/* 下載Object到本地檔案examplefile.txt,並儲存到指定的本地路徑中(D:\\localpath)。如果指定的本地檔案存在會覆蓋,不存在則建立。*/
/* 如果未指定本地路徑,則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。*/
std::string DownloadFilePath = "D:\\localpath\\examplefile.txt";
/* 設定斷點記錄檔案所在的目錄,並確保指定的目錄已存在,例如D:\\localpath。*/
/* 只有當Object下載中斷產生了斷點記錄檔案後,如果需要繼續下載該Object,才需要設定對應的斷點記錄檔案。下載完成後,該檔案會被刪除。*/
std::string CheckpointFilePath = "D:\\localpath";
/* 初始化網路等資源。*/
InitializeSdk();
ClientConfiguration conf;
conf.signatureVersion = SignatureVersionType::V4;
/* 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。*/
auto credentialsProvider = std::make_shared<EnvironmentVariableCredentialsProvider>();
OssClient client(Endpoint, credentialsProvider, conf);
client.SetRegion(Region);
/* 斷點續傳下載。*/
DownloadObjectRequest request(BucketName, ObjectName, DownloadFilePath, CheckpointFilePath);
auto outcome = client.ResumableDownloadObject(request);
if (!outcome.isSuccess()) {
/* 異常處理。*/
std::cout << "ResumableDownloadObject fail" <<
",code:" << outcome.error().Code() <<
",message:" << outcome.error().Message() <<
",requestId:" << outcome.error().RequestId() << std::endl;
return -1;
}
/* 釋放網路等資源。*/
ShutdownSdk();
return 0;
}