ローカルファイルとバイナリ配列のアップロード - Object Storage Service

Simple uploadは、PutObject操作を呼び出してオブジェクトをアップロードするために使用できるアップロードメソッドです。単純アップロードを使用して、ローカルファイルとバイト配列をバイナリでアップロードできます。

使用上の注意

このトピックのサンプルコードを実行する前に、カスタムドメイン名やSecurity Token Service (STS) などの方法を使用してOSSClientインスタンスを作成する必要があります。詳細については、「初期化」をご参照ください。

ローカルファイルのアップロード

ローカルファイルを同期モードまたは非同期モードでObject Storage Service (OSS) にアップロードできます。

同期モードでローカルファイルをアップロードする

次のサンプルコードは、同期モードでexamplebucketバケットのexampledirディレクトリにあるexampleobject.txtオブジェクトにexamplefile.txtという名前のローカルファイルをアップロードする方法の例を示しています。

// アップロード要求を作成します。 
// バケットの名前、オブジェクトのフルパス、およびローカルファイルのフルパスを指定します。 この例では、バケットの名前はexamplebucket、オブジェクトのフルパスはexampledir/exampleobject.txt、ローカルファイルのフルパスは /storage/emulated/0/oss/examplefile.txtです。 
// オブジェクトのフルパスにバケット名を含めないでください。 
PutObjectRequest put = new PutObjectRequest("examplebucket", "exampledir/exampleobject.txt", "/storage/emulated/0/oss/examplefile.txt");

// (オプション) オブジェクトメタデータを指定します。 
 ObjectMetadata metadata = new ObjectMetadata();
// metadata.setContentType("application/octet-stream"); // コンテンツタイプを設定します。 
// metadata.setContentMD5(BinaryUtil.ca lculateBase64Md5(uploadFilePath)); // MD5検証に使用されるMD5ハッシュを指定します。 
// オブジェクトのACLをprivateに設定します。 
metadata.setHeader("x-oss-object-acl", "private");
// オブジェクトのストレージクラスをStandardに設定します。 
metadata.setHeader("x-oss-storage-class" 、"Standard");
// 既存のオブジェクトと同じ名前を持つアップロードされたオブジェクトが既存のオブジェクトを上書きしないように指定します。 
// metadata.setHeader("x-oss-forbid-overwrite", "true");
// オブジェクトに1つ以上のタグを指定します。 
// metadata.setHeader("x-oss-tagging", "a:1");
// OSSがオブジェクトを作成するときにオブジェクトを暗号化するために使用されるサーバー側の暗号化アルゴリズムを指定します。 
// metadata.setHeader("x-oss-server-side-encryption", "AES256");
// KMSによって管理されるCMKを指定します。 このパラメーターは、x-oss-server-side-encryptionがKMSに設定されている場合にのみ有効です。 
// metadata.setHeader("x-oss-server-side-encryption-key-id", "9468da86-3509-4f8d-a61e-6eab1eac ****");

put.setMetadata (メタデータ);

try {
    PutObjectResult putResult = oss.putObject(put);

    Log.d("PutObject", "UploadSuccess");
    Log.d("ETag", putResult.getETag());
    Log.d("RequestId", putResult.getRequestId());
} catch (ClientException e) {
    // ネットワークエラーなどのクライアント側の例外を処理します。 
    e.printStackTrace();
} catch (ServiceException e) {
    // サーバー側の例外を処理します。 
    Log.e("RequestId", e.getRequestId());
    Log.e("ErrorCode", e.getErrorCode());
    Log.e("HostId", e.getHostId());
    Log.e("RawMessage", e.getRawMessage());
}

Android 10以降のスコープ付きストレージでは、ファイルのURIを使用してファイルをOSSにアップロードできます。

