Apple platformlarında Cloud Storage ile dosyaları listeleme

Cloud Storage for Firebase, Cloud Storage paketinizin içeriğini listelemenize olanak tanır. SDK'lar, geçerli Cloud Storage referansı altındaki nesnelerin hem öğelerini hem de öneklerini döndürür.

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

list(), Google Cloud Storage List API'yi kullanır. Cloud Storage for Firebase içinde, dosya sistemi semantiğini taklit etmemize olanak tanıyan bir sınırlayıcı olarak / kullanırız. List API, büyük ve hiyerarşik Cloud Storage paketlerin verimli bir şekilde geçilmesine 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(), /images/uid değerini ön ek olarak 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ını döndürmez. Örneğin, aşağıdaki nesnelerin bulunduğu 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 öğelerine yapılan referansları prefixes olarak döndürür.
  • correctPrefix/ konumundaki liste işlemi, correctPrefix/happyItem öğesine yapılan referansları 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 herhangi bir referans döndürmüyor.

Tüm dosyaları listeleme

Bir dizindeki tüm sonuçları getirmek için listAll(completion:) kullanabilirsiniz. Tüm sonuçlar bellekte arabelleğe alındığından bu özellik en iyi şekilde küçük dizinler için kullanılır. İşlem sırasında nesneler 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, tüm sonuçları bellekte arabelleğe alan list(withMaxResults:completion:) yöntemini kullanın.listAll(completion:)

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 {
  // ...
}
ViewController.swift

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.
  }
}];
ViewController.m

Liste sonuçlarını sayfalandırma

list(withMaxResults:completion:) API, döndürdüğü sonuç sayısını sınırlar. list(withMaxResults:completion), tutarlı bir sayfa görüntüleme sağlar ve ek sonuçların ne zaman getirileceğini kontrol etmenizi sağlayan bir pageToken gösterir.

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

Aşağıdaki örnekte bir sonucun nasıl sayfalandırılacağı 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)
  }
}
ViewController.swift

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];
  }
}
ViewController.m

Hataları işleme

Güvenlik kurallarınızı 2. sürüme yükseltmediyseniz list API'deki yöntemler başarısız olur. Bu hatayı görüyorsanız 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 bilgiyi Hataları Ele Alma bölümünde bulabilirsiniz.