SpringBoot 整合 阿里雲OSS對象存儲服務

今天來整合一下SpringBoot和阿里雲OSS對象存儲服務。

---

一、配置OSS服務

先在阿里雲開通對象存儲服務，拿到AccessKeyId、AccessKeySecret。

創建你的bucket(存儲空間)，相當於一個一個的文件夾目錄。按業務需求分類存儲你的文件，圖片，音頻，app包等等。創建bucket是要選擇該bucket的權限，私有，公共讀，公共讀寫，按需求選擇。創建bucket時對應的endpoint要記住，上傳文件需要用到。

可以配置bucket的生命週期，比如說某些文件有過期時間的，可以配置一下。

---

二、代碼實現

引入依賴包

<dependency>
    <groupId>com.aliyun.oss</groupId>
    <artifactId>aliyun-sdk-oss</artifactId>
    <version>2.8.3</version>
</dependency>

配置文件application.yml

aliyun-oss:
  #bucket名稱
  bucketApp: xxx-app
  domainApp: https://xxx-app.oss-cn-shenzhen.aliyuncs.com/
  region: oss-cn-shenzhen
  endpoint : https://oss-cn-shenzhen.aliyuncs.com
  accessKeyId: 你的accessKeyId
  accessKeySecret: 你的accessKeySecret

對應上面配置文件的properties類

package com.example.file.config;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "aliyun-oss")
@Data
public class AliyunOSSProperties {

    /**
     * 服務器地點
     */
    private String region;
    /**
     * 服務器地址
     */
    private String endpoint;
    /**
     * OSS身份id
     */
    private String accessKeyId;
    /**
     * 身份密鑰
     */
    private String accessKeySecret;

    /**
     * App文件bucketName
     */
    private String bucketApp;
    /**
     * App包文件地址前綴
     */
    private String domainApp;
}

上傳文件工具類

package com.example.file.utils;

import com.aliyun.oss.OSSClient;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.ObjectMetadata;
import com.aliyun.oss.model.PutObjectResult;
import com.example.common.exception.BusinessErrorCode;
import com.example.common.exception.BusinessException;
import com.example.common.utils.FileIdUtils;
import com.example.file.config.AliyunOSSProperties;
import com.example.file.config.FileTypeEnum;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

@Component
public class AliyunOSSUtil {

    @Autowired
    private AliyunOSSProperties aliyunOSSProperties;

    private static Logger logger = LoggerFactory.getLogger(AliyunOSSUtil.class);

    /**
     * 文件不存在
     */
    private final String NO_SUCH_KEY = "NoSuchKey";
    /**
     * 存儲空間不存在
     */
    private final String NO_SUCH_BUCKET = "NoSuchBucket";

    /**
     * 上傳文件到阿里雲 OSS 服務器
     *
     * @param files
     * @param fileTypeEnum
     * @param bucketName
     * @param storagePath
     * @return
     */
    public List<String> uploadFile(MultipartFile[] files, FileTypeEnum fileTypeEnum, String bucketName, String storagePath, String prefix) {
        //創建OSSClient實例
        OSSClient ossClient = new OSSClient(aliyunOSSProperties.getEndpoint(), aliyunOSSProperties.getAccessKeyId(), aliyunOSSProperties.getAccessKeySecret());
        List<String> fileIds = new ArrayList<>();
        try {
            for (MultipartFile file : files) {
           		//創建一個唯一的文件名，類似於id，就是保存在OSS服務器上文件的文件名(自定義文件名)
                String fileName = FileIdUtils.creater(fileTypeEnum.getCode());
                InputStream inputStream = file.getInputStream();
                ObjectMetadata objectMetadata = new ObjectMetadata();
                //設置數據流裏有多少個字節可以讀取
                objectMetadata.setContentLength(inputStream.available());
                objectMetadata.setCacheControl("no-cache");
                objectMetadata.setHeader("Pragma", "no-cache");
                objectMetadata.setContentType(file.getContentType());
                objectMetadata.setContentDisposition("inline;filename=" + fileName);
                fileName = StringUtils.isNotBlank(storagePath) ? storagePath + "/" + fileName : fileName;
                //上傳文件
                PutObjectResult result = ossClient.putObject(bucketName, fileName, inputStream, objectMetadata);
                logger.info("Aliyun OSS AliyunOSSUtil.uploadFileToAliyunOSS,result:{}", result);
                fileIds.add(prefix + fileName);
            }
        } catch (IOException e) {
            logger.error("Aliyun OSS AliyunOSSUtil.uploadFileToAliyunOSS fail,reason:{}", e);
        } finally {
            ossClient.shutdown();
        }
        return fileIds;
    }

