Carica file con Cloud Storage su Flutter

Cloud Storage for Firebase ti consente di caricare file in modo rapido e semplice in un bucket Cloud Storage fornito e gestito da Firebase.

Carica file

Per caricare un file in Cloud Storage, devi prima creare un riferimento al percorso completo del file, incluso il nome del file.

// Create a storage reference from our app
final storageRef = FirebaseStorage.instance.ref();

// Create a reference to "mountains.jpg"
final mountainsRef = storageRef.child("mountains.jpg");

// Create a reference to 'images/mountains.jpg'
final mountainImagesRef = storageRef.child("images/mountains.jpg");

// While the file names are the same, the references point to different files
assert(mountainsRef.name == mountainImagesRef.name);
assert(mountainsRef.fullPath != mountainImagesRef.fullPath);

Dopo aver creato un riferimento appropriato, chiama il metodo putFile(), putString() o putData() per caricare il file in Cloud Storage.

Non puoi caricare dati con un riferimento alla radice del tuo bucket Cloud Storage. Il riferimento deve rimandare a un URL secondario.

Caricare da un file

Per caricare un file, devi prima ottenere il percorso assoluto alla sua posizione sul dispositivo. Ad esempio, se un file esiste nella directory dei documenti dell'applicazione, utilizza il pacchetto ufficiale path_provider per generare un percorso del file e passarlo a putFile():

Directory appDocDir = await getApplicationDocumentsDirectory();
String filePath = '${appDocDir.absolute}/file-to-upload.png';
File file = File(filePath);

try {
  await mountainsRef.putFile(file);
} on firebase_core.FirebaseException catch (e) {
  // ...
}

Caricare da una stringa

Puoi caricare i dati come stringa non elaborata, codificata in formato base64, base64url o data_url utilizzando il metodo putString(). Ad esempio, per caricare una stringa di testo codificata come URL dati:

String dataUrl = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';

try {
  await mountainsRef.putString(dataUrl, format: PutStringFormat.dataUrl);
} on FirebaseException catch (e) {
  // ...
}

Caricamento dei dati non elaborati

Puoi caricare dati digitati di livello inferiore sotto forma di Uint8List per i casi in cui il caricamento di una stringa o di File non è pratico. In questo caso, chiama il metodo putData() con i tuoi dati:

try {
  // Upload raw data.
  await mountainsRef.putData(data);
} on firebase_core.FirebaseException catch (e) {
  // ...
}

Ottenere un URL di download

Dopo aver caricato un file, puoi ottenere un URL per scaricarlo chiamando il metodo getDownloadUrl() su Reference:

await mountainsRef.getDownloadURL();

Aggiungere metadati del file

Puoi anche includere i metadati quando carichi i file. Questi metadati contengono le proprietà tipiche dei metadati dei file, ad esempio contentType (comunemente indicato come tipo MIME). Il metodo putFile() deduce automaticamente il tipo MIME dall'estensione File, ma puoi ignorare il tipo rilevato automaticamente specificando contentType nei metadati. Se non fornisci un contentType e Cloud Storage non riesce a dedurre un valore predefinito dall'estensione del file, Cloud Storage utilizza application/octet-stream. Vedi Utilizzare i metadati dei file.

try {
  await mountainsRef.putFile(file, SettableMetadata(
    contentType: "image/jpeg",
  ));
} on firebase_core.FirebaseException catch (e) {
  // ...
}

Gestisci caricamenti

Oltre ad avviare i caricamenti, puoi metterli in pausa, riprenderli e annullarli utilizzando i metodi pause(), resume() e cancel(). Gli eventi di pausa e ripresa generano rispettivamente modifiche dello stato pause e progress. L'annullamento di un caricamento comporta l'esito negativo del caricamento con un errore che indica che il caricamento è stato annullato.

final task = mountainsRef.putFile(largeFile);

// Pause the upload.
bool paused = await task.pause();
print('paused, $paused');

// Resume the upload.
bool resumed = await task.resume();
print('resumed, $resumed');

// Cancel the upload.
bool canceled = await task.cancel();
print('canceled, $canceled');

Monitorare l'avanzamento del caricamento

Puoi ascoltare il flusso di eventi di un'attività per gestire la riuscita, l'errore, l'avanzamento o le pause nell'attività di caricamento:

Tipo di evento Utilizzo tipico
TaskState.running Emesso periodicamente durante il trasferimento dei dati e può essere utilizzato per compilare un indicatore di caricamento/download.
TaskState.paused Emesso ogni volta che l'attività viene sospesa.
TaskState.success Emesso quando l'attività è stata completata correttamente.
TaskState.canceled Emesso ogni volta che l'attività viene annullata.
TaskState.error Emesso quando il caricamento non è riuscito. Ciò può verificarsi a causa di timeout di rete, errori di autorizzazione o se annulli l'attività. 
mountainsRef.putFile(file).snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // ...
      break;
    case TaskState.paused:
      // ...
      break;
    case TaskState.success:
      // ...
      break;
    case TaskState.canceled:
      // ...
      break;
    case TaskState.error:
      // ...
      break;
  }
});

Gestione degli errori

Esistono diversi motivi per cui potrebbero verificarsi errori durante il caricamento, tra cui l'assenza del file locale o la mancanza dell'autorizzazione per caricare il file desiderato. Puoi trovare ulteriori informazioni sugli errori nella sezione Gestire gli errori della documentazione.

Esempio completo

Di seguito è riportato un esempio completo di caricamento con monitoraggio dell'avanzamento e gestione degli errori:

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/path/to/mountains.jpg";
final file = File(filePath);

// Create the file metadata
final metadata = SettableMetadata(contentType: "image/jpeg");

// Create a reference to the Firebase Storage bucket
final storageRef = FirebaseStorage.instance.ref();

// Upload file and metadata to the path 'images/mountains.jpg'
final uploadTask = storageRef
    .child("images/path/to/mountains.jpg")
    .putFile(file, metadata);

// Listen for state changes, errors, and completion of the upload.
uploadTask.snapshotEvents.listen((TaskSnapshot taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      final progress =
          100.0 * (taskSnapshot.bytesTransferred / taskSnapshot.totalBytes);
      print("Upload is $progress% complete.");
      break;
    case TaskState.paused:
      print("Upload is paused.");
      break;
    case TaskState.canceled:
      print("Upload was canceled");
      break;
    case TaskState.error:
      // Handle unsuccessful uploads
      break;
    case TaskState.success:
      // Handle successful uploads on complete
      // ...
      break;
  }
});

Ora che hai caricato i file, scopriamo come scaricarli da Cloud Storage.