Apple platformlarında Cloud Storage ile dosyaları listeleme

Bu sayfada, Cloud Storage paketinizin içeriğini listelemek için Cloud Storage for Firebase SDK'sının nasıl kullanılacağı açıklanmaktadır. SDK, mevcut Cloud Storage referansı altındaki nesnelerin hem öğelerini hem de ön eklerini döndürür.

Liste API'sini kullanan projeler için Cloud Storage for Firebase kuralların 2. sürümü gerekir. Mevcut bir Firebase projeniz varsa Güvenlik Kuralları kılavuzundaki adımları uygulayın.

list(), Google Cloud Storage List API'yi kullanır. Cloud Storage for Firebase, dosya sistemi semantiğini taklit etmenize olanak tanıyan / ayırıcısını kullanır. List API, büyük ve hiyerarşik Cloud Storage paketlerinin verimli bir şekilde taranmasına olanak tanımak için ön ekleri ve öğeleri ayrı ayrı döndürür. Örneğin, bir dosya yüklerseniz /images/uid/file1,

  • root.child('images').listAll(), önek olarak /images/uid döndürür.
  • root.child('images/uid').listAll(), dosyayı öğe olarak döndürür.

Cloud Storage for Firebase SDK'sı, art arda iki / içeren veya /. ile biten nesne yolları döndürmez. Örneğin, aşağıdaki nesneleri içeren bir paketi ele alalım:

  • correctPrefix/happyItem
  • wrongPrefix//sadItem
  • lonelyItem/

Bu paketteki öğeler üzerinde yapılan liste işlemleri aşağıdaki sonuçları verir:

  • Kök dizindeki liste işlemi, correctPrefix, wrongPrefix ve lonelyItem referanslarını prefixes olarak döndürür.
  • correctPrefix/ adresindeki liste işlemi, correctPrefix/happyItem referanslarını items olarak döndürür.
  • wrongPrefix/ konumundaki liste işlemi, wrongPrefix//sadItem iki ardışık / içerdiğinden herhangi bir referans döndürmüyor.
  • lonelyItem/ konumundaki liste işlemi, lonelyItem/ nesnesi / ile bittiği için referans döndürmüyor.

Tüm dosyaları listeleme

Bir dizinin tüm sonuçlarını getirmek için listAll(completion:) kullanabilirsiniz. Tüm sonuçlar bellekte arabelleğe alındığından, bu yöntem küçük dizinler için en iyisidir. İşlem sırasında nesne eklenir veya kaldırılırsa işlem tutarlı bir anlık görüntü döndürmeyebilir.

Büyük bir liste için sayfalandırılmış list(withMaxResults:completion:) yöntemini kullanın. listAll(completion:), tüm sonuçları bellekte arabelleğe alır.

Aşağıdaki örnekte listAll(completion:) gösterilmektedir.

Swift

let storageReference = storage.reference().child("files/uid")
do {
  let result = try await storageReference.listAll()
  for prefix in result.prefixes {
    // The prefixes under storageReference.
    // You may call listAll(completion:) recursively on them.
  }
  for item in result.items {
    // The items under storageReference.
  }
} catch {
  // ...
}

Objective-C

FIRStorageReference *storageReference = [storage reference];
[storageReference listAllWithCompletion:^(FIRStorageListResult *result, NSError *error) {
  if (error != nil) {
    // ...
  }

  for (FIRStorageReference *prefix in result.prefixes) {
    // All the prefixes under storageReference.
    // You may call listAllWithCompletion: recursively on them.
  }
  for (FIRStorageReference *item in result.items) {
    // All items under storageReference.
  }
}];

Liste sonuçlarını sayfalara ayırma

list(withMaxResults:completion:) API'si, döndürdüğü sonuç sayısına bir sınır koyar. list(withMaxResults:completion), tutarlı bir sayfa görüntüleme sağlar ve ek sonuçların ne zaman getirileceğini kontrol etmenize olanak tanıyan bir pageToken sunar.

pageToken, önceki sonuçta döndürülen son öğenin yolunu ve sürümünü kodlar. pageToken kullanan sonraki bir istekte, pageToken'dan sonra gelen öğeler gösterilir.

Aşağıdaki örnekte bir sonucun sayfalandırılması gösterilmektedir:

Swift

func listAllPaginated(pageToken: String? = nil) async throws {
  let storage = Storage.storage()
  let storageReference = storage.reference().child("files/uid")

  let listResult: StorageListResult
  if let pageToken = pageToken {
    listResult = try await storageReference.list(maxResults: 100, pageToken: pageToken)
  } else {
    listResult = try await storageReference.list(maxResults: 100)
  }
  let prefixes = listResult.prefixes
  let items = listResult.items
  // Handle list result
  // ...

  // Process next page
  if let token = listResult.pageToken {
    try await listAllPaginated(pageToken: token)
  }
}

Objective-C

- (void)paginateFilesAtReference:(FIRStorageReference *)reference
                       pageToken:(nullable NSString *)pageToken {
  void (^pageHandler)(FIRStorageListResult *_Nonnull, NSError *_Nullable) =
      ^(FIRStorageListResult *result, NSError *error) {
        if (error != nil) {
          // ...
        }
        NSArray *prefixes = result.prefixes;
        NSArray *items = result.items;

        // ...

        // Process next page
        if (result.pageToken != nil) {
          [self paginateFilesAtReference:reference pageToken:result.pageToken];
        }
  };

  if (pageToken != nil) {
    [reference listWithMaxResults:100 pageToken:pageToken completion:pageHandler];
  } else {
    [reference listWithMaxResults:100 completion:pageHandler];
  }
}

Hata işleme

Güvenlik Kurallarınızı 2. sürüme yükseltmediyseniz liste API'sindeki yöntemler başarısız olur. Bu hatayı görürseniz güvenlik kurallarınızı yükseltin:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

Diğer olası hatalar, kullanıcının doğru izinlere sahip olmadığını gösterebilir. Hatalar hakkında daha fazla bilgi için Hataları işleme başlıklı makaleyi inceleyin.