本文介紹如何列舉存儲空間下(Bucket)中的所有文件(Object)、指定個數的文件、指定前綴的文件等。
注意事項
使用本文示例前您需要先通過自定義域名、STS等方式新建OSSClient,具體請參見如何初始化Android端OSSClient實例。
列舉指定個數的文件
以下代碼用于列舉examplebucket中最多20個文件。
// 填寫B(tài)ucket名稱,例如examplebucket。
ListObjectsRequest request = new ListObjectsRequest("examplebucket");
// 填寫返回文件的最大個數。如果不設置此參數,則默認值為100,maxkeys的取值不能大于1000。
request.setMaxKeys(20);
oss.asyncListObjects(request, new OSSCompletedCallback<ListObjectsRequest, ListObjectsResult>() {
@Override
public void onSuccess(ListObjectsRequest request, ListObjectsResult result) {
for (OSSObjectSummary objectSummary : result.getObjectSummaries()) {
Log.i("ListObjects", objectSummary.getKey());
}
}
@Override
public void onFailure(ListObjectsRequest request, ClientException clientException, ServiceException serviceException) {
// 請求異常。
if (clientException != null) {
// 客戶端異常,例如網絡異常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服務端異常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
列舉指定前綴的文件
以下代碼用于列舉examplebucket中以file為前綴的文件。
// 填寫B(tài)ucket名稱,例如examplebucket。
ListObjectsRequest request = new ListObjectsRequest("examplebucket");
// 填寫前綴。
// 前綴為模糊匹配,查詢結果為名稱是<輸入參數>+*的文件,如果輸入a將返回所有以a為前綴的文件,例如abc.txt,abcd.jpg。
request.setPrefix("file");
oss.asyncListObjects(request, new OSSCompletedCallback<ListObjectsRequest, ListObjectsResult>() {
@Override
public void onSuccess(ListObjectsRequest request, ListObjectsResult result) {
for (OSSObjectSummary objectSummary : result.getObjectSummaries()) {
Log.i("ListObjects", objectSummary.getKey());
}
}
@Override
public void onFailure(ListObjectsRequest request, ClientException clientException, ServiceException serviceException) {
// 請求異常。
if (clientException != null) {
// 客戶端異常,例如網絡異常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服務端異常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
列舉指定marker之后的文件
以下代碼用于列舉examplebucket中exampleobject.txt之后的文件。
// 填寫B(tài)ucket名稱,例如examplebucket。
ListObjectsRequest request = new ListObjectsRequest("examplebucket");
// 填寫marker。從marker之后按字母排序的第一個開始返回文件。
// 如果marker在存儲空間中不存在,則會從符合marker字母排序的下一個開始返回文件。
request.setMarker("exampleobject.txt");
oss.asyncListObjects(request, new OSSCompletedCallback<ListObjectsRequest, ListObjectsResult>() {
@Override
public void onSuccess(ListObjectsRequest request, ListObjectsResult result) {
for (OSSObjectSummary objectSummary : result.getObjectSummaries()) {
Log.i("ListObjects", objectSummary.getKey());
}
}
@Override
public void onFailure(ListObjectsRequest request, ClientException clientException, ServiceException serviceException) {
// 請求異常。
if (clientException != null) {
// 客戶端異常,例如網絡異常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服務端異常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
分頁列舉所有文件
以下代碼用于分頁列舉examplebucket中的所有文件,每頁最多返回20個文件。
private String marker = null;
private boolean isCompleted = false;
// 分頁列舉所有object。
public void getAllObject() {
do {
OSSAsyncTask task = getObjectList();
// 阻塞等待請求完成獲取NextMarker,請求下一頁時需要將請求的marker設置為上一頁請求返回的NextMarker。第一頁無需設置。
// 示例中通過循環(huán)分頁列舉數據,因此需要阻塞等待請求完成獲取NextMarker才能請求下一頁數據,實際使用時可根據實際場景判斷是否需要阻塞。
task.waitUntilFinished();
} while (!isCompleted);
}
// 列舉一頁文件。
public OSSAsyncTask getObjectList() {
// 填寫B(tài)ucket名稱。
ListObjectsRequest request = new ListObjectsRequest("examplebucket");
// 填寫每頁返回文件的最大個數。如果不設置此參數,則默認值為100,maxkeys的取值不能大于1000。
request.setMaxKeys(20);
request.setMarker(marker);
OSSAsyncTask task = oss.asyncListObjects(request, new OSSCompletedCallback<ListObjectsRequest, ListObjectsResult>() {
@Override
public void onSuccess(ListObjectsRequest request, ListObjectsResult result) {
for (OSSObjectSummary objectSummary : result.getObjectSummaries()) {
Log.i("ListObjects", objectSummary.getKey());
}
// 最后一頁。
if (!result.isTruncated()) {
isCompleted = true;
return;
}
// 下一次列舉文件的marker。
marker = result.getNextMarker();
}
@Override
public void onFailure(ListObjectsRequest request, ClientException clientException, ServiceException serviceException) {
isCompleted = true;
// 請求異常。
if (clientException != null) {
// 客戶端異常,例如網絡異常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服務端異常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
return task;
}
分頁列舉指定前綴的文件
以下代碼用于分頁列舉examplebucket中以file為前綴的文件,每頁最多返回20個文件。
private String marker = null;
private boolean isCompleted = false;
// 分頁列舉所有文件。
public void getAllObject() {
do {
OSSAsyncTask task = getObjectList();
// 阻塞等待請求完成獲取NextMarker,請求下一頁時需要將請求的marker設置為上一頁請求返回的NextMarker。第一頁無需設置。
// 示例中通過循環(huán)分頁列舉數據,因此需要阻塞等待請求完成獲取NextMarker才能請求下一頁數據,實際使用時可根據實際場景判斷是否需要阻塞。
task.waitUntilFinished();
} while (!isCompleted);
}
// 列舉一頁文件。
public OSSAsyncTask getObjectList() {
// 填寫B(tài)ucket名稱。
ListObjectsRequest request = new ListObjectsRequest("examplebucket");
// 填寫每頁返回文件的最大個數。如果不設置此參數,則默認值為100,maxkeys的取值不能大于1000。
request.setMaxKeys(20);
// 填寫前綴。
// 前綴為模糊匹配,查詢結果為名稱是<輸入參數>+*的文件,如果輸入a將返回所有以a為前綴的文件,例如abc.txt,abcd.jpg。
request.setPrefix("file");
request.setMarker(marker);
OSSAsyncTask task = oss.asyncListObjects(request, new OSSCompletedCallback<ListObjectsRequest, ListObjectsResult>() {
@Override
public void onSuccess(ListObjectsRequest request, ListObjectsResult result) {
for (OSSObjectSummary objectSummary : result.getObjectSummaries()) {
Log.i("ListObjects", objectSummary.getKey());
}
// 最后一頁。
if (!result.isTruncated()) {
isCompleted = true;
return;
}
// 下一次列舉文件的marker。
marker = result.getNextMarker();
}
@Override
public void onFailure(ListObjectsRequest request, ClientException clientException, ServiceException serviceException) {
isCompleted = true;
// 請求異常。
if (clientException != null) {
// 客戶端異常,例如網絡異常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服務端異常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
return task;
}
列舉名稱包含特殊字符的文件
如果文件名稱包含以下特殊字符,需要進行編碼傳輸。OSS目前僅支持URL編碼。
單引號(' ')
雙引號(" ")
and符號(&)
尖括號(< >)
頓號(、)
中文
以下代碼用于列舉examplebucket中名稱包含特殊字符的文件。
// 填寫B(tài)ucket名稱,例如examplebucket。
ListObjectsRequest request = new ListObjectsRequest("examplebucket");
// 指定文件名稱編碼。
request.setEncodingType("url");
oss.asyncListObjects(request, new OSSCompletedCallback<ListObjectsRequest, ListObjectsResult>() {
@Override
public void onSuccess(ListObjectsRequest request, ListObjectsResult result) {
for (OSSObjectSummary objectSummary : result.getObjectSummaries()) {
Log.i("ListObjects", URLDecoder.decode(objectSummary.getKey(), "UTF-8"));
}
}
@Override
public void onFailure(ListObjectsRequest request, ClientException clientException, ServiceException serviceException) {
// 請求異常。
if (clientException != null) {
// 客戶端異常,例如網絡異常等。
clientException.printStackTrace();
}
if (serviceException != null) {
// 服務端異常。
Log.e("ErrorCode", serviceException.getErrorCode());
Log.e("RequestId", serviceException.getRequestId());
Log.e("HostId", serviceException.getHostId());
Log.e("RawMessage", serviceException.getRawMessage());
}
}
});
相關文檔
關于列舉文件的API接口說明,請參見GetBucket (ListObjects)和ListObjectsV2(GetBucketV2)。
關于初始化OSSClient,請參見如何初始化Android端OSSClient實例。
文檔內容是否對您有幫助?