ドキュメントセンター
edit-icon download-icon

クイックスタート

最終更新日: Dec 04, 2018

基本的なファイルのアップロードとダウンロードのプロセスを以下に示します。詳細については、このプロジェクトの以下のディレクトリを参照してください。

サンプルディレクトリ (ローカルファイルアップロード、ファイルダウンロード、再開可能なアップロード、コールバック設定のデモを含む) 詳細

git clone project を実行して、必要なパラメータを設定することもできます。

次に、次のようにプロジェクトを実行します。

ステップ 1. OSSClient の初期化

初期化プロセスには、主に、エンドポイント設定、認証モード設定、およびクライアントパラメータ設定の各ステップが含まれます。自己署名モードと STS 認証モードの 2 つの認証モードが利用できます。STS 認証を使用するには、RAM の詳細についてResource Access Managementを参照してください。RAM サービスを有効にし、RAM サービスを学習し、サブアカウント AccessKeyId、SecretKeyId、および RoleArn を取得する方法を学習したと仮定します。

スクリプトファイルの AccessKeyId、SecretKeyId、および RoleArn のパラメータ情報を入力します。Python でローカルの HTTP サービスを有効にすることができます。クライアントコードを使用してローカルサービスにアクセスし、StsToken.AccessKeyId、StsToken.SecretKeyId、および StsToken.SecurityToken を取得します。

  1. String endpoint = "http://oss-cn-hangzhou.aliyuncs.com";
  3. // We recommend that you initialize OSSClient using STS on the mobile device.
  4. // For more information, see STS instructions in the sample.(https://github.com/aliyun/aliyun-oss-android-sdk/tree/master/app/src/main/java/com/alibaba/sdk/android/oss/app)
  5. OSSCredentialProvider credentialProvider = new OSSStsTokenCredentialProvider("<StsToken.AccessKeyId>", "<StsToken.SecretKeyId>", "<StsToken.SecurityToken>");
  7. //If the configuration class is not set, use the default configurations. For more information, see the configuration class.
  8. ClientConfiguration conf = new ClientConfiguration();
  9. conf.setConnectionTimeout(15 * 1000); // Connection time-out. The default value is 15 seconds.
  10. conf.setSocketTimeout(15 * 1000); // Socket time-out. The default value is 15 seconds.
  11. conf.setMaxConcurrentRequest(5); // The maximum number of concurrent requests. The default value is 5.
  12. conf.setMaxErrorRetry(2); // The maximum number of retry attempts after each failed attempt. The default value is 2.
  14. //When the feature is enabled, you can view logs in the console and write a log file into the mobile phone SD card under SDCard_path\OSSLog\logs.csv. This feature is disabled by default.
  15. //The logs record the request data, returned data, and exception information in OSS operations.
  16. //Such as requestId and response header
  17. //Android_version: 5.1  Android version
  18. //mobile_model: XT1085  Android mobile phone model
  19. //Network_state: connected  Network status
  20. //network_type: WIFI Network connection type
  21. //Specific operations:
  22. //[2017-09-05 16:54:52] - Encounter local execpiton: //java.lang.IllegalArgumentException: The bucket name is invalid. 
  23. //A bucket name must: 
  24. //1) be comprised of lower-case characters, numbers, or dash(-); 
  25. //2) start with lower case or numbers; 
  26. //3) be between 3-63 characters long. 
  27. //------>end of log
  28. OSSLog.enableLog();
  30. OSS oss = new OSSClient(getApplicationContext(), endpoint, credentialProvider);

OSSClient を使用したアップロードおよびダウンロードリクエストの初期化はスレッドセーフです。複数のタスクを同時に実行できます。

ステップ 2. ファイルのアップロード

すでにバケットを OSS コンソールに持っていると仮定します。次のコードを使用して、ローカルファイルを OSS にアップロードできます。

  1. // Construct an upload request
  2. PutObjectRequest put = new PutObjectRequest("<bucketName>", "<objectKey>", "<uploadFilePath>");
  4. // You can set progress callback during the asynchronous upload
  5. put.setProgressCallback(new OSSProgressCallback<PutObjectRequest>() {
  6.   @Override
  7.   public void onProgress(PutObjectRequest request, long currentSize, long totalSize) {
  8.     Log.d("PutObject", "currentSize: " + currentSize + " totalSize: " + totalSize);
  9.   }
  10. });
  12. OSSAsyncTask task = oss.asyncPutObject(put, new OSSCompletedCallback<PutObjectRequest, PutObjectResult>() {
  13.   @Override
  14.   public void onSuccess(PutObjectRequest request, PutObjectResult result) {
  15.     Log.d("PutObject", "UploadSuccess");
  16.     }
  18.   @Override
  19.   public void onFailure(PutObjectRequest request, ClientException clientExcepion, ServiceException serviceException) {
  20.     // Request exception
  21.     if (clientExcepion != null) {
  22.       // Local exception, such as a network exception
  23.       clientExcepion.printStackTrace();
  24.     }
  25.     if (serviceException != null) {
  26.       // Service exception
  27.       Log.e("ErrorCode", serviceException.getErrorCode());
  28.       Log.e("RequestId", serviceException.getRequestId());
  29.       Log.e("HostId", serviceException.getHostId());
  30.       Log.e("RawMessage", serviceException.getRawMessage());
  31.     }
  32.   }
  33. });
  35. // task.cancel(); // You can cancel the task
  37. // task.waitUntilFinished(); // Wait until the task is complete

ステップ 3. 指定したファイルのダウンロード

次のコードは、指定されたobjectをダウンロードします（返されるデータの入力ストリームを処理する必要があります）。

  1. // Construct a file download request.
  2. GetObjectRequest get = new GetObjectRequest("<bucketName>", "<objectKey>");
  4. OSSAsyncTask task = oss.asyncGetObject(get, new OSSCompletedCallback<GetObjectRequest, GetObjectResult>() {
  5.   @Override
  6.   public void onSuccess(GetObjectRequest request, GetObjectResult result) {
  7.     // Request succeeds
  8.     Log.d("Content-Length", "" + getResult.getContentLength());
  10.     InputStream inputStream = result.getObjectContent();
  12.     byte[] buffer = new byte[2048];
  13.     int len;
  15.     try {
  16.       while ((len = inputStream.read(buffer)) != -1) {
  17.         // Process the downloaded data.
  18.       }
  19.     } catch (IOException e) {
  20.       e.printStackTrace();
  21.     }
  22. }
  24.   @Override
  25.   public void onFailure(GetObjectRequest request, ClientException clientExcepion, ServiceException serviceException) {
  26.     // Request exception
  27.     if (clientExcepion != null) {
  28.       // Local exception, such as a network exception
  29.       clientExcepion.printStackTrace();
  30.     }
  31.     if (serviceException != null) {
  32.       // Service exception
  33.       Log.e("ErrorCode", serviceException.getErrorCode());
  34.       Log.e("RequestId", serviceException.getRequestId());
  35.       Log.e("HostId", serviceException.getHostId());
  36.       Log.e("RawMessage", serviceException.getRawMessage());
  37.     }
  38.   }
  39. });
  41. // task.cancel(); // You can cancel the task
  43. // task.waitUntilFinished(); // If necessary, wait until the task is complete
アカウント登録 コンソール