Przesyłanie plików do Cloud Storage w Flutter

Cloud Storage dla Firebase umożliwia szybkie i łatwe przesyłanie plików do zasobnika Cloud Storage udostępnianego i zarządzanego przez Firebase.

Przesyłanie plików

Aby przesłać plik do Cloud Storage, najpierw utwórz odwołanie do pełnej ścieżki pliku, w tym do jego nazwy.

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

Po utworzeniu odpowiedniego odwołania wywołaj metodę putFile(), putString() lub putData(), aby przesłać plik do Cloud Storage.

Nie możesz przesyłać danych z odwołaniem do katalogu głównego zasobnika Cloud Storage. Plik referencyjny musi wskazywać adres URL elementu podrzędnego.

Przesyłanie z pliku

Aby przesłać plik, musisz najpierw uzyskać ścieżkę bezwzględną do jego lokalizacji na urządzeniu. Jeśli na przykład plik znajduje się w katalogu dokumentów aplikacji, użyj oficjalnego pakietu path_provider, aby wygenerować ścieżkę do pliku i przekazać ją do 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) {
  // ...
}

Przesyłanie z ciągu znaków

Możesz przesłać dane jako nieprzetworzony ciąg znaków zakodowany w formacie base64, base64url lub data_url, używając metody putString(). Aby na przykład przesłać ciąg tekstowy zakodowany jako adres URL danych:

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

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

Przesyłanie nieprzetworzonych danych

Możesz przesyłać dane o niższym poziomie typowania w formie Uint8List, gdy przesyłanie ciągu znaków lub File jest niepraktyczne. W takim przypadku wywołaj metodę putData(), podając swoje dane:

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

Pobieranie adresu URL do pobrania

Po przesłaniu pliku możesz uzyskać adres URL, aby go pobrać, wywołując metodę getDownloadUrl() w Reference:

await mountainsRef.getDownloadURL();

Dodaj metadane pliku

Podczas przesyłania plików możesz też dołączyć metadane. Te metadane zawierają typowe właściwości metadanych pliku, takie jak contentType (powszechnie nazywany typem MIME). Metoda putFile() automatycznie wnioskuje typ MIME z rozszerzenia File, ale możesz zastąpić automatycznie wykryty typ, określając contentType w metadanych. Jeśli nie podasz wartości contentType, a Cloud Storage nie będzie w stanie określić domyślnej wartości na podstawie rozszerzenia pliku, Cloud Storage użyje wartości application/octet-stream. Zobacz Używanie metadanych pliku.

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

Zarządzaj przesyłaniem

Oprócz rozpoczynania przesyłania możesz je wstrzymywać, wznawiać i anulować za pomocą metod pause(), resume() i cancel(). Zdarzenia wstrzymania i wznowienia powodują odpowiednio zmiany stanu pause i progress. Anulowanie przesyłania powoduje, że przesyłanie kończy się niepowodzeniem i wyświetla się błąd informujący o anulowaniu przesyłania.

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

Monitorowanie postępu przesyłania

Możesz nasłuchiwać strumienia zdarzeń zadania, aby obsługiwać powodzenie, niepowodzenie, postęp lub przerwy w zadaniu przesyłania:

Typ zdarzenia Typowe zastosowanie
TaskState.running Emitowane okresowo podczas przesyłania danych. Można ich używać do wypełniania wskaźnika przesyłania/pobierania.
TaskState.paused Emitowane za każdym razem, gdy zadanie jest wstrzymane.
TaskState.success Emitowane po pomyślnym zakończeniu zadania.
TaskState.canceled Emitowane za każdym razem, gdy zadanie zostanie anulowane.
TaskState.error Emitowane, gdy przesyłanie się nie powiedzie. Może się tak zdarzyć z powodu przerw w dostępie do sieci, błędów autoryzacji lub anulowania zadania. 
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;
  }
});

Obsługa błędów

Błędy podczas przesyłania mogą wystąpić z różnych powodów, np. gdy plik lokalny nie istnieje lub użytkownik nie ma uprawnień do przesłania danego pliku. Więcej informacji o błędach znajdziesz w sekcji Obsługa błędów w dokumentacji.

Pełny przykład

Poniżej znajdziesz pełny przykład przesyłania z monitorowaniem postępów i obsługą błędów:

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

Teraz, gdy pliki zostały przesłane, dowiedz się, jak pobrać je z Cloud Storage.