寫給大忙人看的 - Java中上傳文件至MinIO服務器（二）

上一篇 寫給大忙人看的 - 搭建文件服務器 MinIO（一），我們已經成功地搭建了 MinIO 文件服務器，這一篇講解在 Java 中如何上傳文件至 MinIO

一、開發前戲

1、項目中引入 maven 依賴

<!-- minio 相關依賴 -->
<dependency>
    <groupId>io.minio</groupId>
    <artifactId>minio</artifactId>
    <version>3.0.10</version>
</dependency>
<!-- alibaba的fastjson -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.51</version>
</dependency>
<!-- thymeleaf模板引擎 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

這裏除了 MinIO 的相關依賴，還添加了 fastjson，thymeleaf 的相關依賴，篇幅原因，其餘依賴請自行添加

2、添加配置信息

在 application.yml 文件中加入 MinIO 服務器的相關信息

# minio 文件存儲配置信息
minio:
  endpoint: http://127.0.0.1:9000
  accesskey: minioadmin
  secretKey: minioadmin

3、創建實體類

package com.zyxx.email.common.minio;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * minio 屬性值
 */
@Data
@Component
@ConfigurationProperties(prefix = "minio")
public class MinioProp {
    /**
     * 連接url
     */
    private String endpoint;
    /**
     * 用戶名
     */
    private String accesskey;
    /**
     * 密碼
     */
    private String secretKey;
}

這一步，我們將配置文件中 minio 的配置信息通過註解的方式注入到 MinioProp 這個實體中，方便後面我們使用

4、創建核心配置類

package com.zyxx.email.common.minio;

import io.minio.MinioClient;
import io.minio.errors.InvalidEndpointException;
import io.minio.errors.InvalidPortException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * minio 核心配置類
 */
@Configuration
@EnableConfigurationProperties(MinioProp.class)
public class MinioConfig {

    @Autowired
    private MinioProp minioProp;

    /**
     * 獲取 MinioClient
     *
     * @return
     * @throws InvalidPortException
     * @throws InvalidEndpointException
     */
    @Bean
    public MinioClient minioClient() throws InvalidPortException, InvalidEndpointException {
        return new MinioClient(minioProp.getEndpoint(), minioProp.getAccesskey(), minioProp.getSecretKey());
    }
}

通過注入 MinIO 服務器的相關配置信息，得到 MinioClient 對象，我們上傳文件依賴此對象

5、上傳工具類

package com.zyxx.email.common.minio;

import com.alibaba.fastjson.JSONObject;
import com.zyxx.email.common.redis.RedisUtil;
import com.zyxx.email.utils.DateUtils;
import io.minio.MinioClient;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

@Slf4j
@Component
public class MinioUtils {

    @Autowired
    private MinioClient client;
    @Autowired
    private MinioProp minioProp;

    /**
     * 創建bucket
     *
     * @param bucketName bucket名稱
     */
    @SneakyThrows
    public void createBucket(String bucketName) {
        if (!client.bucketExists(bucketName)) {
            client.makeBucket(bucketName);
        }
    }

    /**
     * 上傳文件
     *
     * @param file       文件
     * @param bucketName 存儲桶
     * @return
     */
    public JSONObject uploadFile(MultipartFile file, String bucketName) throws Exception {
        JSONObject res = new JSONObject();
        res.put("code", 0);
        // 判斷上傳文件是否爲空
        if (null == file || 0 == file.getSize()) {
            res.put("msg", "上傳文件不能爲空");
            return res;
        }
        // 判斷存儲桶是否存在
        createBucket(bucketName);
        // 文件名
        String originalFilename = file.getOriginalFilename();
        // 新的文件名 = 存儲桶名稱_時間戳.後綴名
        String fileName = bucketName + "_" + System.currentTimeMillis() + originalFilename.substring(originalFilename.lastIndexOf("."));
        // 開始上傳
        client.putObject(bucketName, fileName, file.getInputStream(), file.getContentType());
        res.put("code", 1);
        res.put("msg", minioProp.getEndpoint() + "/" + bucketName + "/" + fileName);
        return res;
    }
}

二、開發進行中

1、編寫 Controller

package com.zyxx.email.controller;

import com.alibaba.fastjson.JSONObject;
import com.zyxx.email.common.minio.MinioUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;

@Controller
public class MinioController {

    @Autowired
    private MinioUtils minioUtils;

    @GetMapping("init")
    public String init() {
        return "file";
    }

    /**
     * 上傳
     *
     * @param file
     * @param request
     * @return
     */
    @PostMapping("/upload")
    @ResponseBody
    public String upload(@RequestParam(name = "file", required = false) MultipartFile file, HttpServletRequest request) {
        JSONObject res = null;
        try {
            res = minioUtils.uploadFile(file, "product");
        } catch (Exception e) {
            e.printStackTrace();
            res.put("code", 0);
            res.put("msg", "上傳失敗");
        }
        return res.toJSONString();
    }
}

2、上傳頁面

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>首頁</title>
    </head>
    <body>
        <form accept-charset="UTF-8" th:action="@{upload}" method="post" enctype="multipart/form-data" target="_blank">
            文件:<input type="file" name="file"/>
            <input type="submit" value="上傳"/>
        </form>
    </body>
</html>

這裏我用的 thymeleaf 模板引擎

三、上傳測試

1、訪問地址

