Spring File Storage的详细文档

本是古典何须时尚 2023-10-08 18:52 15阅读 0赞

## [**快速入门**][Link 1] ##

1.  ### [**配置**][Link 2] ###

pom.xml引入依赖

<dependencies>
 
 <dependency>
 <groupId>cn.xuyanwu</groupId>
 <artifactId>spring-file-storage</artifactId>
 <version>0.7.0</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.huaweicloud</groupId>
 <artifactId>esdk-obs-java</artifactId>
 <version>3.22.3.1</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.aliyun.oss</groupId>
 <artifactId>aliyun-sdk-oss</artifactId>
 <version>3.15.1</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.qiniu</groupId>
 <artifactId>qiniu-java-sdk</artifactId>
 <version>7.11.0</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.qcloud</groupId>
 <artifactId>cos_api</artifactId>
 <version>5.6.98</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.baidubce</groupId>
 <artifactId>bce-java-sdk</artifactId>
 <version>0.10.218</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.upyun</groupId>
 <artifactId>java-sdk</artifactId>
 <version>4.2.3</version>
 </dependency>
 
 
 <dependency>
 <groupId>io.minio</groupId>
 <artifactId>minio</artifactId>
 <version>8.4.3</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.amazonaws</groupId>
 <artifactId>aws-java-sdk-s3</artifactId>
 <version>1.12.272</version>
 </dependency>
 
 
 <dependency>
 <groupId>commons-net</groupId>
 <artifactId>commons-net</artifactId>
 <version>3.8.0</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.jcraft</groupId>
 <artifactId>jsch</artifactId>
 <version>0.1.55</version>
 </dependency>
 
 
 <dependency>
 <groupId>cn.hutool</groupId>
 <artifactId>hutool-extra</artifactId>
 <version>5.8.5</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.github.lookfirst</groupId>
 <artifactId>sardine</artifactId>
 <version>5.10</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.google.cloud</groupId>
 <artifactId>google-cloud-storage</artifactId>
 <version>2.14.0</version>
 </dependency>
 
 
 <dependency>
 <groupId>com.google.guava</groupId>
 <artifactId>guava</artifactId>
 <version>31.1-jre</version>
 </dependency>
 
 </dependencies>

application.yml配置文件中添加以下相关配置（不使用的平台可以不配置）

