Simple WPF: S3实现MINIO大文件上传并显示上传进度

simple,wpf,s3,minio · 浏览次数 : 25

小编点评

本文将介绍如何使用AWS SDK for .NET Core实现S3文件的上传，并在上传大文件时显示进度。首先，我们需要创建一个基本的AWS认证，配置S3客户端。接下来，我们将使用TransferUtility类来上传文件，并通过监听UploadProgressEvent事件来获取上传进度。实现步骤如下： 1. 创建AWS认证首先，我们需要创建一个BasicAWSCredentials对象来存储访问密钥和秘密密钥。示例代码如下： ```csharp var credentials = new BasicAWSCredentials(_accessKey, _secretKey); ``` 2. 配置S3客户端接下来，我们需要为S3客户端配置基本配置，如端点URL、是否强制路径风格等。示例代码如下： ```csharp var clientConfig = new AmazonS3Config { ForcePathStyle = true, ServiceURL = _endpoint, }; ``` 3. 创建TransferUtility 使用刚才创建的认证和配置信息，我们可以创建一个TransferUtility对象。示例代码如下： ```csharp var fileTransferUtility = new TransferUtility(client); ``` 4. 创建TransferUtilityUploadRequest 然后，我们需要创建一个TransferUtilityUploadRequest对象，用于指定要上传的文件和存储桶名称。示例代码如下： ```csharp var uploadRequest = new TransferUtilityUploadRequest { BucketName = LargeBucket, FilePath = UploadLargeFile, Key = System.IO.Path.GetFileName(UploadLargeFile), }; ``` 5. 监听UploadProgressEvent事件在此步骤中，我们将监听TransferUtilityUploadRequest对象的UploadProgressEvent事件。每当上传进度发生变化时，我们将调用UpdateProgress方法来更新用户界面上的上传进度条。示例代码如下： ```csharp uploadRequest.UploadProgressEvent += UploadRequest_UploadProgressEvent; ``` 6. 异步上传文件最后，我们定义一个异步方法来执行文件上传操作。在这个方法中，我们会调用前面的TransferUtilityUploadRequest对象来执行上传操作。示例代码如下： ```csharp private async Task UploadLargeFileAsync() { // ... 省略其他代码 ... var uploadRequest = new TransferUtilityUploadRequest { // ... 省略其他代码 ... }; try { await fileTransferUtility.UploadAsync(uploadRequest); } catch (FileNotFoundException e) { // ... 省略其他代码 ... } catch (AmazonS3Exception e) { // ... 省略其他代码 ... } catch (Exception e) { // ... 省略其他代码 ... } return ret; } ``` 7. 更新上传进度在上传进度事件处理函数中，我们需要使用Dispatcher来更新数据到UI上。示例代码如下： ```csharp private void UploadRequest_UploadProgressEvent(object? sender, UploadProgressArgs e) { this.Dispatcher.Invoke((Action)(() => { this.uploadProgress.Value = e.TransferredBytes * 100 / e.TotalBytes; })); } ``` 8. 测试程序最后，我们可以运行程序并测试上传功能。当文件上传完成后，可以在UI上查看上传进度条的进度。参考链接：[https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpu-upload-object.html](https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpu-upload-object.html) 通过以上步骤，我们可以实现在上传大文件时显示进度。希望这个例子对您有所帮助！

正文

最新内容优先发布于个人博客：小虎技术分享站，随后逐步搬运到博客园。
创作不易，如果觉得有用请在Github上为博主点亮一颗小星星吧！

目的

早两天写了一篇S3简单上传文件的小工具，知乎上看到了一个问题问如何实现显示MINIO上传进度，因此拓展一下这个小工具能够在上传大文件时显示进度。

完整代码托管于Github：mrchipset/simple-wpf

实现方式

先通过Xaml编写一个包含上传进度条的小界面。具体内容就不赘述了，可以参考这篇文章
为了得到上传进度就不能再简单地使用PutObjectRequest 进行上传需要使用S3中TransferUtility 提供的高等级API进行上传。
然后创建一个TransferUtilityUploadRequest 对象并绑定其UploadProgressEvent 事件以实现上传进度的监控

具体的实现代码如下：

private async Task<bool> UploadLargeFileAsync()
{
    var credentials = new BasicAWSCredentials(_accessKey, _secretKey);

    var clientConfig = new AmazonS3Config
    {
        ForcePathStyle = true,
        ServiceURL = _endpoint,
    };

    bool ret = true;
    using (var client = new AmazonS3Client(credentials, clientConfig))
    {


        try
        {
            var fileTransferUtility = new TransferUtility(client);

            var uploadRequest = new TransferUtilityUploadRequest
            {
                BucketName = LargeBucket,
                FilePath = UploadLargeFile,
                Key = System.IO.Path.GetFileName(UploadLargeFile)
            };

            uploadRequest.UploadProgressEvent += UploadRequest_UploadProgressEvent;

            await fileTransferUtility.UploadAsync(uploadRequest);
        }
        catch (FileNotFoundException e)
        {
            ret = false;
            this.Dispatcher.Invoke(new Action(() => this.statusLargeTxtBlk.Text = e.Message));
        }
        catch (AmazonS3Exception e)
        {
            ret = false;
            if (e.ErrorCode != null &&
                (e.ErrorCode.Equals("InvalidAccessKeyId") ||
            e.ErrorCode.Equals("InvalidSecurity")))
            {
                this.Dispatcher.Invoke(new Action(() => this.statusLargeTxtBlk.Text = "Please check the provided AWS Credentials"));
            }
            else
            {
                this.Dispatcher.Invoke(new Action(() => this.statusLargeTxtBlk.Text = $"An error occurred with the message '{e.Message}' when writing an object"));
            }
        }
        catch(Exception e)
        {
            this.Dispatcher.Invoke(new Action(() => this.statusLargeTxtBlk.Text = $"An error occurred with the message '{e.Message}' when writing an object"));
        }
    }
    return ret;
}

private void UploadRequest_UploadProgressEvent(object? sender, UploadProgressArgs e)
{
    this.Dispatcher.Invoke((Action)(() =>
    {
        this.uploadProgress.Value = e.TransferredBytes * 100 / e.TotalBytes ;
    }));
}

值得一提的时，在上传进度的事件处理函数中，由于我们通过异步方法执行上传函数，因此我们需要使用Dispatcher 来更新数据到UI 上。

演示效果

参考连接

https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpu-upload-object.html

https://www.xtigerkin.com/archives/96/