http://localhost:8080/init

2、啓動 MinIO 文件服務器

3、響應信息

{"msg":"http://127.0.0.1:9000/product/product_1589105654237.png","code":1}

http://127.0.0.1:9000/product/product_1589105654237.png 就是我們上傳之後得到的文件地址了

4、訪問文件

MinIO 形式上傳的文件也不支持直接訪問，我們如果需要直接訪問，還需要做如下操作：

設置 bucket 的 policy 策略：

設置該存儲桶下面的文件爲 Read and Write，這時我們就可以直接訪問了

四、完整工具類代碼

package com.zyxx.email.common.minio;

import com.alibaba.fastjson.JSONObject;
import com.zyxx.email.utils.DateUtils;
import io.minio.MinioClient;
import io.minio.ObjectStat;
import io.minio.messages.Bucket;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

import java.io.InputStream;
import java.util.*;

@Slf4j
@Component
public class MinioUtils {

    @Autowired
    private MinioClient client;
    @Autowired
    private MinioProp minioProp;

    /**
     * 創建bucket
     *
     * @param bucketName bucket名稱
     */
    @SneakyThrows
    public void createBucket(String bucketName) {
        if (!client.bucketExists(bucketName)) {
            client.makeBucket(bucketName);
        }
    }

    /**
     * 獲取全部bucket
     */
    @SneakyThrows
    public List<Bucket> getAllBuckets() {
        return client.listBuckets();
    }

    /**
     * 根據bucketName獲取信息
     *
     * @param bucketName bucket名稱
     */
    @SneakyThrows
    public Optional<Bucket> getBucket(String bucketName) {
        return client.listBuckets().stream().filter(b -> b.name().equals(bucketName)).findFirst();
    }

    /**
     * 根據bucketName刪除信息
     *
     * @param bucketName bucket名稱
     */
    @SneakyThrows
    public void removeBucket(String bucketName) {
        client.removeBucket(bucketName);
    }

    /**
     * 獲取文件外鏈
     *
     * @param bucketName bucket名稱
     * @param objectName 文件名稱
     * @param expires    過期時間 <=7
     * @return url
     */
    @SneakyThrows
    public String getObjectURL(String bucketName, String objectName, Integer expires) {
        return client.presignedGetObject(bucketName, objectName, expires);
    }

    /**
     * 獲取文件
     *
     * @param bucketName bucket名稱
     * @param objectName 文件名稱
     * @return 二進制流
     */
    @SneakyThrows
    public InputStream getObject(String bucketName, String objectName) {
        return client.getObject(bucketName, objectName);
    }

    /**
     * 上傳文件
     *
     * @param bucketName bucket名稱
     * @param objectName 文件名稱
     * @param stream     文件流
     * @throws Exception https://docs.minio.io/cn/java-client-api-reference.html#putObject
     */
    public void putObject(String bucketName, String objectName, InputStream stream) throws Exception {
        client.putObject(bucketName, objectName, stream, stream.available(), "application/octet-stream");
    }

    /**
     * 上傳文件
     *
     * @param bucketName  bucket名稱
     * @param objectName  文件名稱
     * @param stream      文件流
     * @param size        大小
     * @param contextType 類型
     * @throws Exception https://docs.minio.io/cn/java-client-api-reference.html#putObject
     */
    public void putObject(String bucketName, String objectName, InputStream stream, long size, String contextType) throws Exception {
        client.putObject(bucketName, objectName, stream, size, contextType);
    }

    /**
     * 獲取文件信息
     *
     * @param bucketName bucket名稱
     * @param objectName 文件名稱
     * @throws Exception https://docs.minio.io/cn/java-client-api-reference.html#statObject
     */
    public ObjectStat getObjectInfo(String bucketName, String objectName) throws Exception {
        return client.statObject(bucketName, objectName);
    }

    /**
     * 刪除文件
     *
     * @param bucketName bucket名稱
     * @param objectName 文件名稱
     * @throws Exception https://docs.minio.io/cn/java-client-api-reference.html#removeObject
     */
    public void removeObject(String bucketName, String objectName) throws Exception {
        client.removeObject(bucketName, objectName);
    }

    /**
     * 上傳文件
     *
     * @param file       文件
     * @param bucketName 存儲桶
     * @return
     */
    public JSONObject uploadFile(MultipartFile file, String bucketName) throws Exception {
        JSONObject res = new JSONObject();
        res.put("code", 0);
        // 判斷上傳文件是否爲空
        if (null == file || 0 == file.getSize()) {
            res.put("msg", "上傳文件不能爲空");
            return res;
        }
        // 判斷存儲桶是否存在
        createBucket(bucketName);
        // 文件名
        String originalFilename = file.getOriginalFilename();
        // 新的文件名
        String fileName = bucketName + "_" + DateUtils.getYyyymmdd() + originalFilename.substring(originalFilename.lastIndexOf("."));
        // 開始上傳
        client.putObject(bucketName, fileName, file.getInputStream(), file.getContentType());
        res.put("code", 1);
        res.put("msg", minioProp.getEndpoint() + "/" + bucketName + "/" + fileName);
        return res;
    }
}

文件的下載功能也相當簡單，這裏就不一一介紹了

Java Client 指南地址如下：

https://docs.min.io/docs/java-client-quickstart-guide.html

如您在閱讀中發現不足，歡迎留言！！！