spring:
      file-storage: #文件存储配置
        default-platform: local-1 #默认使用的存储平台
        thumbnail-suffix: ".min.jpg" #缩略图后缀，例如【.min.jpg】【.png】
        local: # 本地存储（不推荐使用），不使用的情况下可以不写
          - platform: local-1 # 存储平台标识
            enable-storage: true  #启用存储
            enable-access: true #启用访问（线上请使用 Nginx 配置，效率更高）
            domain: "" # 访问域名，例如：“http://127.0.0.1:8030/test/file/”，注意后面要和 path-patterns 保持一致，“/”结尾，本地存储建议使用相对路径，方便后期更换域名
            base-path: D:/Temp/test/ # 存储地址
            path-patterns: /test/file/** # 访问路径，开启 enable-access 后，通过此路径可以访问到上传的文件
        local-plus: # 本地存储升级版，不使用的情况下可以不写
          - platform: local-plus-1 # 存储平台标识
            enable-storage: true  #启用存储
            enable-access: true #启用访问（线上请使用 Nginx 配置，效率更高）
            domain: "" # 访问域名，例如：“http://127.0.0.1:8030/”，注意后面要和 path-patterns 保持一致，“/”结尾，本地存储建议使用相对路径，方便后期更换域名
            base-path: local-plus/ # 基础路径
            path-patterns: /** # 访问路径
            storage-path: D:/Temp/ # 存储路径
        huawei-obs: # 华为云 OBS ，不使用的情况下可以不写
          - platform: huawei-obs-1 # 存储平台标识
            enable-storage: false  # 启用存储
            access-key: ??
            secret-key: ??
            end-point: ??
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：http://abc.obs.com/
            base-path: hy/ # 基础路径
        aliyun-oss: # 阿里云 OSS ，不使用的情况下可以不写
          - platform: aliyun-oss-1 # 存储平台标识
            enable-storage: false  # 启用存储
            access-key: ??
            secret-key: ??
            end-point: ??
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：https://abc.oss-cn-shanghai.aliyuncs.com/
            base-path: hy/ # 基础路径
        qiniu-kodo: # 七牛云 kodo ，不使用的情况下可以不写
          - platform: qiniu-kodo-1 # 存储平台标识
            enable-storage: false  # 启用存储
            access-key: ??
            secret-key: ??
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：http://abc.hn-bkt.clouddn.com/
            base-path: base/ # 基础路径
        tencent-cos: # 腾讯云 COS
          - platform: tencent-cos-1 # 存储平台标识
            enable-storage: true  # 启用存储
            secret-id: ??
            secret-key: ??
            region: ?? #存仓库所在地域
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：https://abc.cos.ap-nanjing.myqcloud.com/
            base-path: hy/ # 基础路径
        baidu-bos: # 百度云 BOS
          - platform: baidu-bos-1 # 存储平台标识
            enable-storage: true  # 启用存储
            access-key: ??
            secret-key: ??
            end-point: ?? # 例如 abc.fsh.bcebos.com
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：https://abc.fsh.bcebos.com/abc/
            base-path: hy/ # 基础路径
        upyun-uss: # 又拍云 USS
          - platform: upyun-uss-1 # 存储平台标识
            enable-storage: true  # 启用存储
            username: ??
            password: ??
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：http://abc.test.upcdn.net/
            base-path: hy/ # 基础路径
        minio: # MinIO，由于 MinIO SDK 支持 AWS S3，其它兼容 AWS S3 协议的存储平台也都可配置在这里
          - platform: minio-1 # 存储平台标识
            enable-storage: true  # 启用存储
            access-key: ??
            secret-key: ??
            end-point: ??
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：http://minio.abc.com/abc/
            base-path: hy/ # 基础路径
        aws-s3: # AWS S3，其它兼容 AWS S3 协议的存储平台也都可配置在这里
          - platform: aws-s3-1 # 存储平台标识
            enable-storage: true  # 启用存储
            access-key: ??
            secret-key: ??
            region: ?? # 与 end-point 参数至少填一个
            end-point: ?? # 与 region 参数至少填一个
            bucket-name: ??
            domain: ?? # 访问域名，注意“/”结尾，例如：https://abc.hn-bkt.clouddn.com/
            base-path: s3/ # 基础路径
        ftp: # FTP
          - platform: ftp-1 # 存储平台标识
            enable-storage: true  # 启用存储
            host: ?? # 主机，例如：192.168.1.105
            port: 21 # 端口，默认21
            user: anonymous # 用户名，默认 anonymous（匿名）
            password: "" # 密码，默认空
            domain: ?? # 访问域名，注意“/”结尾，例如：ftp://192.168.1.105/
            base-path: ftp/ # 基础路径
            storage-path: /www/wwwroot/file.abc.com/ # 存储路径，可以配合 Nginx 实现访问，注意“/”结尾，默认“/”
        sftp: # SFTP
          - platform: sftp-1 # 存储平台标识
            enable-storage: true  # 启用存储
            host: ?? # 主机，例如：192.168.1.105
            port: 22 # 端口，默认22
            user: root # 用户名
            password: ?? # 密码或私钥密码
            private-key-path: ?? # 私钥路径，兼容Spring的ClassPath路径、文件路径、HTTP路径等，例如：classpath:id_rsa_2048
            domain: ?? # 访问域名，注意“/”结尾，例如：https://file.abc.com/
            base-path: sftp/ # 基础路径
            storage-path: /www/wwwroot/file.abc.com/ # 存储路径，可以配合 Nginx 实现访问，注意“/”结尾，默认“/”
        webdav: # WebDAV
          - platform: webdav-1 # 存储平台标识
            enable-storage: true  # 启用存储
            server: ?? # 服务器地址，例如：http://192.168.1.105:8405/
            user: ?? # 用户名
            password: ?? # 密码
            domain: ?? # 访问域名，注意“/”结尾，例如：https://file.abc.com/
            base-path: webdav/ # 基础路径
            storage-path: / # 存储路径，可以配合 Nginx 实现访问，注意“/”结尾，默认“/”
        google-cloud: # 谷歌云存储
          - platform: google-1 # 存储平台标识
            enable-storage: true  # 启用存储
            project-id: ?? # 项目 id
            bucket-name: ??
            credentials-path: file:/deploy/example-key.json # 授权 key json 路径，兼容Spring的ClassPath路径、文件路径、HTTP路径等
            domain: ?? # 访问域名，注意“/”结尾，例如：https://storage.googleapis.com/test-bucket/
            base-path: hy/ # 基础路径

注意配置每个平台前面都有个-号，通过以下方式可以配置多个

local:
      - platform: local-1 # 存储平台标识
        enable-storage: true
        enable-access: true
        domain: ""
        base-path: D:/Temp/test/
        path-patterns: /test/file/**
      - platform: local-2 # 存储平台标识，注意这里不能重复
        enable-storage: true
        enable-access: true
        domain: ""
        base-path: D:/Temp/test2/
        path-patterns: /test2/file/**

### **2、**[**编码**][Link 3] ###

在启动类上加上@EnableFileStorage注解

@EnableFileStorage
    @SpringBootApplication
    public class SpringFileStorageTestApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SpringFileStorageTestApplication.class, args);
        }
        
    }

### **3、**[**开始使用**][Link 4] ###

@RestController
    public class FileDetailController {
    
        @Autowired
        private FileStorageService fileStorageService;//注入实列
    
        /**
         * 上传文件，成功返回文件 url
         */
        @PostMapping("/upload")
        public String upload(MultipartFile file) {
            FileInfo fileInfo = fileStorageService.of(file)
                    .setPath("upload/") //保存到相对路径下，为了方便管理，不需要可以不写
                    .setObjectId("0")   //关联对象id，为了方便管理，不需要可以不写
                    .setObjectType("0") //关联对象类型，为了方便管理，不需要可以不写
                    .putAttr("role","admin") //保存一些属性，可以在切面、保存上传记录、自定义存储平台等地方获取使用，不需要可以不写
                    .upload();  //将文件上传到对应地方
            return fileInfo == null ? "上传失败！" : fileInfo.getUrl();
        }
    
        /**
         * 上传图片，成功返回文件信息
         * 图片处理使用的是 https://github.com/coobird/thumbnailator
         */
        @PostMapping("/upload-image")
        public FileInfo uploadImage(MultipartFile file) {
            return fileStorageService.of(file)
                    .image(img -> img.size(1000,1000))  //将图片大小调整到 1000*1000
                    .thumbnail(th -> th.size(200,200))  //再生成一张 200*200 的缩略图
                    .upload();
        }
    
        /**
         * 上传文件到指定存储平台，成功返回文件信息
         */
        @PostMapping("/upload-platform")
        public FileInfo uploadPlatform(MultipartFile file) {
            return fileStorageService.of(file)
                    .setPlatform("aliyun-oss-1")    //使用指定的存储平台
                    .upload();
        }
    }

