Elenca i file con Cloud Storage su Flutter

Cloud Storage for Firebase ti consente di elencare i contenuti del bucket Cloud Storage. Gli SDK restituiscono sia gli elementi sia i prefissi degli oggetti nel riferimento Cloud Storage corrente.

I progetti che utilizzano l'API List richiedono Cloud Storage per Firebase Rules versione 2. Se hai già un progetto Firebase, segui i passaggi descritti nella guida alle regole di sicurezza.

list() utilizza l'API Google Cloud Storage List. In Cloud Storage per Firebase, utilizziamo / come delimitatore, il che ci consente di emulare la semantica del file system. Per consentire l'attraversamento efficiente di bucket Cloud Storage di grandi dimensioni e gerarchici, l'API List restituisce prefissi ed elementi separatamente. Ad esempio, se carichi un file /images/uid/file1,

  • root.child('images').listAll() restituirà /images/uid come prefisso.
  • root.child('images/uid').listAll() restituirà il file come elemento.

L'SDK Cloud Storage per Firebase non restituisce percorsi di oggetti che contengono due / consecutivi o che terminano con un /. Ad esempio, considera un bucket con i seguenti oggetti:

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

Le operazioni di elenco sugli elementi in questo bucket daranno i seguenti risultati:

  • L'operazione di elenco nella radice restituisce i riferimenti a correctPrefix, wrongPrefix e lonelyItem come prefixes.
  • L'operazione di elenco in correctPrefix/ restituisce i riferimenti a correctPrefix/happyItem come items.
  • L'operazione di elenco in wrongPrefix/ non restituisce alcun riferimento perché wrongPrefix//sadItem contiene due / consecutivi.
  • L'operazione di elenco in lonelyItem/ non restituisce alcun riferimento perché l'oggetto lonelyItem/ termina con /.

Elenca tutti i file

Puoi utilizzare listAll per recuperare tutti i risultati per una directory. È ideale per directory di piccole dimensioni, poiché tutti i risultati vengono memorizzati nel buffer in memoria. L'operazione potrebbe anche non restituire uno snapshot coerente se gli oggetti vengono aggiunti o rimossi durante il processo.

Per un elenco di grandi dimensioni, utilizza il metodo list() paginato, poiché listAll() memorizza nel buffer tutti i risultati.

L'esempio seguente mostra 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.
}

Impagina i risultati dell'elenco

L'API list() impone un limite al numero di risultati restituiti. list() fornisce una visualizzazione di pagina coerente ed espone un pageToken che consente di controllare quando recuperare risultati aggiuntivi.

pageToken codifica il percorso e la versione dell'ultimo elemento restituito nel risultato precedente. In una richiesta successiva che utilizza pageToken, vengono mostrati gli elementi che seguono pageToken.

L'esempio seguente mostra la paginazione di un risultato:

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

Gestisci gli errori

list() e listAll() non vanno a buon fine se non hai eseguito l'upgrade delle regole di sicurezza alla versione 2. Esegui l'upgrade delle regole di sicurezza se visualizzi questo errore:

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

Altri possibili errori potrebbero indicare che l'utente non dispone dell'autorizzazione corretta. Per maggiori informazioni sugli errori, consulta la pagina Gestire gli errori.