SpringBoot文件上传工具类#

1
官网:https://spring-file-storage.xuyanwu.cn

Spring File Storage工具几乎整合了市面上所有的OSS对象存储平台,包括本地、FTP、SFTP、WebDAV、阿里云OSS、华为云OBS、七牛云Kodo、腾讯云COS、百度云 BOS、又拍云USS、MinIO、京东云 OSS、网易数帆 NOS等其它兼容 S3 协议的平台,只要在springboot中通过极简的方式就可以实现文件存储。

1、简单配置#

下边以本地和Aliyun OSS上传为例,pom.xml中引入必要的spring-file-storage.jar,注意: 如果要上传文件到OSS平台,需要引入对应平台的SDK包。

1
<!-- spring-file-storage 必须要引入 -->
2
<dependency>
3
    <groupId>cn.xuyanwu</groupId>
4
    <artifactId>spring-file-storage</artifactId>
5
    <version>0.5.0</version>
6
</dependency>
7

8
<!-- 阿里云oss -->
9
<dependency>
10
    <groupId>com.aliyun.oss</groupId>
11
    <artifactId>aliyun-sdk-oss</artifactId>
12
    <version>3.10.2</version>
13
</dependency>

application.yml文件中配置些基础信息。

1
enable-storage:只有状态开启才会被识别到

1
default-platform:默认的上传平台

1
domain:生成的文件url中访问的域名

1
base-path:存储地址

1
thumbnail-suffix:缩略图后缀

要是上传OSS对象存储平台,将aliyun oss提供的变量配置到相应的模块上即可。

1
spring:
2
  #文件存储配置(本地、oss)
3
  file-storage:
4
    default-platform: local-1
5
    thumbnail-suffix: ".min.jpg" #缩略图后缀
6
    local:
7
      - platform: local-1 # 存储平台标识
8
        enable-storage: true #是否开启本存储(只能选一种)
9
        enable-access: true #启用访问(线上请使用 Nginx 配置,效率更高)
10
        domain: "http://127.0.0.1:2222" #访问域名,注意后面要和path-patterns保持一致,“/”结尾
11
        base-path: /tmp/Pictures/ # 存储地址
12
        path-patterns: /** #访问路径
13
    aliyun-oss:
14
      - platform: aliyun-oss
15
        enable-storage: true
16
        access-key: xxxx
17
        secret-key: xxxx
18
        end-point: xxx
19
        bucket-name: firebook
20
        domain: http://fire100.top
21
        base-path: #云平台文件路径

springboot启动类中增加注解@EnableFileStorage,显式的开启文件上传功能,到这就可以用了

1
@EnableFileStorage // 文件上传工具
2
@SpringBootApplication
3
public class SpringbootFileStorageApplication {
4

5
    public static void main(String[] args) {
6
        SpringApplication.run(SpringbootFileStorageApplication.class, args);
7
    }
8
}

2、上传文件#

接下来在业务类中引入FileStorageService服务,如下只要一行代码就可以完成文件上传,是不是So easy,下载也是如法炮制。

1
@RestController
2
public class FileController {
3

4
    @Autowired
5
    private FileStorageService fileStorageService;
6

7
    /**
8
     * 上传文件
9
     */
10
    @PostMapping(value = {"/upload"})
11
    public Object upload(MultipartFile file) {
12
        FileInfo upload  = fileStorageService.of(file).upload();
13
        return upload;
14
    }
15
}

我们用postman测试上传一张图片,看到图片已经成功传到了/tmp/Pictures目录下,返回结果中包含了完整的访问文件的URL路径

不仅如此spring-file-storage还支持多种文件形式,URI、URL、String、byte[]、InputStream、MultipartFile,使开发更加灵活。

文件上传功能,更多时候我们都是在上传图片,那就会有动态裁剪图片、生成缩略图的需求,这些 spring-file-storage 都可以很容易实现。

1
/**
2
 * 上传图片裁剪大小并生成一张缩略图
3
 */
4
@PostMapping("/uploadThumbnail")
5
public FileInfo uploadThumbnail(MultipartFile file) {
6
    return fileStorageService.of(file)
7
            .image(img -> img.size(1000,1000))  //将图片大小调整到 1000*1000
8
            .thumbnail(th -> th.size(200,200))  //再生成一张 200*200 的缩略图
9
            .upload();
10
}

而且我们还可以动态选择上传平台,配置文件中将所有平台开启,在实际使用中自由的选择。

1
/**
2
 * 上传文件到指定存储平台,成功返回文件信息
3
 */
4
@PostMapping("/upload-platform")
5
public FileInfo uploadPlatform(MultipartFile file) {
6
    return fileStorageService.of(file)
7
            .setPlatform("aliyun-oss")    //使用指定的存储平台
8
            .upload();
9
}

3、下载文件#

下载文件也同样的简单,可以直接根据文件url或者文件流下载。

1
/**
2
 * 下载文件
3
 */
4
@PostMapping("/download")
5
public void download(MultipartFile file) {
6
    // 获取文件信息
7
    FileInfo fileInfo = fileStorageService.getFileInfoByUrl("http://file.abc.com/test/a.jpg");
8

9
    // 下载到文件
10
    fileStorageService.download(fileInfo).file("C:\\a.jpg");
11

12
    // 直接通过文件信息中的 url 下载,省去手动查询文件信息记录的过程
13
    fileStorageService.download("http://file.abc.com/test/a.jpg").file("C:\\a.jpg");
14

15
    // 下载缩略图
16
    fileStorageService.downloadTh(fileInfo).file("C:\\th.jpg");
17
}

提供了监听下载进度的功能,可以清晰明了的掌握文件的下载情况。

1
// 下载文件 显示进度
2
fileStorageService.download(fileInfo).setProgressMonitor(new ProgressListener() {
3
    @Override
4
    public void start() {
5
        System.out.println("下载开始");
6
    }
7

8
    @Override
9
    public void progress(long progressSize,long allSize) {
10
        System.out.println("已下载 " + progressSize + " 总大小" + allSize);
11
    }
12

13
    @Override
14
    public void finish() {
15
        System.out.println("下载结束");
16
    }
17
}).file("C:\\a.jpg");

4、文件存在、删除#

我们还可以根据文件的URL地址来判断文件是否存在、以及删除文件。

1
//直接通过文件信息中的 url 删除,省去手动查询文件信息记录的过程
2
fileStorageService.delete("http://file.abc.com/test/a.jpg");
3
//直接通过文件信息中的 url 判断文件是否存在,省去手动查询文件信息记录的过程
4
boolean exists2 = fileStorageService.exists("http://file.abc.com/test/a.jpg");

5、切面#

工具还提供了每种操作的切面,可以在每个动作的前后进行干预,比如打日志或者玩点花活,实现FileStorageAspect类重写对应动作的xxxAround方法。

1
/**
2
 * 使用切面打印文件上传和删除的日志
3
 */
4
@Slf4j
5
@Component
6
public class LogFileStorageAspect implements FileStorageAspect {
7

8
    /**
9
     * 上传,成功返回文件信息,失败返回 null
10
     */
11
    @Override
12
    public FileInfo uploadAround(UploadAspectChain chain, FileInfo fileInfo, UploadPretreatment pre, FileStorage fileStorage, FileRecorder fileRecorder) {
13
        log.info("上传文件 before -> {}",fileInfo);
14
        fileInfo = chain.next(fileInfo,pre,fileStorage,fileRecorder);
15
        log.info("上传文件 after -> {}",fileInfo);
16
        return fileInfo;
17
    }
18
}

音乐

音乐