Java下載滿足條件的檔案 - Object Storage Service

從Bucket中下載單個檔案（Object）時，可以指定基於檔案的最後修改時間或者ETag（檔案內容的標識符）的限制條件。滿足限定條件則下載，不滿足限定條件則返回錯誤且不會觸發下載行為。使用限定條件下載可以減少網路傳輸和資源消耗，提高下載效率。

限定條件

OSS支援的限定條件如下：

說明

If-Modified-Since和If-Unmodified-Since可以同時存在。If-Match和If-None-Match也可以同時存在。
您可以通過ossClient.getObjectMeta方法擷取ETag。

參數	描述
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）。

注意事項

本文以華東1（杭州）外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS，請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係，請參見OSS訪問網域名稱、資料中心、開放連接埠。
本文以從環境變數讀取存取憑證為例。如何配置訪問憑證，請參見Java配置訪問憑證。
本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient，請參見建立OSSClient。
要限定條件下載，您必須有oss:GetObject許可權。具體操作，請參見為RAM使用者授權自訂的權限原則。

範例程式碼

以下代碼用於通過ossClient.getObject方法使用限定條件下載。ossClient.downloadFile方法也支援使用限定條件下載，使用方式與ossClient.getObject方法類似。

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.common.auth.*;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.GetObjectRequest;
import java.io.File;
import java.util.Date;

public class Demo {

    public static void main(String[] args) throws Exception {
        // Endpoint以華東1（杭州）為例，其它Region請按實際情況填寫。
        String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
        // 從環境變數中擷取訪問憑證。運行本程式碼範例之前，請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
        EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // 填寫Bucket名稱，例如examplebucket。
        String bucketName = "examplebucket";
        // 填寫不包含Bucket名稱在內的Object完整路徑，例如testfolder/exampleobject.txt。
        String objectName = "testfolder/exampleobject.txt";
        String pathName = "D:\\localpath\\examplefile.txt";
        // 填寫Bucket所在地區。以華東1（杭州）為例，Region填寫為cn-hangzhou。
        String region = "cn-hangzhou";

        // 建立OSSClient執行個體。
        ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
        clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);        
        OSS ossClient = OSSClientBuilder.create()
        .endpoint(endpoint)
        .credentialsProvider(credentialsProvider)
        .clientConfiguration(clientBuilderConfiguration)
        .region(region)               
        .build();

        try {
            GetObjectRequest request = new GetObjectRequest(bucketName, objectName);
            // 假設Object最後修改時間為2023年9月26日13:27:04，當填寫早於該時間的Data對象時（例如Tue Sep 25 13:27:04 CST 2023），將滿足If-Modified-Since的限定條件，並觸發下載行為。
            request.setModifiedSinceConstraint(new Date("Tue Sep 25 13:27:04 CST 2023"));

            // 下載OSS檔案到本地檔案。
            ossClient.getObject(request, new File(pathName));
        } catch (OSSException oe) {
            System.out.println("Caught an OSSException, which means your request made it to OSS, "
                    + "but was rejected with an error response for some reason.");
            System.out.println("Error Message:" + oe.getErrorMessage());
            System.out.println("Error Code:" + oe.getErrorCode());
            System.out.println("Request ID:" + oe.getRequestId());
            System.out.println("Host ID:" + oe.getHostId());
        } catch (ClientException ce) {
            System.out.println("Caught an ClientException, which means the client encountered "
                    + "a serious internal problem while trying to communicate with OSS, "
                    + "such as not being able to access the network.");
            System.out.println("Error Message:" + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

Object Storage Service：Java限定條件下載

限定條件

注意事項

範例程式碼

相關文檔