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.

Caricare files

Per caricare un file su 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, chiami il metodo putFile() , putString() o putData() per caricare il file su Cloud Storage.

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

Carica da un file

Per caricare un file, devi prima ottenere il percorso assoluto della sua posizione sul dispositivo. Ad esempio, se esiste un file nella directory dei documenti dell'applicazione, utilizza il pacchetto ufficiale path_provider per generare un percorso di 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) {
  // ...
}

Carica da una stringa

Puoi caricare i dati come stringa codificata raw, 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 grezzi

È possibile caricare dati digitati di livello inferiore sotto forma di Uint8List per quei casi in cui il caricamento di una stringa o 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) {
  // ...
}

Ottieni un URL per il download

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

await mountainsRef.getDownloadURL();

Aggiungi metadati del file

Puoi anche includere metadati quando carichi i file. Questi metadati contengono proprietà tipiche dei metadati dei file come contentType (comunemente indicato come tipo MIME). Il metodo putFile() deduce automaticamente il tipo MIME dall'estensione File , ma puoi sovrascrivere 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 . Consulta 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 mettere in pausa, riprendere e annullare i caricamenti utilizzando i metodi pause() , resume() e cancel() . Gli eventi Pausa e Riprendi generano rispettivamente modifiche allo stato pause e progress . L'annullamento di un caricamento provoca il fallimento 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 l'esito positivo, negativo, l'avanzamento o le pause nell'attività di caricamento:

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, incluso il file locale che non esiste o l'utente che non dispone dell'autorizzazione per caricare il file desiderato. Puoi trovare ulteriori informazioni sugli errori nella sezione Gestisci 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, impariamo come scaricarli da Cloud Storage.