cn.stylefeng.roses.kernel.file.api

接口 FileOperatorApi

public interface FileOperatorApi

文件操纵者（内网操作）

如果存在未包含的操作，可以调用getClient()自行获取client进行操作

作者:

fengshuonan

方法概要

限定符和类型	方法和说明
void	copyFile(String originBucketName, String originFileKey, String newBucketName, String newFileKey) 拷贝文件
void	deleteFile(String bucketName, String key) 删除文件
void	destroyClient() 销毁操作的客户端
boolean	doesBucketExist(String bucketName) 查询存储桶是否存在 例如：传入参数exampleBucket-1250000000，返回true代表存在此桶BucketAuthEnum.java
Object	getClient() 获取操作的客户端 例如，获取阿里云的客户端com.aliyun.oss.OSS
String	getFileAuthUrl(String bucketName, String key, Long timeoutMillis) 获取文件的下载地址（带鉴权的），生成外网地址
byte[]	getFileBytes(String bucketName, String key) 获取某个bucket下的文件字节
FileLocationEnum	getFileLocationEnum() 获取当前api的文件存储类型
String	getFileUnAuthUrl(String bucketName, String key) 获取文件的下载地址（不带鉴权的），生成外网地址
void	initClient() 初始化操作的客户端
boolean	isExistingFile(String bucketName, String key) 判断是否存在文件
void	setBucketAcl(String bucketName, BucketAuthEnum bucketAuthEnum) 设置预定义策略 预定义策略如公有读、公有读写、私有读
void	setFileAcl(String bucketName, String key, BucketAuthEnum bucketAuthEnum) 文件访问权限管理
void	storageFile(String bucketName, String key, byte[] bytes) 存储文件
void	storageFile(String bucketName, String key, InputStream inputStream) 存储文件（存放到指定的bucket里边）

方法详细资料

initClient

void initClient()

初始化操作的客户端

destroyClient

void destroyClient()

销毁操作的客户端

getClient

Object getClient()

获取操作的客户端

例如，获取阿里云的客户端com.aliyun.oss.OSS

doesBucketExist

boolean doesBucketExist(String bucketName)

查询存储桶是否存在

例如：传入参数exampleBucket-1250000000，返回true代表存在此桶BucketAuthEnum.java

参数:

bucketName - 存储桶名称

返回:

boolean true-存在，false-不存在

setBucketAcl

void setBucketAcl(String bucketName,
                  BucketAuthEnum bucketAuthEnum)

设置预定义策略

预定义策略如公有读、公有读写、私有读

参数:

bucketName - 存储桶名称

bucketAuthEnum - 存储桶的权限

isExistingFile

boolean isExistingFile(String bucketName,
                       String key)

判断是否存在文件

参数:

bucketName - 桶名称

key - 唯一标示id，例如a.txt, doc/a.txt

返回:

true-存在文件，false-不存在文件

storageFile

void storageFile(String bucketName,
                 String key,
                 byte[] bytes)

存储文件

参数:

bucketName - 桶名称

key - 唯一标示id，例如a.txt, doc/a.txt

bytes - 文件字节数组

storageFile

void storageFile(String bucketName,
                 String key,
                 InputStream inputStream)

存储文件（存放到指定的bucket里边）

参数:

bucketName - 桶名称

key - 唯一标示id，例如a.txt, doc/a.txt

inputStream - 文件流

getFileBytes

byte[] getFileBytes(String bucketName,
                    String key)

获取某个bucket下的文件字节

参数:

bucketName - 桶名称

key - 唯一标示id，例如a.txt, doc/a.txt

返回:

byte[] 字节数组为文件的字节数组

setFileAcl

void setFileAcl(String bucketName,
                String key,
                BucketAuthEnum bucketAuthEnum)

文件访问权限管理

参数:

bucketName - 桶名称

key - 唯一标示id，例如a.txt, doc/a.txt

bucketAuthEnum - 文件权限

copyFile

void copyFile(String originBucketName,
              String originFileKey,
              String newBucketName,
              String newFileKey)

拷贝文件

参数:

originBucketName - 源文件桶

originFileKey - 源文件名称

newBucketName - 新文件桶

newFileKey - 新文件名称

getFileAuthUrl

String getFileAuthUrl(String bucketName,
                      String key,
                      Long timeoutMillis)

获取文件的下载地址（带鉴权的），生成外网地址

参数:

bucketName - 文件桶

key - 文件唯一标识

timeoutMillis - url失效时间，单位毫秒

返回:

外部系统可以直接访问的url

getFileUnAuthUrl

String getFileUnAuthUrl(String bucketName,
                        String key)

获取文件的下载地址（不带鉴权的），生成外网地址

参数:

bucketName - 文件桶

key - 文件唯一标识

返回:

外部系统可以直接访问的url

deleteFile

void deleteFile(String bucketName,
                String key)

删除文件

参数:

bucketName - 文件桶

key - 文件唯一标识

getFileLocationEnum

FileLocationEnum getFileLocationEnum()

获取当前api的文件存储类型