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

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

github star star 515706495


📚简介

一行代码将文件存储到本地、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.2.1 修复某些情况下哈希计算错误的问题、七牛云 Kodo 预签名 URL 无法使用的问题 更新记录
2.2.0 修复大量问题,新增获取文件、列举文件,重构预签名 URL 支持客户端上传、下载、删除等操作,新增 Solon 插件,优化手动分片上传等功能,详情查看 更新记录
2.1.0 修复大量问题,新增存储平台 FastDFS 和 Azure Blob Storage,新增复制、移动(重命名)文件,手动分片上传(断点续传)和计算哈希等功能,详情查看 更新记录
2.0.0 捐赠至 dromara 开源社区,更改项目名、包名,优化项目结构、支持 Metadata 元数据等,从旧版升级需要注意,详情查看 更新记录


📅更新计划

  • 接入存储平台:HDFS、火山云 TOS、Samba、NFS
  • 追加缩略图
  • 文件内容预加载
  • 新增 Access 模块,尝试通过 HTTP、FTP、WebDAV 等协议对外提供接口,方便其它程序使用
  • 追加文件
  • 分片下载
  • 直接输出到 HttpServletResponse 的响应流中
  • 其它更多功能

📦使用

阅读 快速入门 开始使用吧!


💳捐赠

如果你觉得这个项目不错,可以点个 Star 或捐赠请作者吃包辣条~,不想打赏的话用支付宝扫最后一个码可以领取个红包,在此表示感谢^_^

微信 支付宝 支付宝2 饿了么 美团外卖

或者点击以下链接,将页面拉到最下方点击“捐赠”即可

Gitee上捐赠


🌶️VIP交流群

扫描上方二维码捐赠 99 元,截图发我 QQ1171736840 即可加入 VIP 交流群(超过一年则需要再次捐赠,否则将进行清退)

也可以点击添加免费交流群 515706495 一起交流


🏗️添砖加瓦

🎋分支说明

X File Storage 的源码分为两个分支,功能如下:

分支 作用
main 主分支,release 版本使用的分支,与中央库提交的 jar 一致,不接收任何 pr 或修改
dev 开发分支,接受修改或 pr

🐞提供bug反馈或建议

提交问题反馈请说明正在 X File Storage 版本、相关依赖库版本、配置参数及问题代码

Gitee issue
GitHub issue

🧬贡献代码的步骤

  1. 在 Gitee 或者 Github 上 fork 项目到自己的 repo
  2. 把 fork 过去的项目也就是你的项目 clone 到你的本地
  3. 修改代码(记得一定要修改 dev 分支)
  4. commit后push到自己的库( dev 分支)
  5. 登录 Gitee 或 Github 在你首页可以看到一个 pull request 按钮,点击它,填写一些说明信息,然后提交即可
  6. 等待维护者合并

📐PR遵照的原则

欢迎任何人为 X File Storage 添砖加瓦,贡献代码,为了易用性和可维护性,需要提交的 pr(pull request)符合一些规范,规范如下:

  1. 逻辑清晰、注释完备,不易理解的代码段的说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名
  2. 提交到 dev 分支,main 分支不接受任何 pr 或修改
  3. 如果我们关闭了你的 issues 或者 pr 请查看回复内容,我们会在回复中做出解释

📋使用公司及组织登记

X File Storage 感谢各位小伙伴的信任与支持,如果您已经在项目中使用了 X File Storage,希望您留下您的公司或组织信息(公司或组织名称、官网地址、展示 Logo 图片)

您的公司信息将在项目官网进行展示:
x-file-storage.dromara.org
x-file-storage.xuyanwu.cn
spring-file-storage.xuyanwu.cn

在 Gitee 上登记
在 GitHub 上登记


🌏知识星球

知识星球

🚀Dromara成员项目

为往圣继绝学,一个人或许能走的更快,但一群人会走的更远。


👭友情项目

我的博客(常年不更新)        用 JavaScript 在浏览器中控制台观看 BadApple!!