SpringBoot 2.2.5 整合Minio，實(shí)現(xiàn)文件云存儲功能，附帶整理好的工具類

說明

  1. Minio可以做為云存儲的解決方案用來保存海量的圖片，視頻，文檔。由于采用Golang實(shí)現(xiàn)，服務(wù)端可以工作在Windows,Linux, OS X和FreeBSD上。配置簡單，基本是復(fù)制可執(zhí)行程序，單行命令可以運(yùn)行起來。
  2. GitHub地址，猛戳：https://github.com/minio/minio
  3. 官網(wǎng)地址，猛戳：https://docs.minio.io/cn/
  4. 搭建minio對象存儲服務(wù)不在本文討論范圍，后續(xù)會專門針對這個另寫一篇文章～
  5. 完整代碼地址在結(jié)尾?。?/li>

第一步，在pom.xml加入依賴，如下

<!-- minio -->
<dependency>
    <groupId>io.minio</groupId>
    <artifactId>minio</artifactId>
    <version>7.1.0</version>
</dependency>

第二步，編寫application.yml配置文件，如下

server:
  port: 8188

spring:
  application:
    name: minio-demo-server

# minio配置
minio:
  # minio地址
  endpoint: https://xxx
  # minio accessKey
  accessKey: xxx
  # minio secretKey
  secretKey: xxx

第三步，創(chuàng)建MinioProperties，MinioConfig配置文件，如下

MinioProperties

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

/**
 * 配置屬性
 * @author luoyu
 */
@Data
@Component
public class MinioProperties {

    /**
     * 對象存儲服務(wù)的URL
     */
    @Value("${minio.endpoint}")
    private String endpoint;

    /**
     * Access key就像用戶ID，可以唯一標(biāo)識你的賬戶
     */
    @Value("${minio.accessKey}")
    private String accessKey;

    /**
     * Secret key是你賬戶的密碼
     */
    @Value("${minio.secretKey}")
    private String secretKey;

}

MinioConfig

import io.minio.MinioClient;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 *
 * 配置類
 * @author luoyu
 */
@Slf4j
@Configuration
public class MinioConfig {

    @Autowired
    private MinioProperties minioProperties;

    @Bean
    public MinioClient minioClient() {
        MinioClient minioClient = null;
        try {
            minioClient = new MinioClient(minioProperties.getEndpoint(), minioProperties.getAccessKey(), minioProperties.getSecretKey());
        } catch (Exception e) {
            log.error("minio初始化失敗" + e);
        }
        return minioClient;
    }

}

第四步，創(chuàng)建MinioItem實(shí)體類，如下

import io.minio.messages.Item;
import io.minio.messages.Owner;
import lombok.Data;

import java.time.LocalDateTime;

@Data
public class MinioItem {

    // 文件名稱
    private String objectName;

    // 最后操作時間
    private LocalDateTime lastModified;

    private String etag;

    // 對象大小
    private String size;

    private String storageClass;

    private Owner owner;

    // 對象類型：directory（目錄）或file（文件）
    private String type;

    private String url;

    public MinioItem() {
    }

    public MinioItem(Item item) {
        this.objectName = item.objectName();
        this.type = item.isDir() ? "directory" : "file";
        this.etag = item.etag();
        long sizeNum = item.size();
        this.size = sizeNum > 0 ? this.convertFileSize(sizeNum):"0";
        this.storageClass = item.storageClass();
        this.owner = item.owner();
        this.lastModified = item.lastModified().toLocalDateTime();
    }

    public String convertFileSize(long size) {
        long kb = 1024;
        long mb = kb * 1024;
        long gb = mb * 1024;
        if (size >= gb) {
            return String.format("%.1f GB", (float) size / gb);
        } else if (size >= mb) {
            float f = (float) size / mb;
            return String.format(f > 100 ? "%.0f MB" : "%.1f MB", f);
        } else if (size >= kb) {
            float f = (float) size / kb;
            return String.format(f > 100 ? "%.0f KB" : "%.1f KB", f);
        } else{
            return String.format("%d B", size);
        }
    }

}

