ネットワークの不安定性やプログラムの例外により、大きなファイルのダウンロードが失敗することがあります。複数回再試行してもダウンロードが失敗することもあります。この問題を解決するために、Object Storage Service (OSS) は再開可能なダウンロード機能を提供しています。再開可能なダウンロード機能は、ファイルを複数のパートに分割し、各パートを個別にダウンロードしてから、それらを結合して完全なファイルにします。
注意事項
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、アクセス認証情報は環境変数から取得されます。アクセス認証情報の設定方法の詳細については、「アクセス認証情報の設定」をご参照ください。
このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスが作成されます。カスタムドメイン名または Security Token Service (STS) を使用して OSSClient インスタンスを作成する場合は、「一般的なシナリオの設定例」をご参照ください。
再開可能なダウンロードを実行するには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタムポリシーのアタッチ」をご参照ください。
サンプルコード
次のコードは、再開可能なダウンロードを実行する方法の例を示しています。
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.*;
public class Demo {
public static void main(String[] args) throws Exception {
// この例では、中国 (杭州) リージョンのエンドポイントを使用します。実際のエンドポイントを指定してください。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 環境変数からアクセス認証情報を取得します。サンプルコードを実行する前に、OSS_ACCESS_KEY_ID および OSS_ACCESS_KEY_SECRET 環境変数が設定されていることを確認してください。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// バケット名を指定します。例： examplebucket。
String bucketName = "examplebucket";
// オブジェクトの完全なパスを指定します。例： exampledir/exampleobject.txt。完全なパスにバケット名を含めることはできません。
String objectName = "exampledir/exampleobject.txt";
// バケットが配置されているリージョンを指定します。たとえば、バケットが中国 (杭州) リージョンにある場合、リージョンを cn-hangzhou に設定します。
String region = "cn-hangzhou";
// OSSClient インスタンスを作成します。
// OSSClient インスタンスが不要になったら、shutdown メソッドを呼び出してリソースを解放します。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
// 10 個の同時タスクを使用してファイルをダウンロードします。
DownloadFileRequest downloadFileRequest = new DownloadFileRequest(bucketName, objectName);
// オブジェクトをダウンロードするローカルファイルの完全なパスを指定します。例： D:\\localpath\\examplefile.txt。
downloadFileRequest.setDownloadFile("D:\\localpath\\examplefile.txt");
// パートサイズをバイト単位で設定します。値は 100 KB から 5 GB の範囲である必要があります。デフォルト値は 100 KB です。
downloadFileRequest.setPartSize(1 * 1024 * 1024);
// ダウンロードする同時パートの数を設定します。デフォルト値は 1 です。
downloadFileRequest.setTaskNum(10);
// 再開可能なダウンロードを有効にします。この機能はデフォルトで無効になっています。
downloadFileRequest.setEnableCheckpoint(true);
// チェックポイントファイルの完全なパスを指定します。例： D:\\localpath\\examplefile.txt.dcp。
// ダウンロードが中断されると、チェックポイントファイルが生成されます。ダウンロードを再開するには、チェックポイントファイルの完全なパスを指定する必要があります。ダウンロードが完了すると、チェックポイントファイルは削除されます。
//downloadFileRequest.setCheckpointFile("D:\\localpath\\examplefile.txt.dcp");
// ファイルをダウンロードします。
DownloadFileResult downloadRes = ossClient.downloadFile(downloadFileRequest);
// ダウンロードが成功すると、オブジェクトのメタデータが返されます。
ObjectMetadata objectMetadata = downloadRes.getObjectMetadata();
System.out.println(objectMetadata.getETag());
System.out.println(objectMetadata.getLastModified());
System.out.println(objectMetadata.getUserMetadata().get("meta"));
} catch (OSSException oe) {
System.out.println("Caught an OSSException, which means your request made it to OSS, "
+ "but was rejected with an error response for some reason.");
System.out.println("Error Message:" + oe.getErrorMessage());
System.out.println("Error Code:" + oe.getErrorCode());
System.out.println("Request ID:" + oe.getRequestId());
System.out.println("Host ID:" + oe.getHostId());
} catch (Throwable ce) {
System.out.println("Caught an ClientException, which means the client encountered "
+ "a serious internal problem while trying to communicate with OSS, "
+ "such as not being able to access the network.");
System.out.println("Error Message:" + ce.getMessage());
} finally {
if (ossClient != null) {
ossClient.shutdown();
}
}
}
}