    /**
     * 刪除文件
     *
     * @param fileName
     * @param bucketName
     */
    public void deleteFile(String fileName, String bucketName) {
        OSSClient ossClient = new OSSClient(aliyunOSSProperties.getEndpoint(), aliyunOSSProperties.getAccessKeyId(), aliyunOSSProperties.getAccessKeySecret());
        ossClient.deleteObject(bucketName, fileName);
        shutdown(ossClient);
    }

    /**
     * 根據圖片全路徑刪除就圖片
     *
     * @param imgUrl     圖片全路徑
     * @param bucketName 存儲路徑
     */
    public void delImg(String imgUrl, String bucketName) {
        if (StringUtils.isBlank(imgUrl)) {
            return;
        }
        //問號
        int index = imgUrl.indexOf('?');
        if (index != -1) {
            imgUrl = imgUrl.substring(0, index);
        }
        int slashIndex = imgUrl.lastIndexOf('/');
        String fileId = imgUrl.substring(slashIndex + 1);
        OSSClient ossClient = new OSSClient(aliyunOSSProperties.getEndpoint(), aliyunOSSProperties.getAccessKeyId(), aliyunOSSProperties.getAccessKeySecret());
        ossClient.deleteObject(bucketName, fileId);
        shutdown(ossClient);
    }

    /**
     * 判斷文件是否存在
     *
     * @param fileName   文件名稱
     * @param bucketName 文件儲存空間名稱
     * @return true:存在,false:不存在
     */
    public boolean doesObjectExist(String fileName, String bucketName) {
        Validate.notEmpty(fileName, "fileName can be not empty");
        Validate.notEmpty(bucketName, "bucketName can be not empty");
        OSSClient ossClient = new OSSClient(aliyunOSSProperties.getEndpoint(), aliyunOSSProperties.getAccessKeyId(), aliyunOSSProperties.getAccessKeySecret());
        try {
            boolean found = ossClient.doesObjectExist(bucketName, fileName);
            return found;
        } finally {
            shutdown(ossClient);
        }

    }

    /**
     * 複製文件
     *
     * @param fileName              源文件名稱
     * @param bucketName            源儲存空間名稱
     * @param destinationBucketName 目標儲存空間名稱
     * @param destinationObjectName 目標文件名稱
     */
    public void ossCopyObject(String fileName, String bucketName, String destinationBucketName, String destinationObjectName) {
        Validate.notEmpty(fileName, "fileName can be not empty");
        Validate.notEmpty(bucketName, "bucketName can be not empty");
        Validate.notEmpty(destinationBucketName, "destinationBucketName can be not empty");
        Validate.notEmpty(destinationObjectName, "destinationObjectName can be not empty");
        OSSClient ossClient = new OSSClient(aliyunOSSProperties.getEndpoint(), aliyunOSSProperties.getAccessKeyId(), aliyunOSSProperties.getAccessKeySecret());
        // 拷貝文件。
        try {
            ossClient.copyObject(bucketName, fileName, destinationBucketName, destinationObjectName);
        } catch (OSSException oe) {
            logger.error("errorCode:{},Message:{},requestID:{}", oe.getErrorCode(), oe.getMessage(), oe.getRequestId());
            if (oe.getErrorCode().equals(NO_SUCH_KEY)) {
                throw new BusinessException(BusinessErrorCode.NO_SUCH_KEY);
            } else if (oe.getErrorCode().equals(NO_SUCH_BUCKET)) {
                throw new BusinessException(BusinessErrorCode.NO_SUCH_BUCKET);
            } else {
                throw new BusinessException(BusinessErrorCode.FAIL);
            }
        } finally {
            shutdown(ossClient);
        }
    }

    /**
     * 關閉oos
     *
     * @param ossClient ossClient
     */
    private void shutdown(OSSClient ossClient) {
        ossClient.shutdown();
    }
}

文件類型枚舉

package com.example.file.config;

public enum FileTypeEnum {

    IMG(1, "圖片"),
    AUDIO(2, "音頻"),
    VIDEO(3, "視頻"),
    APP(4, "App包"),
    OTHER(5, "其他");

    private Integer code;
    private String message;

    FileTypeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

}

調用工具類上傳文件

@Override
    public List<String> uploadImg(MultipartFile[] files) {
        if (files == null) {
            throw new BusinessException(BusinessErrorCode.OPT_UPLOAD_FILE);
        }
        try {
            return aliyunOSSUtil.uploadFile(files, FileTypeEnum.IMG, aliyunOSSProperties.getBucketProduct(), null, aliyunOSSProperties.getDomainProduct());
        } catch (Exception e) {
            logger.error("uploadImg error e:{}", e);
            throw new BusinessException(BusinessErrorCode.UPLOAD_FAIL);
        }
    }

返回的List是文件上傳之後文件的文件名集合。
到此就整合完成了。可以登錄OSS控制檯查看對應的文件。

---