X Spring File Storage v2.3.0 已经发布，Spring 文件存储库

此版本更新内容包括：

原名 X Spring File Storage 现已捐赠至 dromara 开源组织

x-file-storage.dromara.org | x-file-storage.xuyanwu.cn | spring-file-storage.xuyanwu.cn

简介

一行代码将文件存储到本地、FTP、SFTP、WebDAV、阿里云 OSS、华为云 OBS、七牛云 Kodo、腾讯云 COS、百度云 BOS、又拍云 USS、MinIO、 Amazon S3、Amazon S3 V2、GoogleCloud Storage、FastDFS、 Azure Blob Storage、Mongo GridFS、Mongo GridFS、go-fastdfs、 火山引擎 TOS、Cloudflare R2、金山云 KS3、美团云 MSS、京东云 OSS、天翼云 OOS、移动 云EOS、沃云 OSS、 网易数帆 NOS、Ucloud US3、青云 QingStor、平安云 OBS、首云 OSS、IBM COS、其它兼容 S3 协议的存储平台。查看 所有支持的存储平台

通过 WebDAV 连接到 Alist 后，可以使用百度网盘、天翼云盘、阿里云盘、迅雷网盘等常见存储服务，查看 Alist 支持的存储平台

支持在不同存储平台之间迁移文件，详情查看 迁移文件

GitHub：https://github.com/dromara/x-file-storage Gitee：https://gitee.com/dromara/x-file-storage GitCode：https://gitcode.com/dromara/x-file-storage

文档1：https://x-file-storage.dromara.org 文档2：https://x-file-storage.xuyanwu.cn 文档3：https://spring-file-storage.xuyanwu.cn

---

2.3.0更新内容

• 新增 Mongo GridFS 存储平台
• 新增 go-fastdfs 存储平台
• 新增 Amazon S3 V2 存储平台，适用于AWS SDK for Java 2.x，根据 Amazon 公告，AWS SDK for Java 1.x 自 2024 年 7 月 31 日起将进入维护模式，并于 2025 年 12 月 31 日终止支持。公告链接地址：The AWS SDK for Java 1.x is in maintenance mode, effective July 31, 2024
• 新增 火山引擎 TOS 存储平台
• 优化预签名 URL 逻辑
• 优化代码结构
• 修复 FastDFS 获取文件用户元数据名称开头没有去除 x-amz-meta- 的问题
• 修复 Solon 插件属性注入异常
• 修复 RemoteFileInfo.toFileInfoTh 调用错误的问题
• 修复 阿里云 OSS 列举已上传的分片无法使用的问题
• 修复 七牛云 Kodo 无法覆盖上传的问题
• 修复部分存储平台获取文件信息存在资源泄露的问题

---

使用

点击 快速入门 查看全部存储平台的使用方法！

配置

这里以阿里云 OSS 为例，pom.xml 引入本项目，这里默认是 SpringBoot 环境，其它环境参考 脱离 SpringBoot 单独使用

 <!-- 引入本项目 --> <dependency>     <groupId>org.dromara.x-file-storage</groupId>     <artifactId>x-file-storage-spring</artifactId>     <version>2.3.0</version> </dependency> <!-- 引入 阿里云 OSS SDK，如果使用其它存储平台，就引入对应的 SDK  --> <dependency>     <groupId>com.aliyun.oss</groupId>     <artifactId>aliyun-sdk-oss</artifactId>     <version>3.16.1</version> </dependency> 

 

application.yml 配置文件中添加以下基础配置

 dromara:   x-file-storage: #文件存储配置     default-platform: aliyun-oss-1 #默认使用的存储平台     aliyun-oss:       - platform: aliyun-oss-1 # 存储平台标识         enable-storage: true  # 启用存储         access-key: ??         secret-key: ??         end-point: ??         bucket-name: ??         domain: ?? # 访问域名，注意“/”结尾，例如：https://abc.oss-cn-shanghai.aliyuncs.com/         base-path: test/ # 基础路径 

 

编码

在启动类上加上@EnableFileStorage注解

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

 

✨开始上传

支持 File、MultipartFile、byte[]、InputStream、URL、URI、String、HttpServletRequest，大文件会自动分片上传。如果想支持更多方式，请阅读 文件适配器 章节

 @RestController public class FileDetailController {      @Autowired     private FileStorageService fileStorageService;//注入实列      /**      * 上传文件      */     @PostMapping("/upload")     public FileInfo upload(MultipartFile file) {         //只需要这一行代码即可上传成功         return fileStorageService.of(file).upload();     }          /**      * 上传文件，成功返回文件 url      */     @PostMapping("/upload2")     public String upload2(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();     }      /**      * 直接读取 HttpServletRequest 中的文件进行上传，成功返回文件信息      * 使用这种方式有些注意事项，请查看文档 基础功能-上传 章节      */     @PostMapping("/upload-request")     public FileInfo uploadPlatform(HttpServletRequest request) {         return fileStorageService.of(request).upload();     } } 

 

其它操作

 //手动构造文件信息，可用于其它操作 FileInfo fileInfo = new FileInfo()         .setPlatform("huawei-obs-1")         .setBasePath("test/")         .setPath("aa/")         .setFilename("image.png")         .setThFilename("image.png.min.jpg");  //文件是否存在 boolean exists = fileStorageService.exists(fileInfo); //下载 byte[] bytes = fileStorageService.download(fileInfo).bytes(); //删除 fileStorageService.delete(fileInfo); //其它更多操作  

 

如果将文件记录保存到数据库中，还可以更方便的根据 URL 进行操作了，详情请阅读 保存上传记录 章节

 //直接从数据库中获取 FileInfo 对象，更加方便执行其它操作 FileInfo fileInfo = fileStorageService.getFileInfoByUrl("https://abc.def.com/test/aa/image.png");  //文件是否存在 boolean exists = fileStorageService.exists("https://abc.def.com/test/aa/image.png"); //下载 byte[] bytes = fileStorageService.download("https://abc.def.com/test/aa/image.png").bytes(); //删除 fileStorageService.delete("https://abc.def.com/test/aa/image.png"); //其它更多操作 

 

点击 快速入门 查看全部存储平台的使用方法！

---

详情查看：https://gitee.com/dromara/x-file-storage/releases/v2.3.0