如何通過Android SDK列舉Bucket下的檔案 - Object Storage Service

本文介紹如何列舉儲存空間下（Bucket）中的所有檔案（Object）、指定個數的檔案、指定首碼的檔案等。

注意事項

使用本文樣本前您需要先通過自訂網域名、STS等方式建立OSSClient，具體請參見如何初始化Android端OSSClient執行個體。

列舉指定個數的檔案

以下代碼用於列舉examplebucket中最多20個檔案。

// 填寫Bucket名稱，例如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為首碼的檔案。

// 填寫Bucket名稱，例如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之後的檔案。

// 填寫Bucket名稱，例如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。第一頁無需設定。
        // 樣本中通過迴圈分頁列舉資料，因此需要阻塞等待請求完成擷取NextMarker才能請求下一頁資料，實際使用時可根據實際情境判斷是否需要阻塞。
        task.waitUntilFinished();
    } while (!isCompleted);
}

// 列舉一頁檔案。
public OSSAsyncTask getObjectList() {
    // 填寫Bucket名稱。
    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。第一頁無需設定。
        // 樣本中通過迴圈分頁列舉資料，因此需要阻塞等待請求完成擷取NextMarker才能請求下一頁資料，實際使用時可根據實際情境判斷是否需要阻塞。
        task.waitUntilFinished();
    } while (!isCompleted);
}

// 列舉一頁檔案。
public OSSAsyncTask getObjectList() {
    // 填寫Bucket名稱。
    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中名稱包含特殊字元的檔案。

// 填寫Bucket名稱，例如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());
        }
    }
});

Object Storage Service：Android列舉檔案