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 öğeleri ve nesne ön eklerinin her ikisini de döndürür.

Liste API'sini kullanan projeler için Cloud Storage for Firebase Kurallar 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 dosyasında, dosya sistemi anlamlarını taklit etmemizi sağlayan bir ayırıcı olarak / kullanılır. List API, büyük ve hiyerarşik Cloud Storage paketlerinin verimli bir şekilde geçiş yapmasını sağlamak için ön ekleri ve öğeleri ayrı olarak döndürür. Örneğin, bir dosya (/images/uid/file1) yüklerseniz

  • root.child('images').listAll(), ön ek olarak /images/uid değerini 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 öğelerle ilgili liste işlemleri aşağıdaki sonuçları verir:

  • Kökteki liste işlemi, correctPrefix, wrongPrefix ve lonelyItem referanslarını prefixes olarak döndürür.
  • correctPrefix/'teki liste işlemi, correctPrefix/happyItem'a yapılan referansları items olarak döndürür.
  • wrongPrefix//sadItem art arda iki / içerdiğinden wrongPrefix/ öğesindeki liste işlemi herhangi bir referans döndürmez.
  • lonelyItem/ nesnesi / ile sona erdiği için lonelyItem/ öğesindeki liste işlemi, hiç başvuru döndürmez.

Tüm dosyaları listeleme

Bir dizinle ilgili tüm sonuçları almak için listAll(completion:) kullanabilirsiniz. Tüm sonuçlar bellekte arabelleğe alındığından bu yöntem küçük dizinler için en iyi şekilde kullanılır. İş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 {
  // ...
}
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ı sayfalara ayırma

list(withMaxResults:completion:) API, döndürdüğü sonuçların sayısını sınırlandırır. 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 gösterir.

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

Aşağıdaki örnekte bir sonucun sayfalara bölünmesi 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 liste API'sindeki 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. Hatalarla ilgili daha fazla bilgiyi Hataları ele alma başlıklı makalede bulabilirsiniz.