// アップロード要求を作成します。 
// バケットの名前とオブジェクトの完全パスを指定します。 この例では、バケット名はexamplebucketで、オブジェクトの完全パスはexampledir/exampleobject.txtです。 
// オブジェクトのフルパスにバケット名を含めないでください。 
PutObjectRequest put = new PutObjectRequest("examplebucket", "exampledir/exampleobject.txt",fileUri);

// オブジェクトメタデータを指定します。 
// ObjectMetadata metadata=新しいObjectMetadata();
// Content-Typeを指定します。 
// metadata.setContentType("text/plain");
// MD5検証に使用されるMD5ハッシュを指定します。 
// metadata.setContentMD5(BinaryUtil.ca lculateBase64Md5(uploadFilePath));
// put.setMetadata (メタデータ);

try {
    PutObjectResult putResult = oss.putObject(put);

    Log.d("PutObject", "UploadSuccess");
    Log.d("ETag", putResult.getETag());
    Log.d("RequestId", putResult.getRequestId());
} catch (ClientException e) {
    // ネットワークエラーなどのクライアント側の例外を処理します。 
    e.printStackTrace();
} catch (ServiceException e) {
    // サーバー側の例外を処理します。 
    Log.e("RequestId", e.getRequestId());
    Log.e("ErrorCode", e.getErrorCode());
    Log.e("HostId", e.getHostId());
    Log.e("RawMessage", e.getRawMessage());
}

非同期モードでローカルファイルをアップロードする

説明

OSS SDK for Androidを使用する場合、同期モードを使用して、サブスレッドでのみローカルファイルをOSSにアップロードできます。同期モードのUIスレッドでローカルファイルをアップロードすることはできません。そうでない場合は、例外が生じます。 UIスレッドでローカルファイルをアップロードするには、非同期モードを使用します。

次のコードは、examplefile.txtという名前のローカルファイルを、非同期モードでexamplebucketバケットのexampledirディレクトリにあるexampleobject.txtオブジェクトにアップロードする方法の例を示しています。

// アップロード要求を作成します。 
// バケットの名前、オブジェクトのフルパス、およびローカルファイルのフルパスを指定します。 この例では、バケットの名前はexamplebucket、オブジェクトのフルパスはexampledir/exampleobject.txt、ローカルファイルのフルパスは /storage/emulated/0/oss/examplefile.txtです。 
// オブジェクトのフルパスにバケット名を含めないでください。 
PutObjectRequest put = new PutObjectRequest("examplebucket", "exampledir/exampleobject.txt", "/storage/emulated/0/oss/examplefile.txt");

// ローカルファイルを非同期モードでアップロードするときは、プログレスコールバックを設定できます。 
put.setProgressCallback(new OSSProgressCallback<PutObjectRequest>() {
    @オーバーライド
    public void onProgress(PutObjectRequest request, long currentSize, long totalSize) {
        Log.d("PutObject", "currentSize: " + currentSize + "totalSize: " + totalSize);
    }
});

OSSAsyncTask task = oss.asyncPutObject(put, new OSSCompletedCallback<PutObjectRequest, PutObjectResult>() {
    @オーバーライド
    public void onSuccess(PutObjectRequestリクエスト, PutObjectResult結果) {
        Log.d("PutObject", "UploadSuccess");
        Log.d("ETag", result.getETag());
        Log.d("RequestId", result.getRequestId());
    }

    @オーバーライド
    public void onFailure(PutObjectRequest request, ClientException clientExcepion, ServiceException serviceException) {
        // リクエスト例外を処理します。 
        if (clientExcepion != null) {
            // ネットワークエラーなどのクライアント側の例外を処理します。 
            clientExcepion.printStackTrace();
        }
        if (serviceException != null) {
            // サーバー側の例外を処理します。 
            Log.e("ErrorCode", serviceException.getErrorCode());
            Log.e("RequestId", serviceException.getRequestId());
            Log.e("HostId", serviceException.getHostId());
            Log.e("RawMessage", serviceException.getRawMessage());
        }
    }
});
// アップロードタスクをキャンセルします。 
// task.ca ncel();
// アップロードタスクが完了するまで待ちます。 
// task.waitUntilFinished();