**如果想使用删除、下载等功能，请阅读** [**保存上传记录**][Link 5] **章节**

## [**基础功能**][Link 6] ##

### [**上传**][Link 7] ###

#### [**多种上传方式**][Link 8] ####

of方法有很多个重载方法，支持 File、MultipartFile、byte\[\]、InputStream、URL、URI、String

// 直接上传
    fileStorageService.of(file).upload();
    
    // 如果要用 InputStream、URL、URI、String 等方式上传，暂时无法获取 originalFilename 属性，最好手动设置
    fileStorageService.of(inputStream).setOriginalFilename("a.jpg").upload();
    
    // 上传到指定路径下
    fileStorageService.of(file)
            .setPath("upload/") // 保存到相对路径下，为了方便管理，不需要可以不写
            .upload();
    
    // 关联文件参数并上传
    fileStorageService.of(file)
            .setObjectId("0")   // 关联对象id，为了方便管理，不需要可以不写
            .setObjectType("0") // 关联对象类型，为了方便管理，不需要可以不写
            .putAttr("role","admin") //保存一些属性，可以在切面、保存上传记录、自定义存储平台等地方获取使用，不需要可以不写
            .putAttr("username","007")
            .upload();
    
    // 上传到指定的存储平台
    fileStorageService.of(file)
            .setPlatform("aliyun-oss-1")    // 使用指定的存储平台
            .upload();
    
    // 对图片进行处理并上传，有多个重载方法。图片处理使用的是 https://github.com/coobird/thumbnailator
    fileStorageService.of(file)
            .setThumbnailSuffix(".jpg") //指定缩略图后缀，必须是 thumbnailator 支持的图片格式，默认使用全局的
            .setSaveThFilename("thabc") //指定缩略图的保存文件名，注意此文件名不含后缀，默认自动生成
            .image(img -> img.size(1000,1000))  // 将图片大小调整到 1000*1000
            .thumbnail(th -> th.size(200,200))  // 再生成一张 200*200 的缩略图
            .upload();
    
    // 其它更多方法以实际 API 为准

### [**保存上传记录**][Link 5] ###

如果还想使用除了保存文件之外的其它功能，例如删除、下载文件，还需要实现 FileRecorder 这个接口，把文件信息保存到数据库中。

