Pre Merge pull request !516 from AprilWind/dev-oss

ruoyi-common/ruoyi-common-oss/src/main/java/org/dromara/common/oss/core/OssClient.java

@@ -1,5 +1,6 @@
 package org.dromara.common.oss.core;
 
+import cn.hutool.core.collection.CollUtil;
 import cn.hutool.core.io.IoUtil;
 import cn.hutool.core.util.IdUtil;
 import org.dromara.common.core.constant.Constants;
@@ -7,6 +8,7 @@ import org.dromara.common.core.utils.DateUtils;
 import org.dromara.common.core.utils.StringUtils;
 import org.dromara.common.core.utils.file.FileUtils;
 import org.dromara.common.oss.constant.OssConstant;
+import org.dromara.common.oss.entity.PartUploadResult;
 import org.dromara.common.oss.entity.UploadResult;
 import org.dromara.common.oss.enumd.AccessPolicyType;
 import org.dromara.common.oss.enumd.PolicyType;
@@ -19,7 +21,9 @@ import software.amazon.awssdk.core.async.BlockingInputStreamAsyncRequestBody;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.services.s3.S3AsyncClient;
 import software.amazon.awssdk.services.s3.S3Configuration;
+import software.amazon.awssdk.services.s3.model.CompletedPart;
 import software.amazon.awssdk.services.s3.model.NoSuchBucketException;
+import software.amazon.awssdk.services.s3.model.Part;
 import software.amazon.awssdk.services.s3.model.S3Exception;
 import software.amazon.awssdk.services.s3.presigner.S3Presigner;
 import software.amazon.awssdk.transfer.s3.S3TransferManager;
