Cloud Storage para Firebase te permite mostrar una lista del contenido de tu bucket de Cloud Storage. Los SDK muestran los elementos y los prefijos de los objetos que se encuentran en la referencia de Cloud Storage actual.
Los proyectos que usan la API de List requieren la versión 2 de las reglas de Cloud Storage para Firebase. Si tienes un proyecto de Firebase, sigue los pasos de la Guía sobre reglas de seguridad.
list() usa la API de List de Google Cloud Storage.
En Cloud Storage para Firebase, usamos / como delimitador, lo que permite emular la semántica del sistema de archivos. Para permitir un recorrido eficiente de buckets de Cloud Storage jerárquicos y de gran tamaño, la API de List muestra los prefijos y los elementos por separado. Por ejemplo, si subes un archivo /images/uid/file1, ocurrirá lo siguiente:
root.child('images').listAll()mostrará/images/uidcomo un prefijo.root.child('images/uid').listAll()mostrará el archivo como un elemento.
El SDK de Cloud Storage para Firebase no muestra las rutas de acceso a los objetos que contienen dos / consecutivos o que terminan en /. Por ejemplo, considera un bucket que tenga los siguientes objetos:
correctPrefix/happyItemwrongPrefix//sadItemlonelyItem/
Las operaciones list que se realicen sobre elementos de este bucket mostrarán los siguientes resultados:
- Las que se realicen en la raíz mostrarán las referencias a
correctPrefix,wrongPrefixylonelyItemcomoprefixes. - Las que se realicen en
correctPrefix/mostrarán las referencias acorrectPrefix/happyItemcomoitems. - Las que se realicen en
wrongPrefix/no mostrarán ninguna referencia porquewrongPrefix//sadItemcontiene dos/consecutivas. - Las que se realicen en
lonelyItem/no mostrarán ninguna referencia porque el objetolonelyItem/termina en/.
Muestra una lista de todos los archivos
Puedes usar listAll para obtener todos los resultados de un directorio.
Se recomienda usarlo con directorios pequeños, ya que los resultados se almacenan en el búfer de la memoria.
También es posible que la operación no muestre una instantánea coherente si se agregan o quitan objetos durante el proceso.
En el caso de una lista de gran tamaño, usa el método paginado list(), ya que listAll() almacena todos los resultados en el búfer de la memoria.
En el siguiente ejemplo, se muestra el funcionamiento de 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.
}
Muestra una lista paginada de resultados
La API de list() impone un límite para la cantidad de resultados que se muestran. list() proporciona una vista de página coherente y expone un pageToken que permite controlar el momento en que se deben recuperar más resultados.
El pageToken codifica la ruta de acceso y la versión del último elemento que se mostró en el resultado anterior. Si se realiza una solicitud posterior con el pageToken, se mostrarán los elementos que vienen después de él.
El siguiente ejemplo muestra la paginación de un resultado:
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);
}
Soluciona errores
Si no actualizaste las reglas de seguridad a la versión 2, list() y listAll() fallarán. Actualízalas si ves el siguiente error:
Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.
Otros errores posibles pueden indicar que el usuario no tiene el permiso adecuado. Para obtener más información sobre los errores, consulta la página Soluciona errores.