/**
 * 用来将文件上传记录保存到数据库，这里使用了 MyBatis-Plus 和 Hutool 工具类
 */
 @Service
 public class FileDetailService extends ServiceImpl<FileDetailMapper, FileDetail> implements FileRecorder {
 
 /**
 * 保存文件信息到数据库
 */
 @SneakyThrows
 @Override
 public boolean record(FileInfo info) {
 FileDetail detail = BeanUtil.copyProperties(info,FileDetail.class,"attr");
 
 //这是手动获 取附加属性字典 并转成 json 字符串，方便存储在数据库中
 if (info.getAttr() != null) {
 detail.setAttr(new ObjectMapper().writeValueAsString(info.getAttr()));
 }
 boolean b = save(detail);
 if (b) {
 info.setId(detail.getId());
 }
 return b;
 }
 
 /**
 * 根据 url 查询文件信息
 */
 @SneakyThrows
 @Override
 public FileInfo getByUrl(String url) {
 FileDetail detail = getOne(new QueryWrapper<FileDetail>().eq(FileDetail.COL_URL,url));
 FileInfo info = BeanUtil.copyProperties(detail,FileInfo.class,"attr");
 
 //这是手动获取数据库中的 json 字符串 并转成 附加属性字典，方便使用
 if (StrUtil.isNotBlank(detail.getAttr())) {
 info.setAttr(new ObjectMapper().readValue(detail.getAttr(),Dict.class));
 }
 return info;
 }
 
 /**
 * 根据 url 删除文件信息
 */
 @Override
 public boolean delete(String url) {
 return remove(new QueryWrapper<FileDetail>().eq(FileDetail.COL_URL,url));
 }
 }

数据库表结构推荐如下，你也可以根据自己喜好在这里自己扩展

-- 这里使用的是 mysql
    CREATE TABLE `file_detail`
    (
        `id`                varchar(32)  NOT NULL COMMENT '文件id',
        `url`               varchar(512) NOT NULL COMMENT '文件访问地址',
        `size`              bigint(20)   DEFAULT NULL COMMENT '文件大小，单位字节',
        `filename`          varchar(256) DEFAULT NULL COMMENT '文件名称',
        `original_filename` varchar(256) DEFAULT NULL COMMENT '原始文件名',
        `base_path`         varchar(256) DEFAULT NULL COMMENT '基础存储路径',
        `path`              varchar(256) DEFAULT NULL COMMENT '存储路径',
        `ext`               varchar(32)  DEFAULT NULL COMMENT '文件扩展名',
        `content_type`      varchar(32)  DEFAULT NULL COMMENT 'MIME类型',
        `platform`          varchar(32)  DEFAULT NULL COMMENT '存储平台',
        `th_url`            varchar(512) DEFAULT NULL COMMENT '缩略图访问路径',
        `th_filename`       varchar(256) DEFAULT NULL COMMENT '缩略图名称',
        `th_size`           bigint(20)   DEFAULT NULL COMMENT '缩略图大小，单位字节',
        `th_content_type`   varchar(32)  DEFAULT NULL COMMENT '缩略图MIME类型',
        `object_id`         varchar(32)  DEFAULT NULL COMMENT '文件所属对象id',
        `object_type`       varchar(32)  DEFAULT NULL COMMENT '文件所属对象类型，例如用户头像，评价图片',
        `attr`              text COMMENT '附加属性',
        `create_time`       datetime     DEFAULT NULL COMMENT '创建时间',
        PRIMARY KEY (`id`) USING BTREE
    ) ENGINE = InnoDB
      DEFAULT CHARSET = utf8
      ROW_FORMAT = DYNAMIC COMMENT ='文件记录表';

### [**下载**][Link 9] ###

#### [**多种下载方式**][Link 10] ####

// 获取文件信息
    FileInfo fileInfo = fileStorageService.getFileInfoByUrl("http://file.abc.com/test/a.jpg");
    
    // 下载为字节数组
    byte[] bytes = fileStorageService.download(fileInfo).bytes();
    
    // 下载到文件
    fileStorageService.download(fileInfo).file("C:\\a.jpg");
    
    // 下载到 OutputStream 中
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    fileStorageService.download(fileInfo).outputStream(out);
    
    // 获取 InputStream 手动处理
    fileStorageService.download(fileInfo).inputStream(in -> {
        //TODO 读取 InputStream
    });
    
    // 直接通过文件信息中的 url 下载，省去手动查询文件信息记录的过程
    fileStorageService.download("http://file.abc.com/test/a.jpg").file("C:\\a.jpg");
    
    // 下载缩略图
    fileStorageService.downloadTh(fileInfo).file("C:\\th.jpg");

#### [**监听下载进度**][Link 11] ####

// 方式一
    fileStorageService.download(fileInfo).setProgressMonitor(progressSize ->
            System.out.println("已下载：" + progressSize)
    ).file("C:\\a.jpg");
            
    // 方式二
    fileStorageService.download(fileInfo).setProgressMonitor((progressSize,allSize) ->
            System.out.println("已下载 " + progressSize + " 总大小" + allSize)
    ).file("C:\\a.jpg");
    
    // 方式三
    fileStorageService.download(fileInfo).setProgressMonitor(new ProgressListener() {
        @Override
        public void start() {
            System.out.println("下载开始");
        }
    
        @Override
        public void progress(long progressSize,long allSize) {
            System.out.println("已下载 " + progressSize + " 总大小" + allSize);
        }
    
        @Override
        public void finish() {
            System.out.println("下载结束");
        }
    }).file("C:\\a.jpg");

