java 云存储 ProgressListener 如何实现上传文件时--跟踪上传进度

在阿里云对象存储（OSS）中，通过 uploadFile 方法上传文件时，可以设置进度监听器以实时监控上传进度。以下是详细的实现步骤和说明：

1. 初始化上传请求

在调用 uploadFile 方法之前，需要创建一个 UploadFileRequest 对象，并配置相关参数，例如 Bucket 名称、Object 名称、本地文件路径、分片大小、并发线程数等。

UploadFileRequest uploadFileRequest = new UploadFileRequest(bucketName, objectName);
// 设置本地文件路径
uploadFileRequest.setUploadFile(localFilePath);
// 设置分片大小（单位为字节，默认值为 100 KB）
uploadFileRequest.setPartSize(1 * 1024 * 1024); // 1 MB
// 设置并发线程数（默认值为 1）
uploadFileRequest.setTaskNum(5);
// 开启断点续传功能
uploadFileRequest.setEnableCheckpoint(true);

2. 设置进度监听器

为了实时监控上传进度，可以通过 setProgressListener 方法为上传任务添加进度监听器。监听器会在每次上传事件触发时回调 progressChanged 方法。

UploadFileResult result = client.uploadFile(uploadFileRequest);

result.getMultipartUploadResult().setProgressListener(new ProgressListener() {
    @Override
    public void progressChanged(ProgressEvent progressEvent) {
        // 打印当前已传输的字节数
        System.out.println("progressEvent==============>" + progressEvent.getBytesTransferred());
    }
});

关键点： - ProgressEvent 提供了与上传进度相关的详细信息，例如已传输的字节数 (getBytesTransferred) 和总字节数。 - 通过监听器，您可以动态更新 UI 或记录日志，以便用户了解上传状态。

3. 执行上传任务

调用 client.uploadFile(uploadFileRequest) 方法启动上传任务。如果上传过程中发生异常，可以通过捕获 OSSException 或 ClientException 进行错误处理。

try {
    UploadFileResult result = client.uploadFile(uploadFileRequest);
    System.out.println("上传成功！");
} catch (OSSException oe) {
    System.out.println("OSS 异常: " + oe.getErrorMessage());
    System.out.println("错误码: " + oe.getErrorCode());
} catch (ClientException ce) {
    System.out.println("客户端异常: " + ce.getMessage());
}

4. 注意事项

• 分片大小限制：分片大小必须在 100 KB 到 5 GB 之间。如果文件较小，建议直接使用简单上传方式。
• 断点续传：开启断点续传功能后，上传过程中的进度信息会保存在 .ucp 文件中。如果上传中断，可以从断点处继续上传。
• 并发控制：通过 setTaskNum 设置并发线程数，可以提高大文件上传效率，但需注意系统资源占用。

5. 完整示例代码

以下是一个完整的示例代码，展示如何通过 uploadFile 方法上传文件并设置进度监听器：

String bucketName = "examplebucket";
String objectName = "exampleobject.txt";
String localFilePath = "D:\\localpath\\examplefile.txt";

// 初始化上传请求
UploadFileRequest uploadFileRequest = new UploadFileRequest(bucketName, objectName);
uploadFileRequest.setUploadFile(localFilePath);
uploadFileRequest.setPartSize(1 * 1024 * 1024); // 1 MB
uploadFileRequest.setTaskNum(5); // 并发线程数
uploadFileRequest.setEnableCheckpoint(true); // 开启断点续传

try {
    // 执行上传任务
    UploadFileResult result = client.uploadFile(uploadFileRequest);

    // 设置进度监听器
    result.getMultipartUploadResult().setProgressListener(new ProgressListener() {
        @Override
        public void progressChanged(ProgressEvent progressEvent) {
            System.out.println("已传输字节数: " + progressEvent.getBytesTransferred());
        }
    });

    System.out.println("上传成功！");
} catch (OSSException oe) {
    System.out.println("OSS 异常: " + oe.getErrorMessage());
    System.out.println("错误码: " + oe.getErrorCode());
} catch (ClientException ce) {
    System.out.println("客户端异常: " + ce.getMessage());
}

6. 总结

通过上述步骤，您可以实现文件的分片上传，并实时监控上传进度。这种方式特别适用于大文件上传场景，能够有效提升上传效率和可靠性。