從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();
}
}
}
}
相關文檔
關于限定條件下載的API接口說明,請參見GetObject。