Flutter'da Cloud Storage ile dosyaları listeleme

Cloud Storage for Firebase, Cloud Storage paketinizi listelemenize olanak tanır. SDK'lar, öğeleri ve mevcut Cloud Storage referansı altındaki nesnelerin ön eklerini döndürür.

List API'yi kullanan projeler için Cloud Storage for Firebase Kuralları sürüm 2 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. Firebase için Cloud Storage'da, dosya sistemi semantiğini taklit etmemize olanak tanıyan bir ayırıcı olarak / kullanırız. List API, büyük ve hiyerarşik Cloud Storage paketlerinin verimli ş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.

Firebase için Cloud Storage SDK'sı, iki ardışık / içeren veya / ile biten nesne yollarını 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 öğ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 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, list() yöntemi tüm sonuçları bellekte arabelleğe aldığından listAll() yöntemini kullanın.

Aşağıdaki örnekte listAll gösterilmektedir.

final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
  // The prefixes under storageRef.
  // You can call listAll() recursively on them.
}
for (var item in listResult.items) {
  // The items under storageRef.
}

Liste sonuçlarını sayfalandırma

list() API, döndürdüğü sonuç sayısını sınırlar. list() tutarlı bir sayfa görüntüleme sağlar ve ek sonuçların ne zaman getirileceğini kontrol etmeye 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 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:

Stream<ListResult> listAllPaginated(Reference storageRef) async* {
  String? pageToken;
  do {
    final listResult = await storageRef.list(ListOptions(
      maxResults: 100,
      pageToken: pageToken,
    ));
    yield listResult;
    pageToken = listResult.nextPageToken;
  } while (pageToken != null);
}

Hataları işleme

Güvenlik kurallarını 2. sürüme yükseltmediyseniz list() ve listAll() 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 izne sahip olmadığını gösterebilir. Hatalar hakkında daha fazla bilgiyi Hataları İşleme sayfasında bulabilirsiniz.