開發準備

相關資源

cos java sdk v4 github 項目。

環境依賴

JDK 1.7（本版本 SDK 基於 JSON API 封裝組成）。

安裝 SDK

• maven 安裝。
  pom.xml 添加依賴
• <dependency> <groupId>com.qcloud</groupId> <artifactId>cos_api</artifactId> <version>4.7</version> </dependency>
• 源碼安裝。
  從 cos java sdk v4 github 下載源碼。

卸載SDK

刪除 pom 依賴或源碼。

歷史版本

4.2版本是針對 COS 4.X系統，接口與3.x的基本一致，如果需要使用歷史版本，請參見 cos java sdk v3 github。

生成客戶端對象

初始化密鑰信息

long appId = 1000000;
String secretId = "xxxxxxxxxxxxxxxxxxxxxxxxxxx";
String secretKey = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
// 設置要操作的bucket
String bucketName = "xxxxxxxxx";
// 初始化密鑰信息
Credentials cred = new Credentials(appId, secretId, secretKey);

初始化客戶端配置（如設置園區）

// 初始化客戶端配置
ClientConfig clientConfig = new ClientConfig();
// 設置bucket所在的區域，例如華南園區：gz； 華北園區：tj；華東園區：sh ；
clientConfig.setRegion("gz");

生成客戶端

// 初始化cosClient
COSClient cosClient = new COSClient(clientConfig, cred);

文件操作

上傳文件

方法原型

String uploadFile(UploadFileRequest request);

參數說明

返回值

示例

UploadFileRequest uploadFileRequest = new UploadFileRequest(bucketName,         "/sample_file.txt", "local_file_1.txt");
String uploadFileRet = cosClient.uploadFile(uploadFileRequest);

下載文件

方法原型

String getFileLocal(GetFileLocalRequest request);

參數說明

request 成員

示例

String localPathDown = "src/test/resources/local_file_down.txt";
GetFileLocalRequest getFileLocalRequest =
  new GetFileLocalRequest(bucketName, cosFilePath, localPathDown);
getFileLocalRequest.setUseCDN(false);
getFileLocalRequest.setReferer("*.myweb.cn");
String getFileResult = cosClient.getFileLocal(getFileLocalRequest);

移動文件

方法原型

String moveFile(MoveFileRequest request);

參數說明

request 成員

示例

String cosFilePath = "/sample_file.txt";
String dstCosFilePath = "/sample_file.txt.bak";
MoveFileRequest moveRequest =
  new MoveFileRequest(bucketName, cosFilePath, dstCosFilePath);
String moveFileResult = cosClient.moveFile(moveRequest);

獲取文件屬性

方法原型

String statFile(StatFileRequest request);

參數說明

返回值

示例

StatFileRequest statFileRequest = new StatFileRequest(bucketName, "/sample_file.txt");
String statFileRet = cosClient.statFile(statFileRequest);

更新文件屬性

方法原型

String updateFile(UpdateFileRequest request);

參數說明

request 成員

tips: 更新屬性可以選擇其中的某幾個，對於HTTP頭部cache_control，content_type, content_disposition 和 x-cos-meta-，如果本次只更新其中的某幾個，其他的都會被抹掉，即這4個屬性是整體更新。

返回值

示例

UpdateFileRequest updateFileRequest = new UpdateFileRequest(bucketName, "/sample_file.txt");

updateFileRequest.setBizAttr("測試目錄");
updateFileRequest.setAuthority(FileAuthority.WPRIVATE);
updateFileRequest.setCacheControl("no cache");
updateFileRequest.setContentDisposition("cos_sample.txt");
updateFileRequest.setContentLanguage("english");
updateFileRequest.setContentType("application/json");
updateFileRequest.setXCosMeta("x-cos-meta-xxx", "xxx");
updateFileRequest.setXCosMeta("x-cos-meta-yyy", "yyy");

