docs 补充项目注释

2026-06-01 10:48:09 +08:00
parent f3ed8e82a7
commit 941c0b9032
73 changed files with 531 additions and 1 deletions
@@ -16,11 +16,13 @@
    </description>

    <dependencies>
+        <!-- 序列化模块 -->
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>ruoyi-common-json</artifactId>
        </dependency>

+        <!-- 缓存服务 -->
        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>ruoyi-common-redis</artifactId>
@@ -31,6 +31,21 @@ public record GetObjectResult(
        Map<String, String> metadata
 ) {

+    /**
+     * 构建文件对象获取结果。
+     *
+     * @param key 对象 Key
+     * @param eTag 对象 ETag
+     * @param lastModified 最后修改时间
+     * @param size 对象大小
+     * @param contentType 内容类型
+     * @param contentDisposition 内容处置方式
+     * @param contentRange 内容范围
+     * @param contentEncoding 内容编码
+     * @param contentLanguage 内容语言
+     * @param metadata 自定义元数据
+     * @return 文件对象获取结果
+     */
    public static GetObjectResult form(String key, String eTag, LocalDateTime lastModified, long size
            , String contentType, String contentDisposition, String contentRange, String contentEncoding, String contentLanguage
            , Map<String, String> metadata) {