Lister des fichiers avec Cloud Storage sur Flutter

Cloud Storage pour Firebase vous permet de lister le contenu de votre bucket Cloud Storage. Les SDK renvoient à la fois les éléments et les préfixes des objets sous la référence Cloud Storage actuelle.

Les projets qui utilisent l'API List nécessitent Cloud Storage pour Firebase Rules version 2. Si vous disposez d'un projet Firebase existant, suivez les étapes décrites dans le guide sur les règles de sécurité.

list() utilise l' API Google Cloud Storage List. Dans Cloud Storage pour Firebase, nous utilisons / comme délimiteur, ce qui nous permet d'émuler la sémantique du système de fichiers. Pour permettre une traversée efficace des buckets Cloud Storage volumineux et hiérarchiques, l'API List renvoie les préfixes et les éléments séparément. Par exemple, si vous importez un fichier /images/uid/file1,

  • root.child('images').listAll() renvoie /images/uid comme préfixe.
  • root.child('images/uid').listAll() renvoie le fichier en tant qu'élément.

Le SDK Firebase Cloud Storage ne renvoie pas les chemins d'objet qui contiennent deux / consécutifs ou qui se terminent par un /. Prenons l'exemple d'un bucket contenant les objets suivants :

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

Les opérations de liste sur les éléments de ce bucket donnent les résultats suivants :

  • L'opération de liste à la racine renvoie les références à correctPrefix, wrongPrefix et lonelyItem en tant que prefixes.
  • L'opération de liste à correctPrefix/ renvoie les références à correctPrefix/happyItem en tant que items.
  • L'opération de liste à wrongPrefix/ ne renvoie aucune référence car wrongPrefix//sadItem contient deux / consécutifs.
  • L'opération de liste à lonelyItem/ ne renvoie aucune référence car l'objet lonelyItem/ se termine par /.

Lister tous les fichiers

Vous pouvez utiliser listAll pour récupérer tous les résultats d'un répertoire. Il est préférable de l'utiliser pour les petits répertoires, car tous les résultats sont mis en mémoire tampon. L'opération peut également ne pas renvoyer d'instantané cohérent si des objets sont ajoutés ou supprimés pendant le processus.

Pour une liste volumineuse, utilisez la méthode list() paginée, car listAll() met en mémoire tampon tous les résultats.

L'exemple suivant illustre listAll.

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.
}

Paginer les résultats d'une liste

L'API list() limite le nombre de résultats qu'elle renvoie. list() fournit une page vue cohérente et expose un pageToken qui permet de contrôler le moment où des résultats supplémentaires doivent être récupérés.

Le pageToken encode le chemin d'accès et la version du dernier élément renvoyé dans le résultat précédent. Dans une requête ultérieure utilisant le pageToken, les éléments qui suivent le pageToken sont affichés.

L'exemple suivant illustre la pagination d'un résultat :

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);
}

Gérer les erreurs

list() et listAll() échouent si vous n'avez pas mis à niveau les règles de sécurité vers la version 2. Mettez à niveau vos règles de sécurité si vous voyez cette erreur :

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

D'autres erreurs possibles peuvent indiquer que l'utilisateur ne dispose pas de l'autorisation appropriée. Pour en savoir plus sur les erreurs, consultez la page Gérer les erreurs.