Spring File Storage文件的對象存儲框架基本使用小結(jié)

更新時間：2024年08月19日 10:27:39 作者：墨鴉_Cormorant

在開發(fā)過程當(dāng)中,會使用到存文檔、圖片、視頻、音頻等等,這些都會涉及存儲的問題,文件可以直接存服務(wù)器,但需要考慮帶寬和存儲空間,另外一種方式就是使用云存儲,這篇文章主要介紹了Spring File Storage文件的對象存儲框架基本使用小結(jié),需要的朋友可以參考下

概述

本文僅作為快速入門，深入學(xué)習(xí)及使用詳見官網(wǎng)

云存儲

在開發(fā)過程當(dāng)中，會使用到存文檔、圖片、視頻、音頻等等，這些都會涉及存儲的問題，文件可以直接存服務(wù)器，但需要考慮帶寬和存儲空間，另外一種方式就是使用云存儲。目前主流的云存儲有阿里云OSS、華為云OBS、七牛云Kodo、騰訊云COS、百度云 BOS、又拍云USS、MinIO 等。

X Spring File Storage 介紹

在 SpringBoot 中通過簡單的方式將文件存儲到本地、FTP、SFTP、WebDAV、谷歌云存儲、阿里云OSS、華為云OBS、七牛云Kodo、騰訊云COS、百度云 BOS、又拍云USS、MinIO、 AWS S3、金山云 KS3、美團云 MSS、京東云 OSS、天翼云 OOS、移動云 EOS、沃云 OSS、網(wǎng)易數(shù)帆 NOS、Ucloud US3、青云 QingStor、平安云 OBS、首云 OSS、IBM COS、其它兼容 S3 協(xié)議的平臺。

支持的平臺如下圖:

快速入門

添加依賴

<dependencies>
    <!-- spring-file-storage 必須要引入 -->
    <dependency>
        <groupId>cn.xuyanwu</groupId>
        <artifactId>spring-file-storage</artifactId>
        <version>2.1.0</version>
    </dependency>
    <!-- 華為云OBS 不使用的情況下可以不引入 -->
    <dependency>
        <groupId>com.huaweicloud</groupId>
        <artifactId>esdk-obs-java</artifactId>
        <version>3.22.12</version>
    </dependency>
    <!-- 阿里云OSS 不使用的情況下可以不引入 -->
    <dependency>
        <groupId>com.aliyun.oss</groupId>
        <artifactId>aliyun-sdk-oss</artifactId>
        <version>3.16.1</version>
    </dependency>

添加配置文件

注：以下配置是 2.1.0 版本的配置

dromara:
  x-file-storage: #文件存儲配置
    default-platform: huawei-obs-1 #默認(rèn)使用的存儲平臺
    thumbnail-suffix: ".min.jpg" #縮略圖后綴，例如【.min.jpg】【.png】
    # 對應(yīng)平臺的配置寫在這里，注意縮進要對齊
    huawei-obs:
      - platform: huawei-obs-1 # 存儲平臺標(biāo)識
        enable-storage: true  # 啟用存儲。只有狀態(tài)開啟才會被識別到
        access-key: ??
        secret-key: ??
        end-point: ??
        bucket-name: ??
        domain: ?? # 訪問域名，注意“/”結(jié)尾，例如：http://abc.obs.com/
        base-path: test/ # 基礎(chǔ)路徑
    # 本地存儲（升級版）
    local-plus:
      - platform: local-plus-1 # 存儲平臺標(biāo)識
        enable-storage: true  #啟用存儲
        enable-access: true #啟用訪問（線上請使用 Nginx 配置，效率更高）
        domain: http://127.0.0.1:8080/file/ # 訪問域名，例如：“http://127.0.0.1:8030/file/”，注意后面要和 path-patterns 保持一致，“/”結(jié)尾，本地存儲建議使用相對路徑，方便后期更換域名
        base-path: local-plus/ # 基礎(chǔ)路徑
        path-patterns: /file/** # 訪問路徑
        storage-path: D:/Temp/ # 存儲路徑

編碼

顯式的開啟文件上傳功能

在啟動類上加上@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")   //關(guān)聯(lián)對象id，為了方便管理，不需要可以不寫
                .setObjectType("0") //關(guān)聯(lián)對象類型，為了方便管理，不需要可以不寫
                .putAttr("role","admin") //保存一些屬性，可以在切面、保存上傳記錄、自定義存儲平臺等地方獲取使用，不需要可以不寫
                .upload();  //將文件上傳到對應(yīng)地方
        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))  //將圖片大小調(diào)整到 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 中的文件進行上傳，成功返回文件信息
     * 使用這種方式有些注意事項，請查看文檔 基礎(chǔ)功能-上傳 章節(jié)
     */
    @PostMapping("/upload-request")
    public FileInfo uploadPlatform(HttpServletRequest request) {
        return fileStorageService.of(request).upload();
    }
}

文件是否存在、下載、刪除

//手動構(gòu)造文件信息，可用于其它操作
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.download(fileInfo).file("C:\\a.jpg");
// 下載縮略圖
fileStorageService.downloadTh(fileInfo).file("C:\\th.jpg");
//刪除
fileStorageService.delete(fileInfo);
// 如果將文件記錄保存到數(shù)據(jù)庫中，還可以更方便的根據(jù) URL 進行操作
//直接從數(shù)據(jù)庫中獲取 FileInfo 對象，更加方便執(zhí)行其它操作
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");

監(jiān)聽器