@@ -35,6 +39,8 @@ import java.net.URL;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.time.Duration;
+import java.util.List;
+import java.util.stream.Collectors;
 
 /**
  * S3 存储协议 所有兼容S3协议的云厂商均支持
@@ -274,10 +280,11 @@ public class OssClient {
     }
 
     /**
-     * 获取私有URL链接
+     * 生成预签名的私有对象获取 URL
      *
-     * @param objectKey 对象KEY
-     * @param second    授权时间
+     * @param objectKey 在 Amazon S3 中的对象键
+     * @param second    签名持续时间（秒）
+     * @return 预签名 URL 字符串
      */
     public String getPrivateUrl(String objectKey, Integer second) {
         // 使用 AWS S3 预签名 URL 的生成器 获取对象的预签名 URL
@@ -292,6 +299,137 @@ public class OssClient {
         return url.toString();
     }
 
+    /**
+     * 生成预签名的私有上传 URL
+     *
+     * @param key       在 Amazon S3 中的对象键
+     * @param md5Digest 内容的 MD5 摘要，如果有的话
+     * @param second    签名持续时间（秒）
+     * @return 上传结果对象
+     */
+    public UploadResult putPrivateUrl(String key, String md5Digest, Integer second) {
+        URL url = presigner.presignPutObject(
+            x -> x.signatureDuration(Duration.ofSeconds(second))
+                .putObjectRequest(
+                    y -> y.bucket(properties.getBucketName())
+                        .key(key)
+                        .contentMD5(StringUtils.isNotEmpty(md5Digest) ? md5Digest : null)
+                        .build()
+                ).build()
+        ).url();
+        return UploadResult.builder().url(getUrl() + StringUtils.SLASH + key).filename(key).privateUrl(url.toString()).build();
+    }
+
+    /**
+     * 创建分片上传任务
+     *
+     * @param key 在 Amazon S3 中的对象键
+     * @return 包含上传后的文件信息
+     */
+    public UploadResult initiateMultipartUpload(String key) {
+        try {
+            String uploadId = client.createMultipartUpload(
+                x -> x.bucket(properties.getBucketName())
+                    .key(key)
+                    .build()
+            ).join().uploadId();
+            return UploadResult.builder().url(getUrl() + StringUtils.SLASH + key).filename(key).uploadId(uploadId).build();
+        } catch (Exception e) {
+            // 捕获异常并抛出自定义异常
+            throw new OssException("创建分片上传任务失败，请检查配置信息:[" + e.getMessage() + "]");
+        }
+    }
+
+    /**
+     * 生成预签名的分片上传 URL
+     *
+     * @param key        在 Amazon S3 中的对象键
+     * @param uploadId   分片上传任务的 Upload ID
+     * @param partNumber 分片编号（从1开始递增）
+     * @param md5Digest  内容的 MD5 摘要，如果有的话
+     * @param second     签名持续时间（秒）
+     * @return 预签名 URL 字符串
+     */
+    public String uploadPartFutures(String key, String uploadId, Integer partNumber, String md5Digest, Integer second) {
+        URL url = presigner.presignUploadPart(
+            x -> x.signatureDuration(Duration.ofSeconds(second))
+                .uploadPartRequest(
+                    y -> y.bucket(properties.getBucketName())
+                        .key(key)
+                        .uploadId(uploadId)
+                        .partNumber(partNumber)
+                        .contentMD5(StringUtils.isNotEmpty(md5Digest) ? md5Digest : null)
+                        .build()
+                ).build()
+        ).url();
+        return url.toString();
+    }
+
+    /**
+     * 获取指定对象分片上传的分片列表
+     *
+     * @param key              在 Amazon S3 中的对象键
+     * @param uploadId         分片上传任务的 Upload ID
+     * @param maxParts         最大返回的分片数（默认为1000）
+     * @param partNumberMarker 分片编号的标记，用于分页查询（默认为0，表示从第一个分片开始查询）
+     * @return 包含分片上传结果信息的 PartUploadResult 对象列表
+     */
+    public List<PartUploadResult> listParts(String key, String uploadId, Integer maxParts, Integer partNumberMarker) {
+        try {
+            List<Part> parts = client.listParts(
+                x -> x.bucket(properties.getBucketName())
+                    .key(key)
+                    .uploadId(uploadId)
+                    .maxParts(maxParts != null ? maxParts : 1000)
+                    .partNumberMarker(partNumberMarker != null ? partNumberMarker : 0)
+                    .build()).join().parts();
+            return parts.stream()
+                .map(x -> PartUploadResult.builder()
+                    .partNumber(x.partNumber())
+                    .eTag(x.eTag())
+                    .build())
+                .collect(Collectors.toList());
+        } catch (Exception e) {
+            // 捕获异常并抛出自定义异常
+            throw new OssException("获取分片列表失败，请检查配置信息:[" + e.getMessage() + "]");
+        }
+    }
+
+    /**
+     * 完成分片上传任务
+     *
+     * @param key               在 Amazon S3 中的对象键
+     * @param uploadId          分片上传任务的 Upload ID
+     * @param partUploadResults 已完成的分片列表（必须是唯一且按照递增顺序排列，严格检查是否漏传）
+     * @return 包含上传后的文件信息
+     */
+    public UploadResult completeMultipartUpload(String key, String uploadId, List<PartUploadResult> partUploadResults) {
+        if (CollUtil.isEmpty(partUploadResults)) {
+            throw new OssException("分片列表不能为空");
+        }
+        List<CompletedPart> completedParts = partUploadResults.stream()
+            .map(x -> CompletedPart.builder()
+                .partNumber(x.getPartNumber())
+                .eTag(x.getETag())
+                .build())
+            .collect(Collectors.toList());
+        try {
+            String eTag = client.completeMultipartUpload(
+                x -> x.bucket(properties.getBucketName())
+                    .key(key)
+                    .uploadId(uploadId)
+                    .multipartUpload(y -> y.parts(completedParts)
+                        .build())
+                    .build()
+            ).join().eTag();
+            // 提取上传结果中的 ETag，并构建一个自定义的 UploadResult 对象
+            return UploadResult.builder().url(getUrl() + StringUtils.SLASH + key).filename(key).eTag(eTag).build();
+        } catch (Exception e) {
+            // 捕获异常并抛出自定义异常
+            throw new OssException("上传文件失败，请检查配置信息:[" + e.getMessage() + "]");
+        }
+    }
+
     /**
      * 上传 byte[] 数据到 Amazon S3，使用指定的后缀构造对象键。
      *
@@ -329,6 +467,18 @@ public class OssClient {
         return upload(file.toPath(), getPath(properties.getPrefix(), suffix), null);
     }
 
+    /**
+     * 并生成私有上传预签名 URL
+     *
+     * @param suffix    文件后缀
+     * @param md5Digest 内容的 MD5 摘要，如果有的话
+     * @param second    预签名 URL 的有效期（秒）
+     * @return 上传结果对象
+     */
+    public UploadResult uploadSuffix(String suffix, String md5Digest, Integer second) {
+        return putPrivateUrl(getPath(properties.getPrefix(), suffix), md5Digest, second);
+    }
+
     /**
      * 获取文件输入流
      *

ruoyi-common/ruoyi-common-oss/src/main/java/org/dromara/common/oss/entity/PartUploadResult.java

@@ -0,0 +1,25 @@
+package org.dromara.common.oss.entity;
+
+import lombok.Builder;
+import lombok.Data;
+
+/**
+ * 上传部件返回体
+ *
+ * @author AprilWind
+ */
+@Data
+@Builder
+public class PartUploadResult {
+
+    /**
+     * 分片编号（从1开始递增）
+     */
+    private Integer partNumber;
+
+    /**
+     * 从上传部分的内容生成的实体标签
+     */
+    private String eTag;
+
+}

ruoyi-common/ruoyi-common-oss/src/main/java/org/dromara/common/oss/entity/UploadResult.java

@@ -27,4 +27,16 @@ public class UploadResult {
      */
     private String eTag;
 
+    /**
+     * 用于分片上传任务的 Upload ID
+     * 在初始化分片上传时获取，并在后续的分片上传和完成上传过程中使用
+     */
+    private String uploadId;
+
+    /**
+     * 用于私有预签名 URL
+     * 用于上传文件或分片的预签名 URL，确保文件或分片在上传时具有私有访问权限
+     */
+    private String privateUrl;
+
 }