Android 10以降のスコープ付きストレージでは、ファイルのURIを使用してファイルをOSSにアップロードできます。

// アップロード要求を作成します。 
// バケットの名前とオブジェクトの完全パスを指定します。 この例では、バケット名はexamplebucketで、オブジェクトの完全パスはexampledir/exampleobject.txtです。 
// オブジェクトのフルパスにバケット名を含めないでください。 
PutObjectRequest put = new PutObjectRequest("examplebucket", "exampledir/exampleobject.txt", fileUri);

// ローカルファイルを非同期モードでアップロードするときは、プログレスコールバックを設定できます。 
put.setProgressCallback(new OSSProgressCallback<PutObjectRequest>() {
    @オーバーライド
    public void onProgress(PutObjectRequest request, long currentSize, long totalSize) {
        Log.d("PutObject", "currentSize: " + currentSize + "totalSize: " + totalSize);
    }
});

OSSAsyncTask task = oss.asyncPutObject(put, new OSSCompletedCallback<PutObjectRequest, PutObjectResult>() {
    @オーバーライド
    public void onSuccess(PutObjectRequestリクエスト, PutObjectResult結果) {
        Log.d("PutObject", "UploadSuccess");
        Log.d("ETag", result.getETag());
        Log.d("RequestId", result.getRequestId());
    }

    @オーバーライド
    public void onFailure(PutObjectRequest request, ClientException clientExcepion, ServiceException serviceException) {
        // リクエスト例外を処理します。 
        if (clientExcepion != null) {
            // ネットワークエラーなどのクライアント側の例外を処理します。 
            clientExcepion.printStackTrace();
        }
        if (serviceException != null) {
            // サーバー側の例外を処理します。 
            Log.e("ErrorCode", serviceException.getErrorCode());
            Log.e("RequestId", serviceException.getRequestId());
            Log.e("HostId", serviceException.getHostId());
            Log.e("RawMessage", serviceException.getRawMessage());
        }
    }
});
// アップロードタスクをキャンセルします。 
// task.ca ncel();
// アップロードタスクが完了するまで待ちます。 
// task.waitUntilFinished();

バイト配列をバイナリでアップロードする

次のコードは、バイナリのバイト配列を同期モードでexamplebucketバケットのexampledirディレクトリにあるexampleobject.txtオブジェクトにアップロードする方法の例を示しています。

バイト [] uploadData=新しいバイト [100*1024];
新しいRandom().nextBytes(uploadData);

// アップロード要求を作成します。 
// バケットの名前とオブジェクトの完全パスを指定します。 この例では、バケット名はexamplebucketで、オブジェクトの完全パスはexampledir/exampleobject.txtです。 
// オブジェクトのフルパスにバケット名を含めないでください。 
PutObjectRequest put = new PutObjectRequest("examplebucket", "exampledir/exampleobject.txt", uploadData);

try {
    PutObjectResult putResult = oss.putObject(put);

    Log.d("PutObject", "UploadSuccess");
    Log.d("ETag", putResult.getETag());
    Log.d("RequestId", putResult.getRequestId());
} catch (ClientException e) {
    // ネットワークエラーなどのクライアント側の例外を処理します。 
    e.printStackTrace();
} catch (ServiceException e) {
    // サーバー側の例外を処理します。 
    Log.e("RequestId", e.getRequestId());
    Log.e("ErrorCode", e.getErrorCode());
    Log.e("HostId", e.getHostId());
    Log.e("RawMessage", e.getRawMessage());
}

参考資料

簡単なアップロードの実行に使用する完全なサンプルコードについては、『GitHub』をご参照ください。
シンプルアップロードを実行するために呼び出すことができるAPI操作の詳細については、「PutObject」をご参照ください。
OSSClientインスタンスを初期化する方法の詳細については、「初期化」をご参照ください。