文档中心

进度条（Android SDK）

最近更新时间：2024.02.04 18:31:01

首次发布时间：2022.12.01 16:31:40

SDK 的 putObject/appendObject/uploadPart/uploadFile/getObject 接口均支持进度条功能，您可以传入自定义接口来监听上传进度的相关事件，并实现自定义的业务逻辑。

示例代码

以下代码以 putObject 为例，展示如何使用进度条功能。

import android.os.Bundle;
import android.util.Log;

import androidx.appcompat.app.AppCompatActivity;

import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.comm.event.DataTransferListener;
import com.volcengine.tos.comm.event.DataTransferStatus;
import com.volcengine.tos.comm.event.DataTransferType;
import com.volcengine.tos.model.object.ObjectMetaRequestOptions;
import com.volcengine.tos.model.object.PutObjectBasicInput;
import com.volcengine.tos.model.object.PutObjectInput;
import com.volcengine.tos.model.object.PutObjectOutput;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;

public class PutObjectWithProgressExample extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        String endpoint = "your endpoint";
        String region = "your region";
        String accessKey = "your access key";
        String secretKey = "your secret key";
        String securityToken = "your security token";

        String bucketName = "bucket-example";
        String objectKey = "android-sdk-test-"+System.nanoTime();
        String filePath = getFilesDir().getPath() + "/test.txt";

        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_display_message);
        TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);

        Thread tosThread = new Thread(new Runnable() {
            @Override
            public void run() {
                DataTransferListener listener = new DataTransferListener() {
                    @Override
                    public void dataTransferStatusChange(DataTransferStatus dataTransferStatus) {
                        if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_STARTED) {
                            Log.i("putObject", "data transfer started.");
                        } else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_RW) {
                            Log.i("putObject", "data transfer, sends " + dataTransferStatus.getRwOnceBytes() +
                                    " bytes once, has sent " + dataTransferStatus.getConsumedBytes() +
                                    " bytes, total bytes: " + dataTransferStatus.getTotalBytes());
                        } else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_FAILED) {
                            Log.i("putObject", "data transfer failed, has sent bytes: " + dataTransferStatus.getConsumedBytes() +
                                    " , total bytes: " + dataTransferStatus.getTotalBytes());
                        } else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_SUCCEED) {
                            // 此处收到 DATA_TRANSFER_SUCCEED 不代表已经上传成功，需要等整个 putObject 调用完成才说明上传成功。
                            Log.i("putObject", "data transfer finishes, has sent bytes: " + dataTransferStatus.getConsumedBytes() +
                                    ", total bytes: " + dataTransferStatus.getTotalBytes());
                        }
                    }
                };
                try(FileInputStream inputStream = new FileInputStream(filePath)){
                    // 使用上传进度条需要设置数据总长度 ContentLength，该值将会显示在 DataTransferStatus.getTotalBytes() 中
                    ObjectMetaRequestOptions options = new ObjectMetaRequestOptions().setContentLength(new File(filePath).length());
                    PutObjectBasicInput basicInput = new PutObjectBasicInput().setBucket(bucketName).setKey(objectKey)
                            .setOptions(options).setDataTransferListener(listener);
                    PutObjectInput putObjectInput = new PutObjectInput().setPutObjectBasicInput(basicInput).setContent(inputStream);
                    PutObjectOutput output = tos.putObject(putObjectInput);
                    // 如果未 catch 到 TosException，代表上传成功。
                    Log.i("putObject", "putObject succeed, object's etag is " + output.getEtag());
                    Log.i("putObject", "putObject succeed, object's crc64 is " + output.getHashCrc64ecma());
                } catch (TosException e) {
                    Log.e("TosException", "putObject failed");
                    e.printStackTrace();
                } catch (IOException e) {
                    Log.e("IOException", "putObject read file failed");
                    e.printStackTrace();
                }
            }
        });

        tosThread.start();
    }
}

以下代码以 getObject 为例，展示如何使用进度条功能。

import android.os.Bundle;
import android.util.Log;

import androidx.appcompat.app.AppCompatActivity;

import com.volcengine.tos.TOSV2;
import com.volcengine.tos.TOSV2ClientBuilder;
import com.volcengine.tos.TosException;
import com.volcengine.tos.comm.event.DataTransferListener;
import com.volcengine.tos.comm.event.DataTransferStatus;
import com.volcengine.tos.comm.event.DataTransferType;
import com.volcengine.tos.model.object.GetObjectV2Input;
import com.volcengine.tos.model.object.GetObjectV2Output;

import java.io.FileOutputStream;
import java.io.IOException;

public class GetObjectWithProgressExample extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        String endpoint = "your endpoint";
        String region = "your region";
        String accessKey = "your access key";
        String secretKey = "your secret key";
        String securityToken = "your security token";

        String bucketName = "your bucket name";
        String objectKey = "your object key";
        String filePath = "your file path";

        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_display_message);
        TOSV2 tos = new TOSV2ClientBuilder().build(region, endpoint, accessKey, secretKey, securityToken);

        Thread tosThread = new Thread(new Runnable() {
            @Override
            public void run() {
                try{
                    DataTransferListener listener = new DataTransferListener() {
                        @Override
                        public void dataTransferStatusChange(DataTransferStatus dataTransferStatus) {
                            if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_STARTED) {
                                Log.i("getObject", "get object started.");
                            } else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_RW) {
                                Log.i("getObject", "get object, read " + dataTransferStatus.getRwOnceBytes() +
                                                " bytes once, has read " + dataTransferStatus.getConsumedBytes() + 
                                                " bytes, total bytes: " + dataTransferStatus.getTotalBytes());
                            } else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_FAILED) {
                                Log.i("getObject", "get object failed, has read bytes: " + dataTransferStatus.getConsumedBytes() +
                                        " , total bytes: " + dataTransferStatus.getTotalBytes());
                            } else if (dataTransferStatus.getType() == DataTransferType.DATA_TRANSFER_SUCCEED) {
                                // 此处收到 DATA_TRANSFER_SUCCEED 不代表下载完成，需要等 getObject 成功返回且未捕获 TosException 才说明下载成功。
                                Log.i("getObject", "get object finishes, has read bytes: " + dataTransferStatus.getConsumedBytes() +
                                        ", total bytes: " + dataTransferStatus.getTotalBytes());
                            }
                        }
                    };
                    GetObjectV2Input input = new GetObjectV2Input().setBucket(bucketName).setKey(objectKey).setDataTransferListener(listener);
                    // 以下代码展示如何将数据下载到本地文件
                    try(FileOutputStream fileOutputStream = new FileOutputStream(filePath);
                        GetObjectV2Output output = tos.getObject(input)) {
                        byte[] buffer = new byte[1024];
                        int length;
                        while ((length = output.getContent().read(buffer)) != -1) {
                            fileOutputStream.write(buffer, 0, length);
                        }
                        // 如果未捕获到 TosException，说明下载完成。
                        Log.i("getObject", "getObject succeed, object's metadata is " + output.getGetObjectBasicOutput());
                    } catch (IOException e) {
                        Log.e("IOException", "write data to file failed");
                        e.printStackTrace();
                    }
                } catch (TosException e) {
                    if (e.getStatusCode() == 404) {
                        // 下载不存在的对象会返回404
                        Log.e("TosException", "the object you want to download is not found");
                    } else {
                        Log.e("TosException", "getObject failed");
                    }
                    e.printStackTrace();
                }
            }
        });

        tosThread.start();
    }
}

示例代码

对象存储

进度条（Android SDK）

示例代码