GaeaOSSTemplate (spring-boot-starter-gaea-oss 2.9.4.RELEASE API)

所有已知实现类:

AmazonS3Client, HuaweiOBSClient, MinioClient, NFSClient
```
public interface GaeaOSSTemplate
```
GaeaOSS标准调用接口

从以下版本开始:

2022/3/22 14:16

字段概要

字段
限定符和类型字段和说明

static org.slf4j.Logger logger

字段
限定符和类型	字段和说明
`static org.slf4j.Logger`	`logger`

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`default void`	`checkFileSuffixName(org.springframework.web.multipart.MultipartFile file)` 判断文件后缀名是否在白名单中，如果不在报异常，中止文件保存
`default void`	`close()`
`void`	`deleteFile(String fileObjectName)` 根据fileObjectName删除
`void`	`deleteFiles(List<String> fileObjectNames)`
`byte[]`	`downloadFile(String fileObjectName)` 根据fileObjectName下载文件流
`String`	`getFileTypeWhiteList()` 文件后缀白名单
`default String`	`getSuffixName(org.springframework.web.multipart.MultipartFile file)` 获取上传文件的文件后缀
`default void`	`init(OSSProperties config)`
`default boolean`	`isAllowedFileSuffixName(org.springframework.web.multipart.MultipartFile file)` 判断文件的后缀名是否在白名单中，存在返回true
`default List<String>`	`splitToList(String listStr)` 将字符串切割成list，支持\|或者,分割线
`default String`	`uploadFileByInputStream(org.springframework.web.multipart.MultipartFile file)` 输入参数为前端文件上传对象MultipartFile 返回的是新文件名，下载删除需要
`String`	`uploadFileByInputStream(org.springframework.web.multipart.MultipartFile file, String fileObjectName)` 输入参数为前端文件上传对象MultipartFile 返回的是objectName 作为下载文件的依据，客服端需要存储

- 字段详细资料
  - logger
```
static final org.slf4j.Logger logger
```
- 方法详细资料
  - init
```
default void init(OSSProperties config)
```
  - close
```
default void close()
```
  - getFileTypeWhiteList
```
String getFileTypeWhiteList()
```
    文件后缀白名单
    
    返回:
  - splitToList
```
default List<String> splitToList(String listStr)
```
    将字符串切割成list，支持|或者,分割线
    
    参数:
    
    listStr -
    
    返回:
  - getSuffixName
```
default String getSuffixName(org.springframework.web.multipart.MultipartFile file)
```
    获取上传文件的文件后缀
    
    参数:
    
    file -
    
    返回:
    
    .png
  - isAllowedFileSuffixName
```
default boolean isAllowedFileSuffixName(org.springframework.web.multipart.MultipartFile file)
```
    判断文件的后缀名是否在白名单中，存在返回true
    
    参数:
    
    file -
    
    返回:
  - checkFileSuffixName
```
default void checkFileSuffixName(org.springframework.web.multipart.MultipartFile file)
```
    判断文件后缀名是否在白名单中，如果不在报异常，中止文件保存
    
    参数:
    
    file -
  - uploadFileByInputStream
```
default String uploadFileByInputStream(org.springframework.web.multipart.MultipartFile file)
                                throws GaeaOSSException
```
    输入参数为前端文件上传对象MultipartFile 返回的是新文件名，下载删除需要
    
    参数:
    
    file -
    
    返回:
    
    文件名，1c6bf10daa0e43ac8da32c96fc30dae7.png
    
    抛出:
    
    GaeaOSSException
  - uploadFileByInputStream
```
String uploadFileByInputStream(org.springframework.web.multipart.MultipartFile file,
                               String fileObjectName)
                        throws GaeaOSSException
```
    输入参数为前端文件上传对象MultipartFile 返回的是objectName 作为下载文件的依据，客服端需要存储
    
    参数:
    
    file -
    
    fileObjectName - 上传原始文件名 OrderExcel20220322.xls
    
    返回:
    
    上传原始文件名 OrderExcel20220322.xls
    
    抛出:
    
    GaeaOSSException
  - downloadFile
```
byte[] downloadFile(String fileObjectName)
             throws GaeaOSSException
```
    根据fileObjectName下载文件流
    
    参数:
    
    fileObjectName - 402b6193-e70e-40a9-bf5b-73a78ea1e8ab.png
    
    返回:
    
    抛出:
    
    GaeaOSSException
  - deleteFile
```
void deleteFile(String fileObjectName)
```
    根据fileObjectName删除
    
    参数:
    
    fileObjectName - 402b6193-e70e-40a9-bf5b-73a78ea1e8ab.png
  - deleteFiles
```
void deleteFiles(List<String> fileObjectNames)
```

接口 GaeaOSSTemplate

字段概要

方法概要

字段详细资料

logger

方法详细资料

init

close

getFileTypeWhiteList

splitToList

getSuffixName

isAllowedFileSuffixName

checkFileSuffixName

uploadFileByInputStream

uploadFileByInputStream

downloadFile

deleteFile

deleteFiles