### [**删除**][Link 12] ###

//获取文件信息
    FileInfo fileInfo = fileStorageService.getFileInfoByUrl("http://file.abc.com/test/a.jpg");
    
    //直接删除
    fileStorageService.delete(fileInfo);
    
    //条件删除
    fileStorageService.delete(fileInfo,info -> {
        //TODO 检查是否满足删除条件
        return true;
    });
    
    //直接通过文件信息中的 url 删除，省去手动查询文件信息记录的过程
    fileStorageService.delete("http://file.abc.com/test/a.jpg");

### [**判断文件是否存在**][Link 13] ###

//获取文件信息
    FileInfo fileInfo = fileStorageService.getFileInfoByUrl("http://file.abc.com/test/a.jpg");
    
    //判断文件是否存在
    boolean exists = fileStorageService.exists(fileInfo);
    
    //直接通过文件信息中的 url 判断文件是否存在，省去手动查询文件信息记录的过程
    boolean exists2 = fileStorageService.exists("http://file.abc.com/test/a.jpg");

## [**存储平台**][Link 14] ##

目前支持多种存储平台，你也可以根据需要自行扩展

### [**支持的存储平台**][Link 15] ###

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:369px;vertical-align:top;height:52px;">平台</td> 
 <td style="width:369px;vertical-align:top;height:52px;">支持</td> 
 </tr> 
 <tr> 
 <td style="width:369px;vertical-align:top;height:52px;">本地</td> 
 <td style="width:369px;vertical-align:top;height:52px;">√</td> 
 </tr> 
 <tr> 
 <td style="width:369px;vertical-align:top;height:52px;">FTP</td> 
 <td style="width:369px;vertical-align:top;height:52px;">√</td> 
 </tr> 
 <tr> 
 <td style="width:369px;vertical-align:top;height:52px;">SFTP</td> 
 <td style="width:369px;vertical-align:top;height:52px;">√</td> 
 </tr> 
 <tr> 
 <td style="width:369px;vertical-align:top;height:52px;">WebDAV</td> 
 <td style="width:369px;vertical-align:top;height:52px;">√</td> 
 </tr> 
 </tbody> 
</table>

<table style=""> 
 <tbody> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">平台</td> 
 <td style="width:184px;vertical-align:top;height:52px;">官方 SDK</td> 
 <td style="width:184px;vertical-align:top;height:52px;">AWS S3 SDK</td> 
 <td style="width:184px;vertical-align:top;height:52px;">S3 兼容说明</td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">AWS S3</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">-</td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">MinIO</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="http://docs.minio.org.cn/docs/master/java-client-quickstart-guide" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">阿里云 OSS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://help.aliyun.com/document_detail/64919.html#title-cds-fai-yxp" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">华为云 OBS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://support.huaweicloud.com/topic/74416-1-O-obsduixiangcunchufuwus3xieyi" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">七牛云 Kodo</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://developer.qiniu.com/kodo/4086/aws-s3-compatible" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">腾讯云 COS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://cloud.tencent.com/document/product/436/37421" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">百度云 BOS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://cloud.baidu.com/doc/BOS/s/Fjwvyq9xo" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">又拍云 USS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">-</td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">金山云 KS3</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://docs.ksyun.com/documents/959" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">美团云 MSS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://www.mtyun.com/doc/products/storage/mss/zhu-yao-gong-neng#%E5%85%BC%E5%AE%B9%20AWS%20S3%20%E5%8D%8F%E8%AE%AE" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">京东云 OSS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://docs.jdcloud.com/cn/object-storage-service/compatibility-api-overview" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">天翼云 OOS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://www.ctyun.cn/h5/help2/10000101/10001711" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">移动云 EOS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://ecloud.10086.cn/op-help-center/doc/article/24569" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">沃云 OSS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://support.woyun.cn/document.html?id=133&amp;arcid=127" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">网易数帆 NOS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://www.163yun.com/help/documents/89796157866430464" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">Ucloud US3</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://docs.ucloud.cn/ufile/s3/s3_introduction" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">青云 QingStor</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://docs.qingcloud.com/qingstor/s3/" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">平安云 OBS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://yun.pingan.com/ssr/help/storage/obs/OBS_SDK_.Java_SDK_" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">首云 OSS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="http://www.capitalonline.net.cn/zh-cn/service/distribution/oss-new/#product-adv" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">IBM COS</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;"><a style="color:#0A6CFF;" href="https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-compatibility-api" rel="nofollow">查看</a></td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">谷歌云存储</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">-</td> 
 </tr> 
 <tr> 
 <td style="width:184px;vertical-align:top;height:52px;">其它兼容 S3 协议的平台</td> 
 <td style="width:184px;vertical-align:top;height:52px;">×</td> 
 <td style="width:184px;vertical-align:top;height:52px;">√</td> 
 <td style="width:184px;vertical-align:top;height:52px;">-</td> 
 </tr> 
 </tbody> 
