Cloud Storage for Firebase ti consente di elencare i contenuti del tuo bucket Cloud Storage. Gli SDK restituiscono sia gli elementi che i prefissi degli oggetti nel riferimento Cloud Storage corrente.
I progetti che utilizzano l'API list richiedono Cloud Storage for Firebase Rules versione 2. Se disponi di un progetto Firebase esistente, segui i passaggi nella Guida alle regole di sicurezza .
list()
utilizza l' API Google Cloud Storage List . In Cloud Storage for Firebase utilizziamo /
come delimitatore, che ci consente di emulare la semantica del file system. Per consentire un attraversamento efficiente di bucket Cloud Storage gerarchici e di grandi dimensioni, 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 for Firebase non restituisce percorsi di oggetti che contengono due /
s consecutivi o che terminano con /.
. Ad esempio, considera un bucket che contiene i seguenti oggetti:
-
correctPrefix/happyItem
-
wrongPrefix//sadItem
-
lonelyItem/
Le operazioni di elenco sugli elementi in questo bucket forniranno i seguenti risultati:
- L'operazione list alla radice restituisce i riferimenti a
correctPrefix
,wrongPrefix
elonelyItem
comeprefixes
. - L'operazione di elenco in
correctPrefix/
restituisce i riferimenti acorrectPrefix/happyItem
comeitems
. - L'operazione di elenco su
wrongPrefix/
non restituisce alcun riferimento perchéwrongPrefix//sadItem
contiene due/
s consecutivi. - L'operazione di elenco su
lonelyItem/
non restituisce alcun riferimento perché l'oggettolonelyItem/
termina con/
.
Elenca tutti i file
Puoi utilizzare listAll(completion:)
per recuperare tutti i risultati per una directory. È meglio utilizzarlo per directory di piccole dimensioni poiché tutti i risultati vengono memorizzati nel buffer. L'operazione potrebbe inoltre non restituire uno snapshot coerente se gli oggetti vengono aggiunti o rimossi durante il processo.
Per un elenco di grandi dimensioni, utilizzare il metodo impaginato list(withMaxResults:completion:)
poiché listAll(completion:)
memorizza nel buffer tutti i risultati.
L'esempio seguente dimostra listAll(completion:)
.
Veloce
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 { // ... }
Obiettivo-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. } }];
Risultati dell'elenco di impaginazione
L' list(withMaxResults:completion:)
pone un limite al numero di risultati restituiti. list(withMaxResults:completion)
fornisce una visualizzazione di pagina coerente ed espone un pageToken che consente il controllo su quando recuperare risultati aggiuntivi.
Il pageToken codifica il percorso e la versione dell'ultimo elemento restituito nel risultato precedente. In una richiesta successiva che utilizza pageToken, vengono visualizzati gli elementi che seguono il pageToken.
L'esempio seguente mostra l'impaginazione di un risultato:
Veloce
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) } }
Obiettivo-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]; } }
Gestire gli errori
I metodi nell'API dell'elenco falliranno se non hai aggiornato le tue regole di sicurezza alla versione 2. Aggiorna le tue 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 delle autorizzazioni corrette. Ulteriori informazioni sugli errori sono disponibili in Gestire gli errori .