// 下載文件 顯示進度
fileStorageService.download(fileInfo).setProgressMonitor(new ProgressListener() {
    @Override
    public void start() {
        System.out.println("下載開始");
    }
    @Override
    public void progress(long progressSize,long allSize) {
        System.out.println("已下載 " + progressSize + " 總大小" + allSize);
    }
    @Override
    public void finish() {
        System.out.println("下載結(jié)束");
    }
}).file("C:\\a.jpg");

切面

工具還提供了每種操作的切面，可以在每個動作的前后進行干預(yù)，比如打日志，實現(xiàn) FileStorageAspect 類重寫對應(yīng)動作的 xxxAround 方法。

/**
 * 使用切面打印文件上傳和刪除的日志
 */
@Slf4j
@Component
public class LogFileStorageAspect implements FileStorageAspect {
    /**
     * 上傳，成功返回文件信息，失敗返回 null
     */
    @Override
    public FileInfo uploadAround(UploadAspectChain chain, FileInfo fileInfo, UploadPretreatment pre, FileStorage fileStorage, FileRecorder fileRecorder) {
        log.info("上傳文件 before -> {}",fileInfo);
        fileInfo = chain.next(fileInfo,pre,fileStorage,fileRecorder);
        log.info("上傳文件 after -> {}",fileInfo);
        return fileInfo;
    }
}

表設(shè)計

-- mysql
DROP TABLE IF EXISTS `file_detail`;
CREATE TABLE `file_detail`
(
    `id` int(10) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '文件id',
    `url` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '文件訪問地址',
    `size`  bigint(20) NULL DEFAULT NULL COMMENT '文件大小，單位字節(jié)',
    `filename` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '文件名稱',
    `original_filename` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '原始文件名',
    `base_path` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '基礎(chǔ)存儲路徑',
    `path` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '存儲路徑',
    `ext` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci  NULL DEFAULT NULL COMMENT '文件擴展名',
    `content_type` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT 'MIME類型',
    `platform` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci  NULL DEFAULT NULL COMMENT '存儲平臺',
    `th_url` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '縮略圖訪問路徑',
    `th_filename` varchar(256) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '縮略圖名稱',
    `th_size` bigint(20) NULL DEFAULT NULL COMMENT '縮略圖大小，單位字節(jié)',
    `th_content_type` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '縮略圖MIME類型',
    `object_id` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '文件所屬對象id',
    `object_type` varchar(32) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '文件所屬對象類型，例如用戶頭像，評價圖片',
    `attr` text CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '附加屬性',
    `create_time` datetime(0) NULL DEFAULT NULL COMMENT '創(chuàng)建時間',
    PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB
  AUTO_INCREMENT = 1
  CHARACTER SET = utf8
  COLLATE = utf8_general_ci COMMENT = '文件記錄表'
  ROW_FORMAT = Dynamic;
-- postgre 自定義
create table if not exists "file_detail" (
    id VARCHAR(255) not null,
    url VARCHAR(255) not null,
    "size" BIGINT null,
    filename VARCHAR(255) null,
    original_filename VARCHAR(255) null,
    base_path VARCHAR(255) null,
    "path" VARCHAR(255) null,
    ext VARCHAR(255) null,
    content_type VARCHAR(255) null,
    platform VARCHAR(255) null,
    th_url VARCHAR(255) null,
    th_filename VARCHAR(255) null,
    th_size bigint null,
    th_content_type VARCHAR(255) null,
    object_id VARCHAR(255) null,
    object_type VARCHAR(255) null,
    attr VARCHAR(255) null,
    create_time TIMESTAMP null,
    project_id UUID null,
    tenant_id UUID null,
    primary key ("id")
    );
-- Column comments
COMMENT ON TABLE file_detail IS '文件記錄表';
COMMENT ON COLUMN public.file_detail.id IS '主鍵';
COMMENT ON COLUMN public.file_detail.url IS '文件訪問地址';
COMMENT ON COLUMN public.file_detail."size" IS '文件大小，單位字節(jié)';
COMMENT ON COLUMN public.file_detail.filename IS '文件名稱';
COMMENT ON COLUMN public.file_detail.original_filename IS '原始文件名';
COMMENT ON COLUMN public.file_detail.base_path IS '基礎(chǔ)存儲路徑';
COMMENT ON COLUMN public.file_detail."path" IS '存儲路徑';
COMMENT ON COLUMN public.file_detail.ext IS '文件擴展名';
COMMENT ON COLUMN public.file_detail.content_type IS 'MIME類型';
COMMENT ON COLUMN public.file_detail.platform IS '存儲平臺';
COMMENT ON COLUMN public.file_detail.th_url IS '縮略圖訪問路徑';
COMMENT ON COLUMN public.file_detail.th_filename IS '縮略圖名稱';
COMMENT ON COLUMN public.file_detail.th_size IS '縮略圖大小，單位字節(jié)';
COMMENT ON COLUMN public.file_detail.th_content_type IS '縮略圖MIME類型';
COMMENT ON COLUMN public.file_detail.object_id IS '文件所屬對象id';
COMMENT ON COLUMN public.file_detail.object_type IS '文件所屬對象類型，例如用戶頭像，評價圖';
COMMENT ON COLUMN public.file_detail.attr IS '附加屬性';
COMMENT ON COLUMN public.file_detail.create_time IS '創(chuàng)建時間';
COMMENT ON COLUMN public.file_detail.project_id IS '項目id';
COMMENT ON COLUMN public.file_detail.tenant_id IS '租戶id';