</table>

### [**自定义存储平台**][Link 16] ###

想要自定义存储平台就要实现 FileStorage 这个接口，并进行实例化，注意返回的 bean 是个 list

这里拿 LocalFileStorage 举例

/**
 * 实现 FileStorage 接口，这里使用了 Lombok 和 Hutool 工具类
 */
 @Getter
 @Setter
 public class LocalFileStorage implements FileStorage {
 
 /* 本地存储路径*/
 private String basePath;
 /* 存储平台 */
 private String platform;
 /* 访问域名 */
 private String domain;
 
 /**
 * 释放资源
 */
 @Override
 public void close() {
 }
 
 /**
 * 保存文件
 */
 @Override
 public boolean save(FileInfo fileInfo,UploadPretreatment pre) {
 String path = fileInfo.getPath();
 
 File newFile = FileUtil.touch(basePath + path,fileInfo.getFilename());
 fileInfo.setBasePath(basePath);
 fileInfo.setUrl(domain + path + fileInfo.getFilename());
 
 try {
 pre.getFileWrapper().transferTo(newFile);
 
 byte[] thumbnailBytes = pre.getThumbnailBytes();
 if (thumbnailBytes != null) { //上传缩略图
 fileInfo.setThUrl(fileInfo.getUrl() + pre.getThumbnailSuffix());
 FileUtil.writeBytes(thumbnailBytes,newFile.getPath() + pre.getThumbnailSuffix());
 }
 return true;
 } catch (IOException e) {
 FileUtil.del(newFile);
 throw new FileStorageRuntimeException("文件上传失败！platform：" + platform + "，filename：" + fileInfo.getOriginalFilename(),e);
 }
 }
 
 /**
 * 删除文件
 */
 @Override
 public boolean delete(FileInfo fileInfo) {
 if (fileInfo.getThFilename() != null) { //删除缩略图
 FileUtil.del(new File(fileInfo.getBasePath() + fileInfo.getPath(),fileInfo.getThFilename()));
 }
 return FileUtil.del(new File(fileInfo.getBasePath() + fileInfo.getPath(),fileInfo.getFilename()));
 }
 
 /**
 * 文件是否存在
 */
 @Override
 public boolean exists(FileInfo fileInfo) {
 return new File(fileInfo.getBasePath() + fileInfo.getPath(),fileInfo.getFilename()).exists();
 }
 
 /**
 * 下载文件
 */
 @Override
 public void download(FileInfo fileInfo,Consumer<InputStream> consumer) {
 try (InputStream in = FileUtil.getInputStream(fileInfo.getBasePath() + fileInfo.getPath() + fileInfo.getFilename())) {
 consumer.accept(in);
 } catch (IOException e) {
 throw new FileStorageRuntimeException("文件下载失败！platform：" + fileInfo,e);
 }
 }
 
 /**
 * 下载缩略图文件
 */
 @Override
 public void downloadTh(FileInfo fileInfo,Consumer<InputStream> consumer) {
 if (StrUtil.isBlank(fileInfo.getThFilename())) {
 throw new FileStorageRuntimeException("缩略图文件下载失败，文件不存在！fileInfo：" + fileInfo);
 }
 try (InputStream in = FileUtil.getInputStream(fileInfo.getBasePath() + fileInfo.getPath() + fileInfo.getThFilename())) {
 consumer.accept(in);
 } catch (IOException e) {
 throw new FileStorageRuntimeException("缩略图文件下载失败！fileInfo：" + fileInfo,e);
 }
 }
 }
 
 /**
 * 初始化
 */
 @Configuration
 public class LocalFileStorageAutoConfiguration {
 
 /**
 * 这里拿本地存储做个演示，注意返回的是个List
 */
 @Bean
 public List<LocalFileStorage> localFileStorageList() {
 ArrayList<LocalFileStorage> list = new ArrayList<>();
 LocalFileStorage localFileStorage = new LocalFileStorage();
 localFileStorage.setPlatform("my-local-1");//平台名称
 localFileStorage.setBasePath("");
 localFileStorage.setDomain("");
 list.add(localFileStorage);
 return list;
 }
 }

### [**动态增减存储平台**][Link 17] ###

//获得存储平台 List
 CopyOnWriteArrayList<FileStorage> list = fileStorageService.getFileStorageList();
 
 //增加
 LocalFileStorage storage = new LocalFileStorage();
 storage.setPlatform("my-local-1");//平台名称
 storage.setBasePath("");
 storage.setDomain("");
 list.add(storage);
 
 //删除
 FileStorage myLocal = fileStorageService.getFileStorage("my-local-1");
 list.remove(myLocal);
 myLocal.close();//释放资源

