SpringBoot三十六：整合MinIo文件服务
什么是MinIo
Minio是Apcche旗下的一款开源的轻量级文件服务器，基于对象存储，协议是基于Apache License v2.0，开源可用于商务。
Minio主要用来存储非结构化的数据，类似文件，图片，照片，日志文件，各类备份文件等，按照官网描述，文件的大小从几KB到5TB。
Minio提供了非常方便，友好的界面，并且文档也是非常丰富，具体可以参考它的文档：https://docs.min.io/cn/
为什么选择MinIo
在之前开发中曾使用了分布式文件服务FASTDFS和阿里云的OSS对象存储来存储。奈何OSS太贵，FASTDFS搭建配置又太繁琐，今天给大家推荐一款极易上手的高性能对象存储服务MinIo。
MinIO 是高性能的对象存储，兼容 Amazon S3接口，充分考虑开发人员的需求和体验；支持分布式存储，具备高扩展性、高可用性；部署简单但功能丰富。官方的文档也很详细。它有多种不同的部署模式（单机部署，分布式部署）。
为什么说 MinIO 简单易用，原因就在于它的启动、运行和配置都很简单。可以通过 docker 方式进行安装运行，也可以下载二进制文件，然后使用脚本运行。
安装MinIo
推荐使用 docker 一键安装：
docker run -it -p 9000:9000 --name minio \
-d --restart=always \
-e "MINIO_ACCESS_KEY=admin" \
-e "MINIO_SECRET_KEY=admin123456" \
-v /mnt/minio/data:/data \
-v /mnt/minio/config:/root/.minio \
minio/minio server /data
注意：
- 密钥必须大于8位，否则会创建失败
- 文件目录和配置文件一定要映射到主机，你懂得
整合Nginx
server{
listen 80;
server_name minio.javakf.com.cn;
location /{
proxy_set_header Host $http_host;
proxy_pass http://localhost:9000;
}
location ~ /\.ht {
deny all;
}
}
这样，通过浏览器访问配置的地址，使用指定的 MINIO_ACCESS_KEY 及 MINIO_SECRET_KEY 登录即可。
简单看了一下，功能还算可以，支持创建Bucket，文件上传、删除、分享、下载，同时可以对Bucket设置读写权限。
整合SpringBoot
Minio支持接入JavaScript、Java、Python、Golang等多种语言，这里我们选择最熟悉的Java语言，使用最流行的框架 SpringBoot。
pom.xml
io.minio</groupId>
minio</artifactId>
7.0.2</version>
</dependency>
org.projectlombok</groupId>
lombok</artifactId>
</dependency>
application.yml
#minio配置
minio:
endpoint: http://192.168.179.131:9000/
accessKey: admin
secretKey: admin123456
Minio客户端配置类，并注入到Spring中
@Data
@Configuration
@ConfigurationProperties(prefix = "minio")
public class MinioConfig {
private String endpoint;
private String accessKey;
private String secretKey;
@Bean
public MinioClient getMinioClient() throws InvalidEndpointException, InvalidPortException {
MinioClient minioClient = new MinioClient(endpoint, accessKey, secretKey);
return minioClient;
}
}
工具类
@Component
public class MinioUtil {
@Autowired
private MinioClient minioClient;
private static final int DEFAULT_EXPIRY_TIME = 7 * 24 * 3600;
/**
* 检查存储桶是否存在
*
* @param bucketName 存储桶名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public boolean bucketExists(String bucketName) throws InvalidKeyException, ErrorResponseException,
IllegalArgumentException, InsufficientDataException, InternalException, InvalidBucketNameException,
InvalidResponseException, NoSuchAlgorithmException, XmlParserException, IOException {
boolean flag = minioClient.bucketExists(bucketName);
if (flag) {
return true;
}
return false;
}
/**
* 创建存储桶
*
* @param bucketName 存储桶名称
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
* @throws RegionConflictException
*/
public boolean makeBucket(String bucketName)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException, RegionConflictException {
boolean flag = bucketExists(bucketName);
if (!flag) {
minioClient.makeBucket(bucketName);
return true;
} else {
return false;
}
}
/**
* 列出所有存储桶名称
*
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public List<String> listBucketNames() throws InvalidKeyException, ErrorResponseException, IllegalArgumentException,
InsufficientDataException, InternalException, InvalidBucketNameException, InvalidResponseException,
NoSuchAlgorithmException, XmlParserException, IOException {
List<Bucket> bucketList = listBuckets();
List<String> bucketListName = new ArrayList<>();
for (Bucket bucket : bucketList) {
bucketListName.add(bucket.name());
}
return bucketListName;
}
/**
* 列出所有存储桶
*
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public List<Bucket> listBuckets() throws InvalidKeyException, ErrorResponseException, IllegalArgumentException,
InsufficientDataException, InternalException, InvalidBucketNameException, InvalidResponseException,
NoSuchAlgorithmException, XmlParserException, IOException {
return minioClient.listBuckets();
}
/**
* 删除存储桶
*
* @param bucketName 存储桶名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public boolean removeBucket(String bucketName) throws InvalidKeyException, ErrorResponseException,
IllegalArgumentException, InsufficientDataException, InternalException, InvalidBucketNameException,
InvalidResponseException, NoSuchAlgorithmException, XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
Iterable<Result<Item>> myObjects = listObjects(bucketName);
for (Result<Item> result : myObjects) {
Item item = result.get();
// 有对象文件，则删除失败
if (item.size() > 0) {
return false;
}
}
// 删除存储桶，注意，只有存储桶为空时才能删除成功。
minioClient.removeBucket(bucketName);
flag = bucketExists(bucketName);
if (!flag) {
return true;
}
}
return false;
}
/**
* 列出存储桶中的所有对象名称
*
* @param bucketName 存储桶名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public List<String> listObjectNames(String bucketName) throws InvalidKeyException, ErrorResponseException,
IllegalArgumentException, InsufficientDataException, InternalException, InvalidBucketNameException,
InvalidResponseException, NoSuchAlgorithmException, XmlParserException, IOException {
List<String> listObjectNames = new ArrayList<>();
boolean flag = bucketExists(bucketName);
if (flag) {
Iterable<Result<Item>> myObjects = listObjects(bucketName);
for (Result<Item> result : myObjects) {
Item item = result.get();
listObjectNames.add(item.objectName());
}
}
return listObjectNames;
}
/**
* 列出存储桶中的所有对象
*
* @param bucketName 存储桶名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public Iterable<Result<Item>> listObjects(String bucketName) throws InvalidKeyException, ErrorResponseException,
IllegalArgumentException, InsufficientDataException, InternalException, InvalidBucketNameException,
InvalidResponseException, NoSuchAlgorithmException, XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
return minioClient.listObjects(bucketName);
}
return null;
}
/**
* 通过文件上传到对象
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @param fileName File name
* @return
* @throws InvalidKeyException
* @throws ErrorResponseException
* @throws IllegalArgumentException
* @throws InsufficientDataException
* @throws InternalException
* @throws InvalidBucketNameException
* @throws InvalidResponseException
* @throws NoSuchAlgorithmException
* @throws XmlParserException
* @throws IOException
*/
public boolean putObject(String bucketName, String objectName, String fileName)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
minioClient.putObject(bucketName, objectName, fileName, null);
ObjectStat statObject = statObject(bucketName, objectName);
if (statObject != null && statObject.length() > 0) {
return true;
}
}
return false;
}
/**
* 通过InputStream上传对象
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @param stream 要上传的流
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public boolean putObject(String bucketName, String objectName, InputStream stream)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
minioClient.putObject(bucketName, objectName, stream, new PutObjectOptions(stream.available(), -1));
ObjectStat statObject = statObject(bucketName, objectName);
if (statObject != null && statObject.length() > 0) {
return true;
}
}
return false;
}
/**
* 以流的形式获取一个文件对象
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public InputStream getObject(String bucketName, String objectName)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
ObjectStat statObject = statObject(bucketName, objectName);
if (statObject != null && statObject.length() > 0) {
InputStream stream = minioClient.getObject(bucketName, objectName);
return stream;
}
}
return null;
}
/**
* 以流的形式获取一个文件对象（断点下载）
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @param offset 起始字节的位置
* @param length 要读取的长度 (可选，如果无值则代表读到文件结尾)
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public InputStream getObject(String bucketName, String objectName, long offset, Long length)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
ObjectStat statObject = statObject(bucketName, objectName);
if (statObject != null && statObject.length() > 0) {
InputStream stream = minioClient.getObject(bucketName, objectName, offset, length);
return stream;
}
}
return null;
}
/**
* 下载并将文件保存到本地
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @param fileName File name
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public boolean getObject(String bucketName, String objectName, String fileName)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
ObjectStat statObject = statObject(bucketName, objectName);
if (statObject != null && statObject.length() > 0) {
minioClient.getObject(bucketName, objectName, fileName);
return true;
}
}
return false;
}
/**
* 删除一个对象
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public boolean removeObject(String bucketName, String objectName)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
minioClient.removeObject(bucketName, objectName);
return true;
}
return false;
}
/**
* 删除指定桶的多个文件对象,返回删除错误的对象列表，全部删除成功，返回空列表
*
* @param bucketName 存储桶名称
* @param objectNames 含有要删除的多个object名称的迭代器对象
* @return
* @throws InvalidKeyException
* @throws ErrorResponseException
* @throws IllegalArgumentException
* @throws InsufficientDataException
* @throws InternalException
* @throws InvalidBucketNameException
* @throws InvalidResponseException
* @throws NoSuchAlgorithmException
* @throws XmlParserException
* @throws IOException
*/
public List<String> removeObject(String bucketName, List<String> objectNames)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
List<String> deleteErrorNames = new ArrayList<>();
boolean flag = bucketExists(bucketName);
if (flag) {
Iterable<Result<DeleteError>> results = minioClient.removeObjects(bucketName, objectNames);
for (Result<DeleteError> result : results) {
DeleteError error = result.get();
deleteErrorNames.add(error.objectName());
}
}
return deleteErrorNames;
}
/**
* 生成一个给HTTP GET请求用的presigned URL。
* 浏览器/移动端的客户端可以用这个URL进行下载，即使其所在的存储桶是私有的。这个presigned URL可以设置一个失效时间，默认值是7天。
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @param expires 失效时间（以秒为单位），默认是7天，不得大于七天
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
* @throws InvalidExpiresRangeException
*/
public String presignedGetObject(String bucketName, String objectName, Integer expires)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException, InvalidExpiresRangeException {
boolean flag = bucketExists(bucketName);
String url = "";
if (flag) {
if (expires < 1 || expires > DEFAULT_EXPIRY_TIME) {
throw new InvalidExpiresRangeException(expires,
"expires must be in range of 1 to " + DEFAULT_EXPIRY_TIME);
}
url = minioClient.presignedGetObject(bucketName, objectName, expires);
}
return url;
}
/**
* 生成一个给HTTP PUT请求用的presigned URL。
* 浏览器/移动端的客户端可以用这个URL进行上传，即使其所在的存储桶是私有的。这个presigned URL可以设置一个失效时间，默认值是7天。
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @param expires 失效时间（以秒为单位），默认是7天，不得大于七天
* @return
* @throws InvalidKeyException
* @throws ErrorResponseException
* @throws IllegalArgumentException
* @throws InsufficientDataException
* @throws InternalException
* @throws InvalidBucketNameException
* @throws InvalidResponseException
* @throws NoSuchAlgorithmException
* @throws XmlParserException
* @throws IOException
* @throws InvalidExpiresRangeException
*/
public String presignedPutObject(String bucketName, String objectName, Integer expires)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException, InvalidExpiresRangeException {
boolean flag = bucketExists(bucketName);
String url = "";
if (flag) {
if (expires < 1 || expires > DEFAULT_EXPIRY_TIME) {
throw new InvalidExpiresRangeException(expires,
"expires must be in range of 1 to " + DEFAULT_EXPIRY_TIME);
}
url = minioClient.presignedPutObject(bucketName, objectName, expires);
}
return url;
}
/**
* 获取对象的元数据
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public ObjectStat statObject(String bucketName, String objectName)
throws InvalidKeyException, ErrorResponseException, IllegalArgumentException, InsufficientDataException,
InternalException, InvalidBucketNameException, InvalidResponseException, NoSuchAlgorithmException,
XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
if (flag) {
ObjectStat statObject = minioClient.statObject(bucketName, objectName);
return statObject;
}
return null;
}
/**
* 文件访问路径
*
* @param bucketName 存储桶名称
* @param objectName 存储桶里的对象名称
* @return
* @throws IOException
* @throws XmlParserException
* @throws NoSuchAlgorithmException
* @throws InvalidResponseException
* @throws InvalidBucketNameException
* @throws InternalException
* @throws InsufficientDataException
* @throws IllegalArgumentException
* @throws ErrorResponseException
* @throws InvalidKeyException
*/
public String getObjectUrl(String bucketName, String objectName) throws InvalidKeyException, ErrorResponseException,
IllegalArgumentException, InsufficientDataException, InternalException, InvalidBucketNameException,
InvalidResponseException, NoSuchAlgorithmException, XmlParserException, IOException {
boolean flag = bucketExists(bucketName);
String url = "";
if (flag) {
url = minioClient.getObjectUrl(bucketName, objectName);
}
return url;
}
}
目前SDK不支持文件夹的创建，如果想创建文件夹，只能通过文件的方式上传并创建。
minIoUtils.putObject("javakf","test/1.jpg","C:\\1.jpg");
一个实例只能有一个账号，如果想使用多个账号，需要创建多个实例。此外 minio还支持单主机，多块磁盘以及分布式部署，不过对于大部分单体应用来说，单体已经够用了。
上传文件
@RestController
public class MinioController {
@Autowired
private MinioUtil minioUtil;
@PostMapping("/upload")
public String MinIOUpload(MultipartFile file) {
if (file.isEmpty() || file.getSize() == 0) {
return "文件为空";
}
try {
if (!minioUtil.bucketExists("javakf")) {
minioUtil.makeBucket("javakf");
}
String fileName = file.getOriginalFilename();
String newName = "image/" + UUID.randomUUID().toString().replaceAll("-", "")
+ fileName.substring(fileName.lastIndexOf("."));
InputStream inputStream = file.getInputStream();
minioUtil.putObject("javakf", newName, inputStream);
inputStream.close();
String url = minioUtil.getObjectUrl("javakf", newName);
return url;
} catch (Exception e) {
e.printStackTrace();
return "上传失败";
}
}
}
postman测试
访问配置
MinIO形式上传的文件也不能直接访问，需要设置bucket的policy策略
3.0.10版本： minioClient.setBucketPolicy("javakf", "image", PolicyType.READ_ONLY);
| 参数 | 类型 | 描述 |
|---|---|---|
| bucketName | String | 存储桶名称 |
| objectPrefix | String | 对象前缀 |
| policy | PolicyType | 要赋予的策略，可选值有[PolicyType.NONE, PolicyType.READ_ONLY, PolicyType.READ_WRITE, PolicyType.WRITE_ONLY] |
代码托管：springboot_minio