すべてのプロダクト
Search
ドキュメントセンター

Object Storage Service:進捗バー

最終更新日:Dec 15, 2023

進行状況バーを使用して、オブジェクトのアップロードまたはダウンロードの進行状況を示すことができます。 このトピックでは、ossClient.putObjectメソッドを使用してオブジェクトをアップロードするときに進行状況バーを使用する方法について説明します。

使用上の注意

  • このトピックでは、中国 (杭州) リージョンのパブリックエンドポイントを使用します。 OSSと同じリージョンにある他のAlibaba Cloudサービスを使用してOSSにアクセスする場合は、内部エンドポイントを使用します。 OSSでサポートされているリージョンとエンドポイントの詳細については、「リージョンとエンドポイント」をご参照ください。

  • このトピックでは、アクセス資格情報は環境変数から取得します。 アクセス資格情報の設定方法の詳細については、「アクセス資格情報の設定」をご参照ください。

  • このトピックでは、OSSエンドポイントを使用してOSSClientインスタンスを作成します。 カスタムドメイン名またはSecurity Token Service (STS) を使用してOSSClientインスタンスを作成する場合は、「OSSClientインスタンスの作成」をご参照ください。

サンプルコード

次のコードでは、ossClient.putObjectメソッドを使用してオブジェクトをアップロードするときに進行状況バーを使用する方法の例を示します。

説明

次のメソッドはプログレスバーをサポートしています: ossClient.putObject、ossClient.getObject、ossClient.uploadPart、ossClient.uploadFile、およびossClient.downloadFile。 これらのメソッドにプログレスバーを適用する手順は、ossClient.putObjectメソッドの手順と同じです。

com.aliyun.oss.ClientExceptionをインポートします。com.aliyun.oss.OSSをインポートします。impor t com.aliyun.oss.com mon.auth.*;
com.aliyun.oss.OSSClientBuilderをインポートします。com.aliyun.oss.OSSExceptionをインポートします。com.aliyun.oss.event.ProgressEventをインポートします。com.aliyun.oss.event.ProgressEventTypeをインポートします。com.aliyun.oss.event.ProgressListenerをインポートします。com.aliyun.oss.mo del.PutObjectRequestをインポートします。java.io. ファイルをインポートします。// プログレスバーを使用するには、ProgressListenerメソッドを使用します。
パブリッククラスPutObjectProgressListenerDemoがProgressListenerを実装 {
    private long bytesWritten = 0;
    private long totalBytes = -1;
    private boolean succeed = false;

    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。 
        文字列objectName = "exampledir/exampleobject.txt";
        // ローカルファイルのフルパスを指定します。 例: D :\\ localpath\\examplefile.txt。 
        文字列pathName = "D :\\ localpath\\examplefile.txt";

        // Create an OSSClient instance. 
        OSS ossClient = new OSSClientBuilder().build(endpoint, credentialsProvider);

        try {
            // オブジェクトをアップロードするときのプログレスバーのパラメーターを指定します。 この例では、PutObjectProgressListenerDemoは、呼び出すクラスの名前を指定します。 実際のクラス名に置き換えます。 
            ossClient.putObject(new PutObjectRequest(bucketName,objectName, new File(pathName))) 。
                    <PutObjectRequest>withProgressListener(new PutObjectProgressListenerDemo()));
            // オブジェクトをダウンロードするときのプログレスバーのパラメーターを指定します。 この例では、GetObjectProgressListenerDemoは、呼び出すクラスの名前を指定します。 実際のクラス名に置き換えます。 
// ossClient.getObject(new GetObjectRequest(bucketName,objectName)) 。
// <GetObjectRequest>withProgressListener(new GetObjectProgressListenerDemo()));

        } catch (Exception e) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "しかし、何らかの理由でエラー応答で拒否されました。");
            System.out.println("エラーメッセージ:" + oe.getErrorMessage());
            System.out.println("エラーコード:" + oe.getErrorCode());
            System.out.println("リクエストID:" + oe.getRequestId());
            System.out.println("ホストID:" + oe.getHostId());
        } catch (ClientException e) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + 「ネットワークにアクセスできないなど」;
            System.out.println("エラーメッセージ:" + ce.getMessage());
        } 最後に{
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }

    public boolean isSucceed() {
        return succeed;
    }

    // 進行状況バーを使用するようにコールバックメソッドを書き換えます。 次のサンプルコードに例を示します。 
    @オーバーライド
    public void progressChanged(ProgressEvent progressEvent) {
        long bytes = progressEvent.getBytes();
        ProgressEventType eventType = progressEvent.getEventType();
        switch (eventType) {
            case TRANSFER_STARTED_EVENT:
                System.out.println("Start to upload......");
                break;
            case REQUEST_CONTENT_LENGTH_EVENT:
                this.totalBytes = bytes;
                System.out.println(this.totalBytes + " bytes in total will be uploaded to OSS");
                break;
            case REQUEST_BYTE_TRANSFER_EVENT:
                this.bytesWritten += bytes;
                if (this.totalBytes != -1) {
                    int percent = (int)(this.bytesWritten * 100.0 / this.totalBytes);
                    System.out.println(bytes + " bytes have been written at this time, upload progress: " + percent + "%(" + this.bytesWritten + "/" + this.totalBytes + ")");
                } else {
                    System.out.println(bytes + " bytes have been written at this time, upload ratio: unknown" + "(" + this.bytesWritten + "/...)");
                }
                break;
            case TRANSFER_COMPLETED_EVENT:
                this.succeed = true;
                System.out.println("Succeed to upload, " + this.bytesWritten + " bytes have been transferred in total");
                break;
            case TRANSFER_FAILED_EVENT:
                System.out.println("Failed to upload, " + this.bytesWritten + " bytes have been transferred");
                break;
            default:
                break;
        }
    }
}

参考資料

オブジェクトアップロードのプログレスバーの完全なサンプルコードの詳細については、GitHubをご覧ください。