摘要：添加快速集成的對(duì)象存儲(chǔ)服務(wù)，提供常用的文件操作方法，當(dāng)然也提供自定義擴(kuò)展，以致于滿足絕大數(shù)業(yè)務(wù)場(chǎng)景，并且通過(guò)擴(kuò)展可以實(shí)現(xiàn)上傳文件進(jìn)度條下載文件進(jìn)度條存儲(chǔ)空間操作靜態(tài)網(wǎng)站托管訪問(wèn)日志防盜鏈分片上傳追加上傳斷點(diǎn)續(xù)傳等等。

ApiBoot是一款基于SpringBoot1.x，2.x的接口服務(wù)集成基礎(chǔ)框架， 內(nèi)部提供了框架的封裝集成、使用擴(kuò)展、自動(dòng)化完成配置，讓接口開(kāi)發(fā)者可以選著性完成開(kāi)箱即用， 不再為搭建接口框架而犯愁，從而極大的提高開(kāi)發(fā)效率。

ApiBoot添加快速集成Aliyun的對(duì)象存儲(chǔ)服務(wù)Oss，提供常用的文件操作方法，當(dāng)然也提供自定義擴(kuò)展，以致于滿足絕大數(shù)業(yè)務(wù)場(chǎng)景，并且通過(guò)擴(kuò)展可以實(shí)現(xiàn)上傳文件進(jìn)度條、下載文件進(jìn)度條、存儲(chǔ)空間操作、靜態(tài)網(wǎng)站托管、訪問(wèn)日志、防盜鏈、分片上傳、追加上傳、斷點(diǎn)續(xù)傳等等。

在pom.xml配置文件內(nèi)添加依賴，如下所示：

    org.minbox.framework
    api-boot-starter-alibaba-oss

ApiBoot所提供的依賴都不需要添加版本號(hào)，具體查看ApiBoot版本依賴

在使用ApiBoot Oss時(shí)，只需要注入ApiBootOssService類就可以完成默認(rèn)方法的使用，如下所示：

@Autowired
private ApiBootOssService apiBootOssService;

/**
  * 流方式上傳
  */
@Test
public void uploadBytes() {
  ApiBootObjectStorageResponse response = apiBootOssService.upload("admin.txt", "admin".getBytes());
  logger.info("文件名稱：{}", response.getObjectName());
  logger.info("文件訪問(wèn)路徑：{}", response.getObjectUrl());
}

/**
* 本地文件上傳
*/
@Test
public void uploadFile() {
    ApiBootObjectStorageResponse response = apiBootOssService.upload("logo.png", "/Users/yuqiyu/Downloads/logo.png");
    logger.info("文件名稱：{}", response.getObjectName());
    logger.info("文件訪問(wèn)路徑：{}", response.getObjectUrl());
}

/**
* 文件流方式上傳
*
* @throws Exception
*/
@Test
public void uploadInputStream() throws Exception {
    FileInputStream inputStream = new FileInputStream(new File("/Users/yuqiyu/Downloads/logo.png"));
    ApiBootObjectStorageResponse response = apiBootOssService.upload("測(cè)試.png", inputStream);
    logger.info("文件名稱：{}", response.getObjectName());
    logger.info("文件訪問(wèn)路徑：{}", response.getObjectUrl());
}

通過(guò)文件的輸入流完成對(duì)象存儲(chǔ)文件的上傳

/**
  * 下載文件
  */
@Test
public void download() {
  apiBootOssOverrideService.download("測(cè)試.png", "/Users/yuqiyu/Downloads/測(cè)試.png");
}

在上面的示例中，文件會(huì)自動(dòng)下載到/Users/yuqiyu/Downloads/目錄下，文件名稱為測(cè)試.png。

/**
* 刪除文件示例
*/
@Test
public void delete() {
    apiBootOssOverrideService.delete("測(cè)試.png");
}

刪除對(duì)象存儲(chǔ)空間內(nèi)的文件時(shí)只需要傳遞文件名即可。

