com.luna.ali.oss.AliOssDownloadApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ali-spring-boot-starter Show documentation
Ali API Toolkit Contain Oss And AliPay...
The newest version!
package com.luna.ali.oss;

import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.Date;

import com.aliyun.oss.OSS;
import com.aliyun.oss.model.DownloadFileRequest;
import com.aliyun.oss.model.DownloadFileResult;
import com.aliyun.oss.model.GetObjectRequest;
import com.aliyun.oss.model.OSSObject;
import com.luna.ali.config.AliOssConfigProperties;
import com.luna.common.net.base.HttpBaseUtils;
import org.apache.commons.lang3.StringUtils;

/**
 * @Package: com.luna.ali.oss
 * @ClassName: AliOssDownLoadApi
 * @Author: luna
 * @CreateTime: 2020/8/22 15:43
 * @Description:
 */
public class AliOssDownloadApi {

    /**
     * 文本读取下载
     * 
     * @param bucketName
     * @param objectName
     * @param aliOssConfigProperties
     * @return
     */
    public String downloadByStream(String bucketName, String objectName, AliOssConfigProperties aliOssConfigProperties) {

        // 创建OSSClient实例。
        OSS ossClient = aliOssConfigProperties.getOssClient(false);

        // ossObject包含文件所在的存储空间名称、文件名称、文件元信息以及一个输入流。
        OSSObject ossObject = ossClient.getObject(bucketName, objectName);

        // 读取文件内容。
        BufferedReader reader = new BufferedReader(new InputStreamReader(ossObject.getObjectContent()));
        String s = HttpBaseUtils.readWithReader(reader);
        // 数据读取完成后，获取的流必须关闭，否则会造成连接泄漏，导致请求无连接可用，程序无法正常工作。
        try {
            reader.close();
        } catch (IOException e) {
        }

        // 关闭OSSClient。
        ossClient.shutdown();
        return s;
    }

    /**
     * 下载文件到本地
     * 
     * @param bucketName
     * @param objectName
     * @param loaclFile
     * @param aliOssConfigProperties
     */
    public void downloadByFile(String bucketName, String objectName, String loaclFile, AliOssConfigProperties aliOssConfigProperties) {

        // 创建OSSClient实例。
        OSS ossClient = aliOssConfigProperties.getOssClient(false);

        // 下载OSS文件到本地文件。如果指定的本地文件存在会覆盖，不存在则新建。
        ossClient.getObject(new GetObjectRequest(bucketName, objectName), new File(loaclFile));

        // 关闭OSSClient。
        ossClient.shutdown();
    }

    /**
     * 条件下载
     * If-Modified-Since 如果指定的时间早于实际修改时间，则正常传输文件，否则返回错误（304 Not modified）。
     * If-Unmodified-Since 如果指定的时间等于或者晚于文件实际修改时间，则正常传输文件，否则返回错误（412 Precondition failed）。
     * If-Match 如果指定的ETag和OSS文件的ETag匹配，则正常传输文件，否则返回错误（412 Precondition failed）。
     * If-None-Match 如果指定的ETag和OSS文件的ETag不匹配，则正常传输文件，否则返回错误（304 Not modified）。
     * 
     * @param bucketName
     * @param objectName
     * @param loaclFile
     * @param aliOssConfigProperties
     */
    public void downloadByCondition(String bucketName, String objectName, String loaclFile,
                                    AliOssConfigProperties aliOssConfigProperties) {

        // 创建OSSClient实例。
        OSS ossClient = aliOssConfigProperties.getOssClient(false);

        GetObjectRequest request = new GetObjectRequest(bucketName, objectName);
        // 设置限定条件。
        // 修改时间比当前时间早
        request.setModifiedSinceConstraint(new Date());

        // 下载OSS文件到本地文件。
        ossClient.getObject(request, new File(loaclFile));

        // 关闭OSSClient。
        ossClient.shutdown();
    }

    /**
     * 断点续传
     * 
     * @param bucketName
     * @param objectName
     * @param loaclFile
     * @param checkFile
     * @param aliOssConfigProperties
     */
    public void downloadByGoOn(String bucketName, String objectName, String loaclFile, String checkFile,
                               AliOssConfigProperties aliOssConfigProperties) {

        // 创建OSSClient实例。
        OSS ossClient = aliOssConfigProperties.getOssClient(false);

        // 下载请求，10个任务并发下载，启动断点续传。
        DownloadFileRequest downloadFileRequest = new DownloadFileRequest(bucketName, objectName);
        downloadFileRequest.setDownloadFile(loaclFile);
        downloadFileRequest.setPartSize(1 * 1024 * 1024);
        downloadFileRequest.setTaskNum(10);
        downloadFileRequest.setEnableCheckpoint(true);
        if (StringUtils.isNotEmpty(checkFile)) {
            downloadFileRequest.setCheckpointFile(checkFile);

        }
        // 下载文件。
        DownloadFileResult downloadRes = null;
        try {
            downloadRes = ossClient.downloadFile(downloadFileRequest);
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        // 下载成功时，会返回文件元信息。
        downloadRes.getObjectMetadata();

        // 关闭OSSClient。
        ossClient.shutdown();

    }
}