更新时间:2024-12-11 GMT+08:00
获取上传进度(Java SDK)
功能说明
获取指定对象的上传进度。
您可以通过PutObjectRequest.setProgressListener设置数据传输接口来获取上传的进度。
开发过程中,您有任何问题可以在github上提交issue。
接口约束
- 您必须拥有obs:object:PutObject权限,才能获取上传进度。相关授权操作可参见典型权限场景配置案例。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 支持获取上传进度的接口包括:流式上传、文件上传、上传段、追加上传和断点续传上传。
- 如果ProgressStatus.getTransferPercentage()返回-1,表明是流式上传,此时必须设置对象属性中的对象长度(Content-Length)。
方法定义
PutObjectRequest.setProgressListener(ProgressListener progressListener)
参数说明
代码示例
本示例用于获取将exampleLocalFilePath本地文件上传到examplebucket桶中objectname对象的进度。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
import com.obs.services.ObsClient; import com.obs.services.exception.ObsException; import com.obs.services.model.ProgressListener; import com.obs.services.model.ProgressStatus; import com.obs.services.model.PutObjectRequest; import java.io.File; public class PutObject005 { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。 // String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以中国-香港为例,其他地区请按实际情况填写。 String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com"; // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。 //String endPoint = System.getenv("ENDPOINT"); // 创建ObsClient实例 // 使用永久AK/SK初始化客户端 ObsClient obsClient = new ObsClient(ak, sk,endPoint); // 使用临时AK/SK和SecurityToken初始化客户端 // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint); try { // 文件上传 PutObjectRequest request = new PutObjectRequest("examplebucket", "exampleobject"); request.setFile(new File("exampleLocalFilePath")); request.setProgressListener( new ProgressListener() { @Override public void progressChanged(ProgressStatus status) { // 获取上传平均速率 System.out.println("AverageSpeed:" + status.getAverageSpeed()); // 获取上传进度百分比 System.out.println("TransferPercentage:" + status.getTransferPercentage()); } }); // 每上传1MB数据反馈上传进度 request.setProgressInterval(1024 * 1024L); obsClient.putObject(request); System.out.println("putObject successfully"); } catch (ObsException e) { System.out.println("putObject failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("putObject failed"); // 其他异常信息打印 e.printStackTrace(); } } } |
本示例用于获取将exampleFileName本地文件流式上传到examplebucket桶中objectname对象的进度。
import com.obs.services.ObsClient; import com.obs.services.ObsConfiguration; import com.obs.services.exception.ObsException; import com.obs.services.model.ObjectMetadata; import com.obs.services.model.ProgressListener; import com.obs.services.model.ProgressStatus; import com.obs.services.model.PutObjectRequest; import java.io.File; import java.io.FileInputStream; public class PutObjectByInputStreamWithProgress { public static void main(String[] args) { // 您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入。如果使用硬编码可能会存在泄露风险。 // 您可以登录访问管理控制台获取访问密钥AK/SK String ak = System.getenv("ACCESS_KEY_ID"); String sk = System.getenv("SECRET_ACCESS_KEY_ID"); // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。 // 您可以通过环境变量获取访问密钥AK/SK/SecurityToken,也可以使用其他外部引入方式传入。 String securityToken = System.getenv("SECURITY_TOKEN"); // endpoint填写桶所在的endpoint, 此处以华北-北京四为例,其他地区请按实际情况填写。 // 您可以通过环境变量获取endPoint,也可以使用其他外部引入方式传入。 // String endPoint = System.getenv("ENDPOINT"); String endPoint = "https://obs.cn-north-4.myhuaweicloud.com"; ObsConfiguration obsConfiguration = new ObsConfiguration(); obsConfiguration.setEndPoint(endPoint); // 创建ObsClient实例 try (ObsClient obsClient = new ObsClient(ak, sk, securityToken, obsConfiguration)) { String exampleBucket = "examplebucket"; String exampleObject = "objectname"; String fileToUpload = "exampleFileName"; long contentLength = new File(fileToUpload).length(); PutObjectRequest request = new PutObjectRequest(exampleBucket, exampleObject, new FileInputStream(fileToUpload)); ObjectMetadata objectMetadata = new ObjectMetadata(); // 流式上传,此时必须设置对象属性中的对象长度(Content-Length) // 不然ProgressStatus.getTransferPercentage()只会返回-1 objectMetadata.setContentLength(contentLength); request.setMetadata(objectMetadata); request.setProgressListener( new ProgressListener() { @Override public void progressChanged(ProgressStatus status) { // 获取上传平均速率 System.out.println("AverageSpeed:" + status.getAverageSpeed()); // 获取上传进度百分比 System.out.println("TransferPercentage:" + status.getTransferPercentage()); } }); // 每上传1MB数据反馈上传进度 request.setProgressInterval(1024 * 1024L); obsClient.putObject(request); System.out.println("putObject successfully"); } catch (ObsException e) { System.out.println("putObject failed"); // 请求失败,打印http状态码 System.out.println("HTTP Code:" + e.getResponseCode()); // 请求失败,打印服务端错误码 System.out.println("Error Code:" + e.getErrorCode()); // 请求失败,打印详细错误信息 System.out.println("Error Message:" + e.getErrorMessage()); // 请求失败,打印请求id System.out.println("Request ID:" + e.getErrorRequestId()); System.out.println("Host ID:" + e.getErrorHostId()); e.printStackTrace(); } catch (Exception e) { System.out.println("putObject failed"); // 其他异常信息打印 e.printStackTrace(); } } }
父主题: 上传对象(Java SDK)