文件上传时序图、桶策略、缩略图、分片上传、断点续传、前端直连。

README.md

@@ -1,10 +1,12 @@
-# 简介 | Intro
+# 0 简介 | Intro
 
 [MinIO-Plus](https://github.com/lxp135/minio-plus/) 是一个 [MinIO](https://github.com/minio/minio) 的二次封装与增强工具，在 MinIO 的基础上只做增强，不侵入 MinIO 代码，只为简化开发、提高效率而生。成为 MinIO 在项目中落地的润滑剂。
 
 > 我们的愿景是成为 MinIO 最好的搭档。
 
-# 特性 | Feature
+/TODO 演示地址
+
+# 1 特性 | Feature
 
 * **无侵入** ：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
 * **文件秒传** ：对每个上传的文件进行哈希摘要识别，用户上传同一个文件时，没有文件实际传输过程，做到秒传。
@@ -16,12 +18,14 @@
 * **访问链接时效** ：基于 MinIO 的临时链接创建策略，提供具备有效期并预签名的上传与下载地址。
 * **前端直连** ：前端直连 MinIO ，项目工程不做文件流的搬运，在支持以上特性的情况下提供 MinIO 原生性能。
 
-# 设计 | Design
+# 2 功能设计 | Function Design
 
-项目定位是一个SDK，非独立部署服务，并支持spring-boot自动装配。
+项目定位为一个MinIO的Java语言SDK，非独立部署服务，并支持spring-boot自动装配。
 用户自行实现数据存储部分，项目仅提供MySQL默认实现。
 
-## 文件下载
+/TODO 整体设计，包图
+
+## 2.1 文件下载 | File Download
 
 ![文件下载逻辑时序图](minio-plus-doc/image/文件下载时序图.png)
 
@@ -32,9 +36,11 @@
 
 浏览器拿到真实文件地址后，读取文件并显示或下载。
 
-## 文件上传
+## 2.2 文件上传 | File Upload
 
-## 文件秒传
+/TODO 上传流程活动图
+
+### 2.2.1 秒传
 
 ![秒传时序图](minio-plus-doc/image/秒传时序图.png)
 
@@ -44,17 +50,88 @@
 
 * 文件唯一标识生成：在浏览器端，使用MD5哈希算法对待传输文件进行哈希值编码。编码结果为一字符串，作为文件的唯一标识。
 * 文件重复性检测：在服务器端，根据接收到的文件唯一标识在数据库中进行搜索。如果在数据库中找到相同的文件唯一标识，那么判断该文件存在且无需再进行文件传输。
-* 文件传输：如果在服务器端未找到相同的文件唯一标识，那么浏览器端开始正常地将文件传输至服务器。
 
-# 代码托管
+### 2.2.2 分片上传
+
+分片上传是一种将大文件划分为多个片段并发或按序上传的技术。它有以下几个好处：
+
+* 提高传输速度：当上传的文件比较大时，将大文件进行分块，同时并发上传多个小块，而不是一整个大文件按顺序上传。这样可以最大限度地利用带宽，从而加快上传速度。
+* 支持断点续传：分块上传是断点续传技术的前置条件，要想实现断点续传，必须先支持分块。
+
+![文件上传时序图](minio-plus-doc/image/文件上传时序图.png)
+
+### 2.2.3 断点续传
+
+断点续传依赖于分片技术，是提高可用性的重要手段，优点如下：
+
+* 节省时间、减少网络IO、减少磁盘IO：在文件传输过程中遇到问题导致传输失败时，只需重新传输未完成的分片，而不需要重新开始整个传输任务。
+* 增加传输的可靠性：可以避免由于网络波动或其他原因导致整个文件需要重新传输的情况。再也不怕意外断网。在大文件传输时，尤其有用。
+* 随时暂停和恢复：用户可以在传输过程中暂停传输或者中断传输，断点续传可以方便地恢复传输任务。
+
+## 2.3 前端直连
+
+当用户进行文件流的上传和下载时，直接访问MinIO服务器（可配置Nginx代理）。
+
+使用minioclient的GetPresignedObjectUrlArgs方法，入参是一个GetPresignedObjectUrlArgs对象，该对象包含了以下属性：
+
+* bucketName：要访问的桶名。
+* objectName：要访问的对象名。
+* expires：URL的过期时间，单位为秒。
+
+该方法的返回值是一个字符串类型的URL，可以用于访问指定的对象，示例：
+
+```
+http://127.0.0.1:9000/test/test123
+?response-content-type=application%2Fmsword%22&response-content-disposition=attachment%3Bfilename%3D%22xxx.doc%22
+&X-Amz-Algorithm=AWS4-HMAC-SHA256
+&X-Amz-Credential=minioadmin%2F20230620%2Fus-east-1%2Fs3%2Faws4_request
+&X-Amz-Date=20230620T071735Z
+&X-Amz-Expires=60&X-Amz-SignedHeaders=host
+&X-Amz-Signature=5be3535042ffe72fedee8a283e7a5afbc2b068c595c16800cf57f089ed891cc5
+```
+
+每次前端请求文件时，都会生成预签名文件地址，文件地址中，有日期、时效、签名。MinIO会进行验签，保证安全性。
+
+## 2.4 缩略图
+
+在图片上传时，自动生成大中小三种缩略图，压缩时比例按照图片原始比例不做变化。使用相同的md5名称存入分别存入4个桶中。
+
+* 缩略图大：默认按照宽度600像素进行等比例压缩
+* 缩略图中：默认按照宽度300像素进行等比例压缩
+* 缩略图小：默认按照宽度100像素进行等比例压缩
+
+PS：原图尺寸小于缩略图压缩尺寸时，储存原图。
+
+## 2.5 桶策略
+
+* 文档（document）：txt、rtf、ofd、doc、docx、xls、xlsx、ppt、pptx、pdf
+* 压缩包（package）：zip、rar、7z、tar、wim、gz、bz2
+* 音频（ audio ）：mp3、wav、flac、acc、ogg、aiff、m4a、wma、midi
+* 视频（ video ）：mp4、avi、mov、wmv、flv、mkv、mpeg、mpg 、rmvb
+* 图片 – 原始（ image ）：jpeg、jpg、png、bmp、webp、gif
+* 图片 – 缩略图大（ image-large ）：同上，按照宽度 600 像素压缩
+* 图片 – 缩略图中（ image-medium ）：同上，按照宽度 300 像素压缩
+* 图片 – 缩略图小（ image-small ）：同上，按照宽度 100 像素压缩
+* 其他（ other ） ：未在上述格式中的文件
+
+其他规则：文件在桶中存储时，按照 /年/月 划分路径。用以规避Linux ext3文件系统下单个目录最多创建32000个目录的问题，参考了阿里云OSS的处理办法。
+
+
+# 3 接口设计 | Interface Design
+
+# 4 数据库设计 | Database Design
+
+# 5 使用 | Getting Started
+
+# 6 代码托管
 
 代码托管在 [https://github.com/lxp135/minio-plus](https://github.com/lxp135/minio-plus/) 仓库中，jar 发布到 Maven 中央仓库。
 
-# 版权 | License
+# 7 版权 | License
 
 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
-# 参与贡献
+# 8 参与贡献
 
 * 刘小平 contact@liuxp.me