ファイルの一部のみが必要な場合は、範囲のダウンロードを実行して、特定の範囲のデータを取得できます。
注意事項
このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスするには、内部エンドポイントを使用します。サポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。
このトピックでは、アクセス認証情報は環境変数から取得されます。アクセス認証情報の設定方法の詳細については、「アクセス認証情報の設定」をご参照ください。
このトピックでは、OSS エンドポイントを使用して OSSClient インスタンスを作成します。カスタムドメイン名または Security Token Service (STS) を使用して OSSClient インスタンスを作成する場合は、「一般的なシナリオの設定例」をご参照ください。
範囲のダウンロードを実行するには、
oss:GetObject権限が必要です。詳細については、「RAM ユーザーへのカスタム権限の付与」をご参照ください。
通常のダウンロード範囲の指定
次のコードは、有効なダウンロード範囲を指定してファイルをダウンロードする方法を示しています。
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.GetObjectRequest;
import com.aliyun.oss.model.OSSObject;
import java.io.InputStream;
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();
InputStream in = null;
try {
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, objectName);
// 1,000 バイトのファイルの場合、通常のバイト範囲は 0 から 999 です。
// 0 から 999 バイトの範囲 (バイト 0 とバイト 999 を含む、合計 1,000 バイト) のデータを取得します。指定された範囲が無効な場合 (たとえば、開始位置または終了位置が負の値であるか、ファイルサイズより大きい場合)、ファイル全体がダウンロードされます。
getObjectRequest.setRange(0, 999);
// 範囲のダウンロードを実行します。
OSSObject ossObject = ossClient.getObject(getObjectRequest);
// データを読み取ります。
byte[] buf = new byte[1024];
in = ossObject.getObjectContent();
for (int n = 0; n != -1; ) {
n = in.read(buf, 0, buf.length);
}
ossObject.close();
} 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 (ClientException 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();
}
// データの読み取り後、ストリームを閉じる必要があります。そうしないと、接続リークが発生する可能性があります。これにより、利用可能な接続が枯渇し、プログラムが動作しなくなる可能性があります。
if (in != null) {
in.close();
}
}
}
} 1 回のストリーム読み取りでは、すべてのデータを取得できない場合があります。ストリームから 64 KB のデータを読み取るには、64 KB のデータが読み取られるか、ファイルの終わりに達するまで、ストリームを複数回読み取る必要があります。詳細については、「InputStream.read」をご参照ください。
byte[] buf = new byte[1024];
InputStream in = ossObject.getObjectContent();
for (int n = 0; n != -1; ) {
n = in.read(buf, 0, buf.length);
}
in.close();無効なダウンロード範囲の指定
サイズが 1,000 バイトのオブジェクトがあるとします。有効なダウンロード範囲は 0 から 999 です。この有効な間隔外の範囲を指定した場合、Range ヘッダーは効果がありません。OSS は 200 ステータスコードを返し、オブジェクト全体を送信します。次の例は、無効なリクエストとその応答を示しています：
Range: bytes=500-2000 を指定した場合、範囲の末尾が有効な間隔外になります。OSS はオブジェクト全体と HTTP ステータスコード 200 を返します。
Range: bytes=1000-2000 を指定した場合、範囲の先頭が有効な間隔外になります。OSS はオブジェクト全体と HTTP ステータスコード 200 を返します。
範囲のダウンロードの標準動作
リクエストに x-oss-range-behavior: standard ヘッダーを追加して、有効な間隔外の範囲に対する OSS のダウンロード動作を変更できます。サイズが 1,000 バイトのオブジェクトがあるとします：
Range: bytes=500-2000 を指定した場合、範囲の末尾が有効な間隔外になります。OSS はバイト 500 からバイト 999 までのコンテンツと HTTP ステータスコード 206 を返します。
Range: bytes=1000-2000 を指定した場合、範囲の先頭が有効な間隔外になります。OSS は HTTP ステータスコード 416 と InvalidRange エラーコードを返します。
次のコードは、標準動作で範囲のダウンロードを実行する方法を示しています。
import com.aliyun.oss.*;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.model.GetObjectRequest;
import com.aliyun.oss.model.OSSObject;
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();
// V4 署名アルゴリズムの使用を明示的に宣言します。
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.region(region)
.build();
try {
// 範囲の末尾が有効な間隔外です。OSS はバイト 500 からバイト 999 までのコンテンツと HTTP ステータスコード 206 を返します。
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, objectName);
getObjectRequest.setRange(500, 2000);
getObjectRequest.addHeader("x-oss-range-behavior", "standard");
OSSObject ossObject = ossClient.getObject(getObjectRequest);
ossObject.close();
System.out.println("standard get " + "500~2000 "+ "statusCode:" + ossObject.getResponse().getStatusCode());
System.out.println("standard get " + "500~2000 " + "contentLength:" + ossObject.getResponse().getContentLength());
// 範囲の先頭が有効な間隔外です。次のコードは例外をスローします。OSS は HTTP ステータスコード 416 と InvalidRange エラーコードを返します。
getObjectRequest = new GetObjectRequest(bucketName, objectName);
getObjectRequest.setRange(1000, 2000);
getObjectRequest.addHeader("x-oss-range-behavior", "standard");
OSSObject ossObject2 = ossClient.getObject(getObjectRequest);
ossObject2.close();
} 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 (ClientException 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();
}
}
}
}関連ドキュメント
範囲のダウンロードの API 操作の詳細については、「GetObject」をご参照ください。