跳到主要内容

quan-file

配置文件服务组件相关的参数

提示

当前主要封装minio文件服务相关API。可扩展其它文件服务工具。

更多minio配置,请参考:minio java api 扩展。

使用方法

1、引入工具依赖包

提示

工具包目前只在quan-tools模块中,需要通过quan-tools引入。 后期视具体需求决定是否上传到 Maven 仓库。

dependencies {
api project(':quan-tools:quan-file')
}

2、yml配置:

示例配置仅供参考
quan:
minio:
host: http://localhost:9000
url: https://file.javaquan.cn
access-key: root
secret-key: administrator
default-bucket-name: public

配置参数说明

host

  • 类型:string

S3服务的URL

url

  • 类型:string

用于对外访问的文件地址。当文件上传时,返回可访问的文件服务url配置。

accessKey

  • 类型:string

key,S3服务中帐户的访问密钥(又称用户ID)

secretKey

  • 类型:string

密钥,S3服务中帐户的密钥(又称密码)

defaultBucketName

  • 类型:string
  • 默认: default

默认存储桶名称

工具类说明-MinioUtil

upload

文件上传。会上传到defaultBucketName配置的文件桶中。

请求参数:

参数类型是否必须说明
fileMultipartFile文件信息

返回参数:

参数类型说明
bucketString桶名称
nameString文件名称
hostString文件访问的服务器地址(可以与文件名称组成完整的文件访问链接)

download

文件下载。

请求参数:

参数类型是否必须说明
fileNameString文件名称
servletResponseHttpServletResponse用于输出文件相关信息,且修改响应状态码为:202

返回参数: 无

preview

获取文件预览地址。

请求参数:

参数类型是否必须说明
bucketNameString文件桶名称
fileNameString文件名称
durationint链接过期时间(单位:秒)

返回参数: 文件预览地址

remove

删除文件。

请求参数:

参数类型是否必须说明
bucketNameString文件桶名称
fileNameString文件名称

返回参数: 无