如果你是通過(guò)SpringMvc提供的MultipartFile對(duì)象進(jìn)行上傳文件，可以通過(guò)如下示例進(jìn)行上傳：

MultipartFile multipartFile = ..;
// 流方式上傳
ApiBootObjectStorageResponse responseByte = apiBootOssService.upload("測(cè)試.png", multipartFile.getBytes());
// 文件輸入流方式上傳
ApiBootObjectStorageResponse responseIs = apiBootOssService.upload("測(cè)試.png", multipartFile.getInputStream());

ApiBoot Alibaba Oss提供的方法畢竟是有限的，因此ApiBoot提供了自定義的擴(kuò)展方式，讓使用者可以根據(jù)Oss官方文檔進(jìn)行擴(kuò)展，包含上傳文件進(jìn)度條、下載文件進(jìn)度條、存儲(chǔ)空間操作、靜態(tài)網(wǎng)站托管、訪問(wèn)日志、防盜鏈、分片上傳、追加上傳、斷點(diǎn)續(xù)傳等等。

自定義擴(kuò)展首先需要?jiǎng)?chuàng)建類并繼承ApiBootOssService，如下所示：

//...
public class ApiBootOssOverrideService extends ApiBootOssService {
    /**
     * logger instance
     */
    static Logger logger = LoggerFactory.getLogger(ApiBootOssOverrideService.class);

    /**
     * 實(shí)現(xiàn)父類構(gòu)造函數(shù)
     *
     * @param endpoint        外網(wǎng)節(jié)點(diǎn)
     * @param bucketName      存儲(chǔ)空間名稱
     * @param accessKeyId     阿里云賬號(hào)授權(quán)Id
     * @param accessKeySecret 阿里云賬號(hào)授權(quán)Secret
     * @param domain          自定義域名
     */
    public ApiBootOssOverrideService(String endpoint, String bucketName, String accessKeyId, String accessKeySecret, String domain) {
        super(endpoint, bucketName, accessKeyId, accessKeySecret, domain);
    }

    /**
     * 創(chuàng)建bucket存儲(chǔ)
     *
     * @param bucketName 存儲(chǔ)名稱
     */
    public void createBucket(String bucketName) {
        OSSClient ossClient = getOssClient();
        Bucket bucket = ossClient.createBucket(bucketName);
        logger.info("新創(chuàng)建存儲(chǔ)空間名稱：{}", bucket.getName());
        logger.info("新創(chuàng)建存儲(chǔ)空間所屬人：{}", bucket.getOwner().getDisplayName());
        closeOssClient(ossClient);
    }
}

如上createBucket方法所示ApiBootOssService內(nèi)部提供了獲取OssClient以及關(guān)閉OssClient連接的方法，可以直接調(diào)用。

擴(kuò)展生效

我們自定義的擴(kuò)展，需要將實(shí)例放入SpringIOC容器內(nèi)，方便我們?cè)谑褂锰庍M(jìn)行注入，要注意，由于構(gòu)造函數(shù)參數(shù)的原因，無(wú)法直接通過(guò)@Service或者@Component注解進(jìn)行標(biāo)注，需要通過(guò)如下方式：

//...
@Bean
@ConditionalOnMissingBean
ApiBootOssOverrideService apiBootOssOverrideService(ApiBootOssProperties apiBootOssProperties) {
  return new ApiBootOssOverrideService(apiBootOssProperties.getRegion().getEndpoint(), apiBootOssProperties.getBucketName(), apiBootOssProperties.getAccessKeyId(), apiBootOssProperties.getAccessKeySecret(), apiBootOssProperties.getDomain());
}

ApiBootOssProperties屬性配置類，是ApiBoot內(nèi)置的，可以在任意地方進(jìn)行注入，這里目的只是為了拿到相關(guān)配置進(jìn)行構(gòu)造參數(shù)實(shí)例化使用。

本章源碼地址：https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-oss