原名 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、GoogleCloud Storage、FastDFS、 Azure Blob Storage、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
📜更新记录
这里是简要的更新记录，查看 详细的更新记录
2.1.0 修复大量问题，新增存储平台 FastDFS 和 Azure Blob Storage，新增复制、移动（重命名）文件，手动分片上传（断点续传）和计算哈希等功能，详情查看 更新记录
2.0.0 捐赠至 dromara 开源社区，更改项目名、包名，优化项目结构、支持 Metadata 元数据等，从旧版升级需要注意，详情查看 更新记录
1.0.3 修复了 FileStorageClientFactory 未自动加载等问题，查看 更新记录
1.0.2 修复了华为云 OBS 未加载的问题，查看 更新记录
1.0.1 修复了 MultipartFile 无法正确获取文件名等问题，查看 更新记录
1.0.0 包含了大量功能更新与问题修复，例如解决了内存占用过大问题，支持大文件上传、 脱离 SpringBoot 单独使用 等，AmazonS3 和 GoogleCloudStorage 存储平台配置名称与之前版本不兼容，查看 更新记录
📅更新计划
- 接入存储平台：HDFS、火山云 TOS、Samba、NFS
- 用户端直传
- 追加缩略图
- 列出文件
- 文件内容预加载
- 新增 Access 模块，尝试通过 HTTP、FTP、WebDAV 等协议对外提供接口，方便其它程序使用
📦使用
点击 快速入门 查看全部存储平台的使用方法！
🔧 配置
这里以阿里云 OSS 为例，pom.xml 引入本项目，这里默认是 SpringBoot 环境，其它环境参考 脱离 SpringBoot 单独使用
<!-- 引入本项目 -->
<dependency>
<groupId>org.dromara.x-file-storage</groupId>
<artifactId>x-file-storage-spring</artifactId>
<version>2.1.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 配置文件中添加以下基础配置
关于配置文件及 FileInfo 中各种路径（path）的区别，可以参考 常见问题
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");
//其它更多操作点击 快速入门 查看全部存储平台的使用方法！
🏗️添砖加瓦
🎋分支说明
X File Storage 的源码分为两个分支，功能如下：
| 分支 | 作用 |
|---|---|
| main | 主分支，release 版本使用的分支，与**库提交的 jar 一致，不接收任何 pr 或修改 |
| dev | 开发分支，接受修改或 pr |
🐞提供bug反馈或建议
提交问题反馈请说明正在 X File Storage 版本、相关依赖库版本、配置参数及问题代码
🧬贡献代码的步骤
- 在 Gitee 或者 Github 上 fork 项目到自己的 repo
- 把 fork 过去的项目也就是你的项目 clone 到你的本地
- 修改代码（记得一定要修改 dev 分支）
- commit后push到自己的库（ dev 分支）
- 登录 Gitee 或 Github 在你首页可以看到一个 pull request 按钮，点击它，填写一些说明信息，然后提交即可
- 等待维护者合并
🧬 开发约定 & 配置
- JDK 11+、Maven 3.8.1+
- 代码风格，目前代码风格通过 spotless-maven-plugin + palantir-java-format 统一控制，Maven 构建时统一格式化代码
- 在开发阶段，IDE 要识别到 spotless-maven-plugin + palantir-java-format 需要安装插件：palantir-java-format
📐PR遵照的原则
欢迎任何人为 X File Storage 添砖加瓦，贡献代码，为了易用性和可维护性，需要提交的 pr（pull request）符合一些规范，规范如下：
- 逻辑清晰、注释完备，不易理解的代码段的说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名
- 提交到 dev 分支，main 分支不接受任何 pr 或修改
- 如果我们关闭了你的 issues 或者 pr 请查看回复内容，我们会在回复中做出解释
📋使用公司及组织登记
X File Storage 感谢各位小伙伴的信任与支持，如果您已经在项目中使用了 X File Storage，希望您留下您的公司或组织信息（公司或组织名称、官网地址、展示 Logo 图片）
您的公司信息将在项目官网进行展示：
x-file-storage.dromara.org
x-file-storage.xuyanwu.cn
spring-file-storage.xuyanwu.cn
🌏知识星球
💳捐赠
如果你觉得这个项目不错，可以点个 Star 或捐赠请作者吃包辣条~，不想打赏的话用支付宝扫最后一个码可以领取个红包，在此表示感谢^_^
或者点击以下链接，将页面拉到最下方点击“捐赠”即可
🌶️VIP交流群
扫描上方二维码捐赠 99 元，截图发我 QQ1171736840 即可加入 VIP 交流群（超过一年则需要再次捐赠，否则将进行清退）
也可以点击添加免费交流群
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent