文件存储解决方案：Spring File Storage

穆璋垒Estelle

于 2025-04-12 09:21:53 发布

阅读量599

点赞数 14

本文链接：https://blog.csdn.net/gitblog_00868/article/details/147159192

版权

文件存储解决方案：Spring File Storage

x-file-storage 项目地址: https://gitcode.com/gh_mirrors/xfi/x-file-storage

1. 项目介绍

Spring File Storage 是一个开源项目，旨在提供一种简单的文件存储解决方案，允许用户通过一行代码将文件存储到多种存储平台。支持的存储平台包括本地、FTP、SFTP、WebDAV、谷歌云存储、阿里云OSS等，并且还在持续扩展中。这个项目大大简化了文件存储的开发工作，提高了开发效率。

2. 项目快速启动

环境准备

JDK 11+
Maven 3.8.1+

添加依赖

在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.dromara.x-file-storage</groupId>
    <artifactId>x-file-storage-spring</artifactId>
    <version>2.2.1</version>
</dependency>

如果使用阿里云OSS作为存储平台，还需要添加阿里云OSS 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: ??  # 访问域名，注意“/”结尾
      base-path: test/  # 基础路径

启动类

在启动类上添加 @EnableFileStorage 注解：

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

上传文件

在控制器中注入 FileStorageService 并使用它来上传文件：

@RestController
public class FileDetailController {
    @Autowired
    private FileStorageService fileStorageService;

    @PostMapping("/upload")
    public FileInfo upload(MultipartFile file) {
        return fileStorageService.of(file).upload();
    }
}

3. 应用案例和最佳实践

上传文件并返回URL

@PostMapping("/upload2")
public String upload2(MultipartFile file) {
    FileInfo fileInfo = fileStorageService.of(file)
        .setPath("upload/")
        .setSaveFilename("image.jpg")
        .upload();
    return fileInfo == null ? "上传失败！" : fileInfo.getUrl();
}

上传图片并生成缩略图

@PostMapping("/upload-image")
public FileInfo uploadImage(MultipartFile file) {
    return fileStorageService.of(file)
        .image(img -> img.size(1000, 1000))
        .thumbnail(th -> th.size(200, 200))
        .upload();
}

上传文件到指定存储平台

@PostMapping("/upload-platform")
public FileInfo uploadPlatform(MultipartFile file) {
    return fileStorageService.of(file)
        .setPlatform("aliyun-oss-1")
        .upload();
}