Java追加上傳
追加上傳是指通過AppendObject方法在已上傳的追加類型文件(Appendable Object)末尾直接追加內(nèi)容。
注意事項(xiàng)
本文以華東1(杭州)外網(wǎng)Endpoint為例。如果您希望通過與OSS同地域的其他阿里云產(chǎn)品訪問OSS,請使用內(nèi)網(wǎng)Endpoint。關(guān)于OSS支持的Region與Endpoint的對應(yīng)關(guān)系,請參見OSS訪問域名、數(shù)據(jù)中心、開放端口。
本文以從環(huán)境變量讀取訪問憑證為例。如何配置訪問憑證,請參見Java配置訪問憑證。
本文以OSS域名新建OSSClient為例。如果您希望通過自定義域名、STS等方式新建OSSClient,請參見新建OSSClient。
要追加上傳,您必須有
oss:PutObject
權(quán)限。具體操作,請參見為RAM用戶授權(quán)自定義的權(quán)限策略。當(dāng)文件不存在時(shí),調(diào)用AppendObject接口會(huì)創(chuàng)建一個(gè)追加類型文件。
當(dāng)文件已存在時(shí):
如果文件為追加類型文件,且設(shè)置的追加位置和文件當(dāng)前長度相等,則直接在該文件末尾追加內(nèi)容。
如果文件為追加類型文件,但是設(shè)置的追加位置和文件當(dāng)前長度不相等,則拋出PositionNotEqualToLength異常。
如果文件為非追加類型文件時(shí),例如通過簡單上傳的文件類型為Normal的文件,則拋出ObjectNotAppendable異常。
示例代碼
以下代碼用于追加上傳文件。
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.AppendObjectRequest;
import com.aliyun.oss.model.AppendObjectResult;
import com.aliyun.oss.model.ObjectMetadata;
import java.io.ByteArrayInputStream;
public class Demo {
public static void main(String[] args) throws Exception {
// Endpoint以華東1(杭州)為例,其它Region請按實(shí)際情況填寫。
String endpoint = "https://oss-cn-hangzhou.aliyuncs.com";
// 從環(huán)境變量中獲取訪問憑證。運(yùn)行本代碼示例之前,請確保已設(shè)置環(huán)境變量OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
EnvironmentVariableCredentialsProvider credentialsProvider = CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
// 填寫B(tài)ucket名稱,例如examplebucket。
String bucketName = "examplebucket";
// 填寫Object完整路徑,完整路徑中不能包含Bucket名稱,例如exampledir/exampleobject.txt。
String objectName = "exampledir/exampleobject.txt";
String content1 = "Hello OSS A \n";
String content2 = "Hello OSS B \n";
String content3 = "Hello OSS C \n";
// 填寫B(tài)ucket所在地域。以華東1(杭州)為例,Region填寫為cn-hangzhou。
String region = "cn-hangzhou";
// 創(chuàng)建OSSClient實(shí)例。
ClientBuilderConfiguration clientBuilderConfiguration = new ClientBuilderConfiguration();
clientBuilderConfiguration.setSignatureVersion(SignVersion.V4);
OSS ossClient = OSSClientBuilder.create()
.endpoint(endpoint)
.credentialsProvider(credentialsProvider)
.clientConfiguration(clientBuilderConfiguration)
.region(region)
.build();
try {
ObjectMetadata meta = new ObjectMetadata();
// 指定上傳的內(nèi)容類型。
meta.setContentType("text/plain");
// 指定該Object的網(wǎng)頁緩存行為。
//meta.setCacheControl("no-cache");
// 指定該Object被下載時(shí)的名稱。
//meta.setContentDisposition("attachment;filename=oss_download.txt");
// 指定該Object的內(nèi)容編碼格式。
//meta.setContentEncoding(OSSConstants.DEFAULT_CHARSET_NAME);
// 該請求頭用于檢查消息內(nèi)容是否與發(fā)送時(shí)一致。
//meta.setContentMD5("ohhnqLBJFiKkPSBO1eNaUA==");
// 指定過期時(shí)間。
//try {
// meta.setExpirationTime(DateUtil.parseRfc822Date("Wed, 08 Jul 2022 16:57:01 GMT"));
//} catch (ParseException e) {
// e.printStackTrace();
//}
// 指定服務(wù)器端加密方式。此處指定為OSS完全托管密鑰進(jìn)行加密(SSE-OSS)。
//meta.setServerSideEncryption(ObjectMetadata.AES_256_SERVER_SIDE_ENCRYPTION);
// 指定Object的訪問權(quán)限。此處指定為私有訪問權(quán)限。
//meta.setObjectAcl(CannedAccessControlList.Private);
// 指定Object的存儲類型。
//meta.setHeader(OSSHeaders.OSS_STORAGE_CLASS, StorageClass.Standard);
// 創(chuàng)建AppendObject時(shí)可以添加x-oss-meta-*,繼續(xù)追加時(shí)不可以攜帶此參數(shù)。如果配置以x-oss-meta-*為前綴的參數(shù),則該參數(shù)視為元數(shù)據(jù)。
//meta.setHeader("x-oss-meta-author", "Alice");
// 通過AppendObjectRequest設(shè)置多個(gè)參數(shù)。
AppendObjectRequest appendObjectRequest = new AppendObjectRequest(bucketName, objectName, new ByteArrayInputStream(content1.getBytes()),meta);
// 通過AppendObjectRequest設(shè)置單個(gè)參數(shù)。
// 設(shè)置Bucket名稱。
//appendObjectRequest.setBucketName(bucketName);
// 設(shè)置Object名稱。
//appendObjectRequest.setKey(objectName);
// 設(shè)置待追加的內(nèi)容。可選類型包括InputStream類型和File類型。此處為InputStream類型。
//appendObjectRequest.setInputStream(new ByteArrayInputStream(content1.getBytes()));
// 設(shè)置待追加的內(nèi)容。可選類型包括InputStream類型和File類型。此處為File類型。
//appendObjectRequest.setFile(new File("D:\\localpath\\examplefile.txt"));
// 指定文件的元數(shù)據(jù),第一次追加時(shí)有效。
//appendObjectRequest.setMetadata(meta);
// 第一次追加。
// 設(shè)置文件的追加位置。
appendObjectRequest.setPosition(0L);
AppendObjectResult appendObjectResult = ossClient.appendObject(appendObjectRequest);
// 文件的64位CRC值。此值根據(jù)ECMA-182標(biāo)準(zhǔn)計(jì)算得出。
System.out.println(appendObjectResult.getObjectCRC());
// 第二次追加。
// nextPosition表示下一次請求中應(yīng)當(dāng)提供的Position,即文件當(dāng)前的長度。
appendObjectRequest.setPosition(appendObjectResult.getNextPosition());
appendObjectRequest.setInputStream(new ByteArrayInputStream(content2.getBytes()));
appendObjectResult = ossClient.appendObject(appendObjectRequest);
// 第三次追加。
appendObjectRequest.setPosition(appendObjectResult.getNextPosition());
appendObjectRequest.setInputStream(new ByteArrayInputStream(content3.getBytes()));
appendObjectResult = ossClient.appendObject(appendObjectRequest);
} 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();
}
}
}
}
相關(guān)文檔
關(guān)于追加上傳的完整示例代碼,請參見GitHub示例。
關(guān)于追加上傳的API接口說明,請參見AppendObject。