### [**获取对应存储平台**][Link 18] ###

AliyunOssFileStorage storage = (AliyunOssFileStorage) fileStorageService.getFileStorage("aliyun-oss-1");
    OSS client = storage.getClient();
    //获取到对应SDK的原生客户端对象，可以进行更多高级操作

## [**切面**][Link 19] ##

通过切面，可以对文件的上传和删除等进行干预

### [**自定义切面**][Link 20] ###

只需要实现FileStorageAspect接口

不需要的方法可以不用实现，此接口里的方法全部都有默认实现

/**
 * 使用切面打印文件上传和删除的日志
 */
 @Slf4j
 @Component
 public class LogFileStorageAspect implements FileStorageAspect {
 
 /**
 * 上传，成功返回文件信息，失败返回 null
 */
 @Override
 public FileInfo uploadAround(UploadAspectChain chain,FileInfo fileInfo,UploadPretreatment pre,FileStorage fileStorage,FileRecorder fileRecorder) {
 log.info("上传文件 before -> {}",fileInfo);
 fileInfo = chain.next(fileInfo,pre,fileStorage,fileRecorder);
 log.info("上传文件 after -> {}",fileInfo);
 return fileInfo;
 }
 
 /**
 * 删除文件，成功返回 true
 */
 @Override
 public boolean deleteAround(DeleteAspectChain chain,FileInfo fileInfo,FileStorage fileStorage,FileRecorder fileRecorder) {
 log.info("删除文件 before -> {}",fileInfo);
 boolean res = chain.next(fileInfo,fileStorage,fileRecorder);
 log.info("删除文件 after -> {}",res);
 return res;
 }
 
 /**
 * 文件是否存在
 */
 @Override
 public boolean existsAround(ExistsAspectChain chain,FileInfo fileInfo,FileStorage fileStorage) {
 log.info("文件是否存在 before -> {}",fileInfo);
 boolean res = chain.next(fileInfo,fileStorage);
 log.info("文件是否存在 after -> {}",res);
 return res;
 }
 
 /**
 * 下载文件
 */
 @Override
 public void downloadAround(DownloadAspectChain chain,FileInfo fileInfo,FileStorage fileStorage,Consumer<InputStream> consumer) {
 log.info("下载文件 before -> {}",fileInfo);
 chain.next(fileInfo,fileStorage,consumer);
 log.info("下载文件 after -> {}",fileInfo);
 }
 
 /**
 * 下载缩略图文件
 */
 @Override
 public void downloadThAround(DownloadThAspectChain chain,FileInfo fileInfo,FileStorage fileStorage,Consumer<InputStream> consumer) {
 log.info("下载缩略图文件 before -> {}",fileInfo);
 chain.next(fileInfo,fileStorage,consumer);
 log.info("下载缩略图文件 after -> {}",fileInfo);
 }
 }

### [**动态增减切面**][Link 21] ###

//获得切面 List
 CopyOnWriteArrayList<FileStorageAspect> list = fileStorageService.getAspectList();
 
 //增加
 FileStorageAspect aspect = new LogFileStorageAspect();
 list.add(aspect);
 
 //删除
 list.remove(aspect);
 
 //条件删除
 list.removeIf(item -> item instanceof LogFileStorageAspect);

## [**常见问题**][Link 22] ##

#### [**为什么我在application.yml 中已经添加对应的存储平台配置，上传时却提示我“没有找到对应的存储平台！”**][application.yml] ####

检查pom.xml，是否引入对应平台的依赖，例如阿里云

<dependency>
 <groupId>com.aliyun.oss</groupId>
 <artifactId>aliyun-sdk-oss</artifactId>
 <version>3.6.0</version>
 </dependency>

#### [**如何根据数据库配置加载存储平台？**][Link 23] ####

参考 [**动态增减存储平台**][Link 17]

#### [**如何自定义缩略图后缀？**][Link 24] ####

参考 [**多种上传方式**][Link 8] 中的缩略图上传方式，可以自己调整缩略图后缀

