[Fs] [MinIO] Add docs

docs/docs/reference/filesystem/minio/home.md

@@ -0,0 +1,135 @@
+---
+title: MinIO
+---
+
+在 DataCap 中目前已经支持 MinIO，支持功能如下：
+
+- 上传文件
+- 预览&下载文件
+- 删除文件
+
+### DataCap 使用配置
+
+---
+
+在 DataCap 中文件系统用于配置系统的缓冲以及临时文件的存储。修改 `application.properties` 文件如下内容：
+
+```properties
+datacap.fs.type=MinIO
+datacap.fs.access=
+datacap.fs.secret=
+datacap.fs.endpoint=
+datacap.fs.bucket=
+```
+
+- `datacap.fs.type`: 文件系统的类型只能是 **MinIO**
+- `datacap.fs.access`: MinIO 的 AccessKey
+- `datacap.fs.secret`: MinIO 的 SecretKey
+- `datacap.fs.endpoint`: MinIO 的 Endpoint，如 `http://localhost:9000`
+- `datacap.fs.bucket`: MinIO 的存储桶名称，如 `datacap`
+
+### 依赖使用方式
+
+---
+
+该插件支持第三方依赖方式引入，引入依赖如下：
+
+```xml
+<dependency>
+    <groupId>io.edurt.datacap</groupId>
+    <artifactId>datacap-fs-minio</artifactId>
+    <version>${VERSION}</version>
+</dependency>
+```
+
+使用代码如下：
+
+```kotlin
+package io.edurt.datacap.fs.minio
+
+import com.google.inject.Guice
+import com.google.inject.Injector
+import com.google.inject.Key
+import com.google.inject.TypeLiteral
+import io.edurt.datacap.fs.Fs
+import io.edurt.datacap.fs.FsManager
+import io.edurt.datacap.fs.FsRequest
+import org.junit.Assert.assertTrue
+import org.junit.Before
+import org.junit.Test
+import org.slf4j.LoggerFactory.getLogger
+import java.io.BufferedReader
+import java.io.FileInputStream
+import java.io.IOException
+import java.io.InputStreamReader
+import java.nio.charset.StandardCharsets
+
+class MinIOFsTest
+{
+    private val log = getLogger(this::class.java)
+    private val name = "MinIO"
+    private val fileName = "MinIOUtilsTest.kt"
+    private var request = FsRequest()
+    private var injector: Injector? = null
+
+    @Before
+    fun before()
+    {
+        request.access = System.getProperty("access")
+        request.secret = System.getProperty("secret")
+        request.bucket = System.getProperty("bucket")
+        request.fileName = fileName
+        request.endpoint = System.getProperty("endpoint")
+
+        injector = Guice.createInjector(FsManager())
+    }
+
+    @Test
+    fun writer()
+    {
+        val plugins: Set<Fs?>? = injector?.getInstance(Key.get(object : TypeLiteral<Set<Fs?>?>()
+        {}))
+        val plugin: Fs? = plugins?.first { v -> v?.name().equals(name) }
+
+        val stream = FileInputStream("src/test/kotlin/io/edurt/datacap/fs/minio/${fileName}")
+        request.stream = stream
+        val response = plugin !!.writer(request)
+        assertTrue(response.isSuccessful)
+    }
+
+    @Test
+    fun reader()
+    {
+        val plugins: Set<Fs?>? = injector?.getInstance(Key.get(object : TypeLiteral<Set<Fs?>?>()
+        {}))
+        val plugin: Fs? = plugins?.first { v -> v?.name().equals(name) }
+        val response = plugin !!.reader(request)
+        assertTrue(response.isSuccessful)
+
+        try
+        {
+            BufferedReader(InputStreamReader(response.context, StandardCharsets.UTF_8)).use { reader ->
+                var line: String?
+                while ((reader.readLine().also { line = it }) != null)
+                {
+                    log.info(line)
+                }
+            }
+        }
+        catch (e: IOException)
+        {
+            log.error("Reader error", e)
+        }
+    }
+
+    @Test
+    fun delete()
+    {
+        val plugins: Set<Fs?>? = injector?.getInstance(Key.get(object : TypeLiteral<Set<Fs?>?>()
+        {}))
+        val plugin: Fs? = plugins?.first { v -> v?.name().equals(name) }
+        val response = plugin !!.delete(request)
+        assertTrue(response.isSuccessful)
+    }
+}
+```

docs/mkdocs.yml

@@ -223,6 +223,7 @@ nav:
         - reference/filesystem/qiniu/home.md
         - reference/filesystem/cos/home.md
         - reference/filesystem/s3/home.md
+        - reference/filesystem/minio/home.md
   - NavReleaseNote:
       - 2024.03.9 (latest): release/latest.md
       - 2024.03.8: release/2024.03.8.md