x-file-storage

<h3 align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/1e0d8269-9a5a-4d43-b24c-efb94b68bd22.svg" height="200px" alt="logo"/> 原名 X Spring File Storage 现已捐赠至 <a target="_blank" href="https://dromara.org/zh">dromara</a> 开源组织 </h3> <a target="_blank" href="https://x-file-storage.dromara.org">x-file-storage.dromara.org</a> | <a target="_blank" href="https://x-file-storage.xuyanwu.cn">x-file-storage.xuyanwu.cn</a> | <a target="_blank" href="https://spring-file-storage.xuyanwu.cn">spring-file-storage.xuyanwu.cn</a> <a target="_blank" href="https://central.sonatype.com/search?q=org.dromara.x-file-storage"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/d152a2b9-65bb-4198-b7fb-88a61a783ca6.svg?label=Maven%20Central" /> </a> <a target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/3b724a41-3957-403f-8609-fcb5c26dcc9d.svg" /> </a> <a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/8e7d8395-3ce3-4d6c-a121-0f7e6c4339e5.svg" /> </a> <a target="_blank" href='https://github.com/dromara/x-file-storage'> <img src="https://yellow-cdn.veclightyear.com/835a84d5/6065468c-a3b1-472b-b604-0f6ce49dd8d4.svg?style=social" alt="github star"/> </a> <a href='https://gitee.com/dromara/x-file-storage'> <img src='https://yellow-cdn.veclightyear.com/835a84d5/b69e2d72-acda-4a74-9bbf-39f3e4d391be.svg?theme=dark' alt='star' /> </a> <a href='https://jq.qq.com/?_wv=1027&k=eGfeNqka'> <img src='https://img.shields.io/badge/QQ%E7%BE%A4-515706495-orange' alt='515706495' /> </a> <a target="_blank" href='https://x-file-storage.xuyanwu.cn/#/?id=🌶%ef%b8%8fvip交流群'> <img src='https://img.shields.io/badge/付费-VIP交流群-brightgreen' alt='' /> </a>

📚简介

只需一行代码即可将文件存储到本地、FTP、SFTP、WebDAV、阿里云OSS、华为云OBS、七牛云Kodo、腾讯云COS、百度云BOS、又拍云USS、MinIO、Amazon S3、Google Cloud 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 的响应流中
其他更多功能

📦使用

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

🔧 配置

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

<!-- 引入本项目 -->
<dependency>
    <groupId>org.dromara.x-file-storage</groupId>
    <artifactId>x-file-storage-spring</artifactId>
    <version>2.2.1</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、UploadedFile、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/") //保存到相对路径下，为了方便管理，不需要可以不写
                .setSaveFilename("image.jpg") //设置保存的文件名，不需要可以不写，会随机生成
                .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://x-file-storage.xuyanwu.cn/#/快速入门)查看所有存储平台的使用方法！

-------

### 🏗️贡献代码

#### 🎋分支说明

X File Storage的源代码分为两个分支，功能如下：

| 分支    | 作用                                              |
|-------|-------------------------------------------------| 
| main	 | 主分支，用于发布版本，与中央仓库提交的jar包一致，不接受任何pr或修改 |
| dev	  | 开发分支，接受修改或pr                                   |

#### 🐞提供bug反馈或建议

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

[Gitee issue](https://gitee.com/dromara/x-file-storage/issues)<br/>
[GitHub issue](https://github.com/dromara/x-file-storage/issues)

#### 🧬贡献代码的步骤

1. 在Gitee或GitHub上fork项目到自己的仓库
2. 将fork的项目克隆到本地
3. 修改代码（请务必修改dev分支）
4. commit后push到自己的仓库（dev分支）
5. 登录Gitee或GitHub，在你的首页可以看到一个pull request按钮，点击它，填写一些说明信息，然后提交即可
6. 等待维护者合并

#### 🧬开发约定 & 配置
1. JDK 11+、Maven 3.8.1+
2. 代码风格通过spotless-maven-plugin + palantir-java-format统一控制，Maven构建时会统一格式化代码
3. 在开发阶段，为了让IDE识别spotless-maven-plugin + palantir-java-format，需要安装插件：[palantir-java-format](https://plugins.jetbrains.com/plugin/13180-palantir-java-format)

#### 📐PR遵循的原则

欢迎任何人为X File Storage贡献代码。为了保证易用性和可维护性，提交的pr（pull request）需要符合以下规范：

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

-------

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

您的公司信息将在项目官网展示：<br/>
<a target="_blank" href="https://x-file-storage.dromara.org">x-file-storage.dromara.org</a><br/>
<a target="_blank" href="https://x-file-storage.xuyanwu.cn">x-file-storage.xuyanwu.cn</a><br/>
<a target="_blank" href="https://spring-file-storage.xuyanwu.cn">spring-file-storage.xuyanwu.cn</a>

[在Gitee上登记](https://gitee.com/dromara/x-file-storage/issues/I83Q6R)<br/>
[在GitHub上登记](https://github.com/dromara/x-file-storage/issues/114)

-------

### 🌏知识星球

<img src="https://yellow-cdn.veclightyear.com/835a84d5/d771d8b7-737d-4e2f-810d-2422f81b8739.png" height="200px" alt="知识星球">

-------

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

<img src="https://yellow-cdn.veclightyear.com/835a84d5/e07bbc47-1501-4d61-9848-0d454a7ec110.png" height="300px" alt="微信"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/f12dd4f6-5afa-4e74-852d-c367cfd3d250.jpg" height="300px" alt="支付宝"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/f74fa02d-1ab2-40a8-8cb9-b159eecfd919.jpg" height="300px" alt="支付宝2">
<img src="https://yellow-cdn.veclightyear.com/835a84d5/4b6ce6e7-b487-4763-8aff-88fb4bb0e459.jpg" height="300px" alt="饿了么"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/ad44a1b7-69ea-4a46-97dc-4041311b4077.jpeg" height="300px" alt="美团外卖">

或者点击以下链接，将页面拉到最下方点击"捐赠"即可

[在Gitee上捐赠](https://gitee.com/dromara/x-file-storage)

-------

# 🌶️VIP交流群

扫描上方二维码捐赠99元，截图发送至QQ 1171736840即可加入VIP交流群（超过一年需再次捐赠，否则将被清退）

也可以点击加入免费交流群
<a target="_blank" href='https://jq.qq.com/?_wv=1027&k=eGfeNqka'>
<img src='https://img.shields.io/badge/QQ%E7%BE%A4-515706495-orange' alt='515706495' />
</a> 一起交流