String updateFileRet = cosClient.updateFile(updateFileRequest);

刪除文件

方法原型

String delFile(DelFileRequest request);

參數說明

request 成員

返回值

示例

DelFileRequest delFileRequest = new DelFileRequest(bucketName, "/sample_file_move.txt");
String delFileRet = cosClient.delFile(delFileRequest);

目錄操作

創建目錄

方法原型

String createFolder(CreateFolderRequest request);    

參數說明

request 成員

返回值

示例

CreateFolderRequest createFolderRequest = new CreateFolderRequest(bucketName, "/sample_folder/");
String createFolderRet = cosClient.createFolder(createFolderRequest);

獲取目錄屬性

方法原型

String statFolder(StatFolderRequest request);

參數說明

request 成員

返回值

示例

StatFolderRequest statFolderRequest = new StatFolderRequest(bucketName, "/sample_folder/");
String statFolderRet = cosClient.statFolder(statFolderRequest);

更新目錄屬性

方法原型

String updateFolder(UpdateFolderRequest request);

參數說明

request 成員

返回值

示例

UpdateFolderRequest updateFolderRequest = new UpdateFolderRequest(bucketName, "/sample_folder/");
updateFolderRequest.setBizAttr("這是一個測試目錄");
String updateFolderRet = cosClient.updateFolder(updateFolderRequest);

獲取目錄列表

方法原型

String listFolder(ListFolderRequest request);

參數說明

request 成員

返回值

示例

ListFolderRequest listFolderRequest = new ListFolderRequest(bucketName, "/sample_folder/");
String listFolderRet = cosClient.listFolder(listFolderRequest);

刪除目錄

方法原型

String delFolder(DelFolderRequest request);

參數說明

返回值

示例

DelFolderRequest delFolderRequest = new DelFolderRequest(bucketName, "/sample_folder/");
String delFolderRet = cosClient.delFolder(delFolderRequest);

簽名管理

簽名模塊提供了生成多次簽名、單次簽名和下載簽名的接口，其中多次簽名和單次簽名在文件和目錄操作的api內部使用，用戶不用關心，下載簽名用於方便用戶生成下載私有 bucket 的文件簽名。

多次簽名

String getPeriodEffectiveSign(String bucketName, String cosPath, Credentials cred, long expired)

使用場景

上傳文件，重命名文件，創建目錄，獲取文件目錄屬性，拉取目錄列表。

參數說明

返回值

base64 編碼的字符串。

示例

Credentials cred = new Credentials(appId, secretId, secretKey);
long expired = System.currentTimeMillis() / 1000 + 600;
String signStr = Sign.getPeriodEffectiveSign(bucketName, "/pic/test.jpg", cred, expired);

單次簽名

String getOneEffectiveSign(String bucketName, String cosPath, Credentials cred)

使用場景

刪除和更新文件目錄。

參數說明

返回值

base64 編碼的字符串。

示例

Credentials cred = new Credentials(appId, secretId, secretKey);
String signStr = Sign.getOneEffectiveSign(bucketName, "/pic/test.jpg", cred);

下載簽名

String getDownLoadSign(String bucketName, String cosPath, Credentials cred, long expired)

使用場景

生成文件的下載簽名，用於下載私有 bucket 的文件。

參數說明

返回值

base64 編碼的字符串。

示例

Credentials cred = new Credentials(appId, secretId, secretKey);
long expired = System.currentTimeMillis() / 1000 + 600;
String signStr = Sign.getDownLoadSign(bucketName, "/pic/test.jpg", cred, expired);

返回值

小夥伴們有興趣想了解內容和更多相關學習資料的請點讚收藏+評論轉發+關注我，後面會有很多乾貨。我有一些面試題、架構、設計類資料可以說是程式設計師面試必備！

所有資料都整理到網盤了，需要的話歡迎下載！私信我回復【111】即可免費獲取

出處：https://cloud.tencent.com/document/product/436/6273