[Link 1]: https://spring-file-storage.xuyanwu.cn/#/%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8?id=%e5%bf%ab%e9%80%9f%e5%85%a5%e9%97%a8
[Link 2]: https://spring-file-storage.xuyanwu.cn/#/%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8?id=%e9%85%8d%e7%bd%ae
[Link 3]: https://spring-file-storage.xuyanwu.cn/#/%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8?id=%e7%bc%96%e7%a0%81
[Link 4]: https://spring-file-storage.xuyanwu.cn/#/%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8?id=%e5%bc%80%e5%a7%8b%e4%bd%bf%e7%94%a8
[Link 5]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e4%bf%9d%e5%ad%98%e4%b8%8a%e4%bc%a0%e8%ae%b0%e5%bd%95
[Link 6]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e5%9f%ba%e7%a1%80%e5%8a%9f%e8%83%bd
[Link 7]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e4%b8%8a%e4%bc%a0
[Link 8]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e5%a4%9a%e7%a7%8d%e4%b8%8a%e4%bc%a0%e6%96%b9%e5%bc%8f
[Link 9]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e4%b8%8b%e8%bd%bd
[Link 10]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e5%a4%9a%e7%a7%8d%e4%b8%8b%e8%bd%bd%e6%96%b9%e5%bc%8f
[Link 11]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e7%9b%91%e5%90%ac%e4%b8%8b%e8%bd%bd%e8%bf%9b%e5%ba%a6
[Link 12]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e5%88%a0%e9%99%a4
[Link 13]: https://spring-file-storage.xuyanwu.cn/#/%E5%9F%BA%E7%A1%80%E5%8A%9F%E8%83%BD?id=%e5%88%a4%e6%96%ad%e6%96%87%e4%bb%b6%e6%98%af%e5%90%a6%e5%ad%98%e5%9c%a8
[Link 14]: https://spring-file-storage.xuyanwu.cn/#/%E5%AD%98%E5%82%A8%E5%B9%B3%E5%8F%B0?id=%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0
[Link 15]: https://spring-file-storage.xuyanwu.cn/#/%E5%AD%98%E5%82%A8%E5%B9%B3%E5%8F%B0?id=%e6%94%af%e6%8c%81%e7%9a%84%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0
[Link 16]: https://spring-file-storage.xuyanwu.cn/#/%E5%AD%98%E5%82%A8%E5%B9%B3%E5%8F%B0?id=%e8%87%aa%e5%ae%9a%e4%b9%89%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0
[Link 17]: https://spring-file-storage.xuyanwu.cn/#/%E5%AD%98%E5%82%A8%E5%B9%B3%E5%8F%B0?id=%e5%8a%a8%e6%80%81%e5%a2%9e%e5%87%8f%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0
[Link 18]: https://spring-file-storage.xuyanwu.cn/#/%E5%AD%98%E5%82%A8%E5%B9%B3%E5%8F%B0?id=%e8%8e%b7%e5%8f%96%e5%af%b9%e5%ba%94%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0
[Link 19]: https://spring-file-storage.xuyanwu.cn/#/%E5%88%87%E9%9D%A2?id=%e5%88%87%e9%9d%a2
[Link 20]: https://spring-file-storage.xuyanwu.cn/#/%E5%88%87%E9%9D%A2?id=%e8%87%aa%e5%ae%9a%e4%b9%89%e5%88%87%e9%9d%a2
[Link 21]: https://spring-file-storage.xuyanwu.cn/#/%E5%88%87%E9%9D%A2?id=%e5%8a%a8%e6%80%81%e5%a2%9e%e5%87%8f%e5%88%87%e9%9d%a2
[Link 22]: https://spring-file-storage.xuyanwu.cn/#/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98?id=%e5%b8%b8%e8%a7%81%e9%97%ae%e9%a2%98
[application.yml]: https://spring-file-storage.xuyanwu.cn/#/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98?id=%e4%b8%ba%e4%bb%80%e4%b9%88%e6%88%91%e5%9c%a8applicationyml-%e4%b8%ad%e5%b7%b2%e7%bb%8f%e6%b7%bb%e5%8a%a0%e5%af%b9%e5%ba%94%e7%9a%84%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0%e9%85%8d%e7%bd%ae%ef%bc%8c%e4%b8%8a%e4%bc%a0%e6%97%b6%e5%8d%b4%e6%8f%90%e7%a4%ba%e6%88%91%e6%b2%a1%e6%9c%89%e6%89%be%e5%88%b0%e5%af%b9%e5%ba%94%e7%9a%84%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0%ef%bc%81
[Link 23]: https://spring-file-storage.xuyanwu.cn/#/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98?id=%e5%a6%82%e4%bd%95%e6%a0%b9%e6%8d%ae%e6%95%b0%e6%8d%ae%e5%ba%93%e9%85%8d%e7%bd%ae%e5%8a%a0%e8%bd%bd%e5%ad%98%e5%82%a8%e5%b9%b3%e5%8f%b0%ef%bc%9f
[Link 24]: https://spring-file-storage.xuyanwu.cn/#/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98?id=%e5%a6%82%e4%bd%95%e8%87%aa%e5%ae%9a%e4%b9%89%e7%bc%a9%e7%95%a5%e5%9b%be%e5%90%8e%e7%bc%80%ef%bc%9f