第五步，創(chuàng)建MinioUtils工具類，如下

import com.luoyu.minio.enitiy.MinioItem;
import io.minio.*;
import io.minio.http.Method;
import io.minio.messages.Bucket;
import io.minio.messages.Item;
import lombok.extern.slf4j.Slf4j;
import org.apache.tomcat.util.http.fileupload.IOUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import com.luoyu.minio.config.MinioProperties;
import org.springframework.util.CollectionUtils;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.*;
import java.util.stream.Collectors;

/**
 * @author luoyu
 */
@Slf4j
@Component
public class MinioUtils {

    @Autowired
    private MinioProperties minioProperties;

    @Autowired
    private MinioClient minioClient;

    /**
     * 檢查存儲桶是否存在
     * @param bucketName 存儲桶名稱
     * @return boolean
     */
    public boolean bucketExists(String bucketName){
        try {
            return minioClient.bucketExists(
                    BucketExistsArgs.builder()
                            .bucket(bucketName)
                            .build()
            );
        } catch (Exception e) {
            log.error("檢查存儲桶是否存在失?。? + e);
            return false;
        }
    }

    /**
     * 創(chuàng)建存儲桶
     * @param bucketName 存儲桶名稱
     * @return boolean
     */
    public boolean createBucket(String bucketName) {
        try {
            if (!this.bucketExists(bucketName)) {
                minioClient.makeBucket(
                        MakeBucketArgs.builder()
                                .bucket(bucketName)
                                .build()
                );
            }
            return true;
        } catch (Exception e) {
            log.error("創(chuàng)建存儲桶失?。? + e);
            return false;
        }
    }

    /**
     * 根據(jù)存儲桶名稱獲取信息
     * @param bucketName 存儲桶名稱
     * @return
     */
    public Optional<Bucket> getBucket(String bucketName) {
        try {
            return minioClient.listBuckets().stream().filter(b -> b.name().equals(bucketName)).findFirst();
        } catch (Exception e) {
            log.error("根據(jù)存儲桶名稱獲取信息失?。? + e);
            return null;
        }
    }

    /**
     * 根據(jù)存儲桶刪除信息
     * @param bucketName 存儲桶名稱
     */
    public void removeBucket(String bucketName) {
        try {
            minioClient.removeBucket(
                    RemoveBucketArgs.builder()
                            .bucket(bucketName)
                            .build()
            );
        } catch (Exception e) {
            log.error("根據(jù)存儲桶刪除信息失敗：" + e);
        }
    }

    /**
     * 根據(jù)文件前綴查詢文件
     * @param bucketName bucket名稱
     * @param prefix     前綴
     * @param recursive  是否遞歸查詢
     * @return MinioItem 列表
     */
    public List<MinioItem> getMinioItemsByPrefix(String bucketName, String prefix, Boolean recursive) {
        try {
            List<MinioItem> objectList = new ArrayList<>();
            Iterable<Result<Item>> objectsIterator = minioClient.listObjects(
                    ListObjectsArgs.builder()
                            .bucket(bucketName)
                            .prefix(prefix)
                            .recursive(recursive)
                            .build())
                    ;
            for (Result<Item> result : objectsIterator) {
                objectList.add(new MinioItem(result.get()));
            }
            return objectList;
        } catch (Exception e) {
            log.error("根據(jù)文件前綴查詢文件失?。? + e);
            return null;
        }
    }

    /**
     * 獲取文件外鏈地址
     * @param bucketName 存儲桶名稱
     * @param objectName 文件名稱
     * @param expiry 過期時間(秒) 最大為7天 超過7天則默認(rèn)最大值
     * @return String
     */
    public String getPresignedObjectUrl(String bucketName, String objectName, Integer expiry) {
        try {
            return minioClient.getPresignedObjectUrl(
                    GetPresignedObjectUrlArgs.builder()
                            .method(Method.GET)
                            .bucket(bucketName)
                            .object(objectName)
                            .expiry(expiry)
                            .build()
            );
        } catch (Exception e) {
            log.error("獲取文件外鏈地址失?。? + e);
            return null;
        }
    }

    /**
     * 獲取文件
     * @param bucketName 存儲桶名稱
     * @param objectName 文件名稱
     * @return 二進(jìn)制流
     */
    public InputStream getObject(String bucketName, String objectName) {
        try {
            return minioClient.getObject(
                    GetObjectArgs.builder()
                            .bucket(bucketName)
                            .object(objectName)
                            .build()
            );
        } catch (Exception e) {
            log.error("獲取文件失敗：" + e);
            return null;
        }
    }

    /**
     * 獲取全部存儲桶
     * @return List<Bucket>
     */
    public List<Bucket> getBuckets() {
        try {
            return minioClient.listBuckets();
        } catch (Exception e) {
            log.error("獲取全部存儲桶失?。? + e);
            return null;
        }
    }

    /**
     * 上傳文件
     * @param inputStream inputStream
     * @param objectName objectName
     * @param bucketName bucketName
     * @param contentType contentType
     */
    public void upload(InputStream inputStream, String objectName, String bucketName, String contentType) {
        try {
            // 檢查存儲桶是否已經(jīng)存在，不存在則創(chuàng)建
            this.createBucket(bucketName);
            // 使用putObject上傳一個文件到存儲桶中。
            minioClient.putObject(
                    PutObjectArgs.builder()
                            .bucket(bucketName)
                            .object(objectName)
                            .stream(inputStream, inputStream.available(), -1)
                            .contentType(contentType)
                            .build()
            );
            //關(guān)閉
            inputStream.close();
        } catch (Exception e) {
            log.error("上傳文件失?。? + e);
        }
    }

    /**
     * 下載文件
     *
     * @param response response
     * @param objectName objectName
     */
    public void download(HttpServletResponse response, String bucketName, String objectName) {
        InputStream inputStream = null;
        try {
            ObjectStat stat = minioClient.statObject(
                    StatObjectArgs.builder()
                            .bucket(bucketName)
                            .object(objectName)
                            .build()
            );
            inputStream = this.getObject(bucketName, objectName);
            response.setContentType(stat.contentType());
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(objectName, String.valueOf(StandardCharsets.UTF_8)));
            IOUtils.copy(inputStream, response.getOutputStream());
        } catch (Exception e) {
            log.error("下載文件失敗：" + e);
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    /**
     * 獲取文件url
     * @param objectName objectName
     * @return url
     */
    public String getObjectUrl(String bucketName, String objectName) {
        try {
            return minioClient.getObjectUrl(bucketName, objectName);
        } catch (Exception e) {
            log.error("獲取文件url失?。? + e);
            return null;
        }
    }

    /**
     * 獲取所有文件
     * @param bucketName bucketName
     */
    public List<MinioItem> list(String bucketName) {
        try {
            List<MinioItem> list = new ArrayList<MinioItem>();
            Iterable<Result<Item>> results = minioClient.listObjects(
                    ListObjectsArgs.builder()
                            .bucket(bucketName)
                            .build()
            );
            for (Result<Item> result : results) {
                Item item = result.get();
                MinioItem minioItem = new MinioItem(item);
                minioItem.setUrl(this.getObjectUrl(bucketName, item.objectName()));
                list.add(minioItem);
            }
            return list;
        } catch (Exception e) {
            log.error("獲取所有文件失?。? + e);
            return null;
        }
    }

    /**
     * 刪除文件
     * @param bucketName 存儲桶名稱
     * @param objectName 文件名
     */
    public void deleteObjectName(String bucketName, String objectName) {
        try {
            minioClient.removeObject(
                    RemoveObjectArgs.builder()
                            .bucket(bucketName)
                            .object(objectName)
                            .build()
            );
        } catch (Exception e) {
            log.error("刪除文件失敗：" + e);
        }
    }

    /**
     * 批量刪除文件
     * @param bucketName bucketName
     * @param objectNames 文件名列表
     */
    public void deleteObjectNames(String bucketName, List<String> objectNames) {
        objectNames.forEach(objectNamesItem -> {
            this.deleteObjectName(bucketName, objectNamesItem);
        });
    }

    /**
     * 創(chuàng)建上傳文件對象的外鏈
     * @param bucketName 存儲桶名稱
     * @param objectName 欲上傳文件對象的名稱
     * @param expiry 過期時間(秒) 最大為7天 超過7天則默認(rèn)最大值
     * @return uploadUrl
     */
    public String createUploadUrl(String bucketName, String objectName, Integer expiry){
        try {
            return minioClient.getPresignedObjectUrl(
                    GetPresignedObjectUrlArgs.builder()
                            .method(Method.PUT)
                            .bucket(bucketName)
                            .object(objectName)
                            .expiry(expiry)
                            .build()
            );
        } catch (Exception e) {
            log.error("創(chuàng)建上傳文件對象的外鏈?zhǔn)。? + e);
            return null;
        }
    }

    /**
     * 批量創(chuàng)建分片上傳外鏈
     * @param bucketName 存儲桶名稱
     * @param objectMD5 欲上傳分片文件主文件的MD5
     * @param chunkCount 分片數(shù)量
     * @param expiry 過期時間(秒) 最大為7天 超過7天則默認(rèn)最大值
     * @return uploadChunkUrls
     */
    public List<String> createUploadChunkUrlList(String bucketName, String objectMD5, Integer chunkCount, Integer expiry){
        objectMD5 += "/";
        if(null == chunkCount || 0 == chunkCount){
            return null;
        }
        List<String> urlList = new ArrayList<>(chunkCount);
        for (int i = 1; i <= chunkCount; i++){
            String objectName = objectMD5 + i + ".chunk";
            urlList.add(this.createUploadUrl(bucketName, objectName, expiry));
        }
        return urlList;
    }

    /**
     * 創(chuàng)建指定序號的分片文件上傳外鏈
     * @param bucketName 存儲桶名稱
     * @param objectMD5 欲上傳分片文件主文件的MD5
     * @param partNumber 分片序號
     * @param expiry 過期時間(秒) 最大為7天 超過7天則默認(rèn)最大值
     * @return uploadChunkUrl
     */
    public String createUploadChunkUrl(String bucketName, String objectMD5, Integer partNumber, Integer expiry){
        objectMD5 += "/" + partNumber + ".chunk";
        return this.createUploadUrl(bucketName, objectMD5, expiry);
    }

    /**
     * 獲取分片文件名稱列表
     * @param bucketName 存儲桶名稱
     * @param prefix 對象名稱前綴（ObjectMd5）
     * @param sort 是否排序(升序)
     * @return objectNames
     */
    public List<String> listObjectNames(String bucketName, String prefix, Boolean sort){
        try {
            ListObjectsArgs listObjectsArgs;
            if (null == prefix) {
                listObjectsArgs = ListObjectsArgs.builder()
                        .bucket(bucketName)
                        .recursive(true)
                        .build();
            } else {
                listObjectsArgs = ListObjectsArgs.builder()
                        .bucket(bucketName)
                        .prefix(prefix)
                        .recursive(true)
                        .build();
            }
            Iterable<Result<Item>> chunks = minioClient.listObjects(listObjectsArgs);
            List<String> chunkPaths = new ArrayList<>();
            for (Result<Item> item : chunks) {
                chunkPaths.add(item.get().objectName());
            }
            if (sort) {
                return chunkPaths.stream().distinct().collect(Collectors.toList());
            }
            return chunkPaths;
        } catch (Exception e) {
            log.error("獲取分片文件名稱列表失敗：" + e);
            return null;
        }
    }

    /**
     * 獲取分片名稱地址，HashMap：key=分片序號，value=分片文件地址
     * @param bucketName 存儲桶名稱
     * @param ObjectMd5 對象Md5
     * @return objectChunkNameMap
     */
    public Map<Integer, String> mapChunkObjectNames(String bucketName, String ObjectMd5, Boolean sort){
        List<String> chunkPaths = this.listObjectNames(bucketName,ObjectMd5, sort);
        if (CollectionUtils.isEmpty(chunkPaths)){
            return null;
        }
        Map<Integer, String> chunkMap = new HashMap<>(chunkPaths.size());
        for (String chunkName : chunkPaths) {
            Integer partNumber = Integer.parseInt(chunkName.substring(chunkName.indexOf("/") + 1, chunkName.lastIndexOf(".")));
            chunkMap.put(partNumber,chunkName);
        }
        return chunkMap;
    }

    /**
     * 合并分片文件成對象文件
     * @param chunkBucKetName 分片文件所在存儲桶名稱
     * @param composeBucketName 合并后的對象文件存儲的存儲桶名稱
     * @param chunkNames 分片文件名稱集合
     * @param objectName 合并后的對象文件名稱
     * @return true/false
     */
    public boolean composeObject(String chunkBucKetName, String composeBucketName, List<String> chunkNames, String objectName){
        try {
            List<ComposeSource> sourceObjectList = new ArrayList<>(chunkNames.size());
            for (String chunk : chunkNames) {
                sourceObjectList.add(
                        ComposeSource.builder()
                                .bucket(chunkBucKetName)
                                .object(chunk)
                                .build()
                );
            }
            minioClient.composeObject(
                    ComposeObjectArgs.builder()
                            .bucket(composeBucketName)
                            .object(objectName)
                            .sources(sourceObjectList)
                            .build()
            );
            return true;
        } catch (Exception e) {
            log.error("合并分片文件成對象文件失?。? + e);
            return false;
        }
    }

}

第六步，創(chuàng)建MinioController類，如下

import com.luoyu.minio.util.MinioUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.UUID;

/**
 * <p>
 * minio 前端控制器
 * </p>
 *
 * @author luoyu
 * @since 2018-11-30
 */
@Slf4j
@RestController
public class MinioController {

    @Autowired
    private MinioUtils minioUtils;

    /**
     * 上傳文件
     */
    @PostMapping("/minio/upload")
    public void uploadByMinio(MultipartFile file, String bucketName) throws Exception {
        if (file.getSize() < 1){
            log.warn("文件大小為：0");
            return;
        }
        String fileName = file.getOriginalFilename();
        String suffix = fileName.substring(fileName.lastIndexOf("."));
        InputStream inputStream = file.getInputStream();
        String contentType = file.getContentType();
        String patchName = this.getPath() + suffix;
        minioUtils.upload(inputStream, patchName, bucketName, contentType);
    }

    /**
     * 下載文件
     */
    @PostMapping("/minio/download")
    public void downloadByMinio(HttpServletResponse response, String bucketName, String fileName) throws Exception {
        minioUtils.download(response, bucketName, fileName);
    }

    /**
     * 文件路徑
     * @return 返回上傳路徑
     */
    private String getPath() {
        //生成uuid
        String uuid = UUID.randomUUID().toString().replaceAll("-", "");
        //文件路徑
        SimpleDateFormat sdf = new SimpleDateFormat("yyyyMMdd");
        return sdf.format(new Date()) + "/" + uuid;
    }

}

第七步，啟動項(xiàng)目，使用postman調(diào)接口，如下圖

測試上傳

image.png

到minio管理頁面查看上傳情況，以及上傳后生成的文件名

image.png

測試下載

image.png

完整代碼地址：https://github.com/Jinhx128/springboot-demo

注：此工程包含多個module，本文所用代碼均在minio-demo模塊下

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容