Apple platformlarında Cloud Storage ile dosyaları listeleme

Firebase için Cloud Storage, 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, Firebase Kuralları için Cloud Storage sürüm 2'yi gerektirir. Mevcut bir Firebase projeniz varsa Güvenlik Kuralları Kılavuzu'ndaki adımları izleyin.

list() Google Bulut Depolama Listesi API'sini kullanır. Firebase için Cloud Storage'da sınırlayıcı olarak / kullanıyoruz, bu da dosya sistemi anlambilimini taklit etmemize olanak tanıyor. List API, büyük, hiyerarşik Cloud Storage paketlerinde verimli bir şekilde geçiş yapılmasına olanak sağlamak için önekleri ve öğeleri ayrı ayrı döndürür. Örneğin, bir dosya /images/uid/file1 yüklerseniz,

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

Firebase SDK için Cloud Storage, ardışık iki / içeren veya /. . Örneğin, aşağıdaki nesneleri içeren bir paket düşünün:

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

Bu paketteki öğelere ilişkin liste işlemleri aşağıdaki sonuçları verecektir:

  • Kökteki liste işlemi, correctPrefix , wrongPrefix ve lonelyItem yapılan başvuruları prefixes olarak döndürür.
  • correctPrefix/ deki liste işlemi, correctPrefix/happyItem yapılan başvuruları items olarak döndürür.
  • wrongPrefix/ deki liste işlemi herhangi bir başvuru döndürmez çünkü wrongPrefix//sadItem ardışık iki / s içerir.
  • lonelyItem/ nesnesindeki liste işlemi herhangi bir başvuru döndürmez çünkü lonelyItem/ nesnesi / ile biter.

Tüm dosyaları listele

Bir dizine ilişkin tüm sonuçları getirmek için listAll(completion:) kullanabilirsiniz. Tüm sonuçlar bellekte ara belleğe alındığından, bu en iyi şekilde küçük dizinler için kullanılır. İşlem sırasında nesneler eklenir veya kaldırılırsa işlem aynı zamanda 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, çünkü listAll(completion:) tüm sonuçları bellekte arabelleğe alır.

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

Süratli

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

Amaç-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ı sayfalara ayır

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ünümü sağlar ve ek sonuçların ne zaman getirileceği konusunda kontrole izin veren bir pageToken sunar.

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 örnek, bir sonucun sayfalandırılmasını gösterir:

Süratli

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

Amaç-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ı sürüm 2'ye 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. Hatalarla ilgili daha fazla bilgiyi Hataları İşleme bölümünde bulabilirsiniz.