在 Flutter 中使用 Cloud Storage 上傳檔案

Cloud Storage for Firebase 可讓您輕鬆快速地將檔案上傳至 提供 Cloud Storage 值區 並由 Firebase 管理

上傳檔案

如要將檔案上傳至 Cloud Storage,請先建立對 Cloud Storage 的參照 檔案的完整路徑,包括檔案名稱。

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

建立適當的參照後, 使用 putFile()putString()putData() 方法上傳檔案 至 Cloud Storage

您無法上傳任何參照 Cloud Storage 值區您的參照必須指向子網址。

從檔案上傳

如要上傳檔案,您必須先取得檔案在裝置上的絕對路徑 或 HTTP/HTTPS 位置例如,如果應用程式存在於應用程式的文件中 目錄,請使用官方的 path_provider 這個套件會產生檔案路徑並傳遞至 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) {
  // ...
}

從字串上傳

您可以上傳原始、base64base64urldata_url 編碼格式的資料 使用 putString() 方法建立的字串例如,如要上傳文字字串 編碼為資料網址:

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

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

上傳原始資料

您可以上傳較低層級的輸入資料,格式為 Uint8List 不適合上傳字串或 File 的情況。在本 案例中,請使用您的資料呼叫 putData() 方法:

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

取得下載網址

上傳檔案後,您可以呼叫 Reference 上的 getDownloadUrl() 方法:

await mountainsRef.getDownloadURL();

新增檔案中繼資料

您也可以在上傳檔案時加入中繼資料。 這項中繼資料包含一般檔案中繼資料屬性,例如 contentType (通常稱為 MIME 類型)。putFile() 方法 從 File 副檔名自動推論 MIME 類型,但您也可以 請在中繼資料中指定 contentType,覆寫自動偵測的類型。如果 您並未提供 contentType,且 Cloud Storage 無法推斷出 預設副檔名,而 Cloud Storage 會使用 application/octet-stream。請參閱使用檔案中繼資料

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

管理上傳項目

除了開始上傳之外,您還可以使用 pause()resume()cancel() 方法。暫停及繼續活動 可分別引發 pauseprogress 狀態變更。取消 上傳失敗並傳回錯誤 已取消上傳。

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

監控上傳進度

您可以監聽工作的事件串流,處理工作中的成功、失敗、進度或暫停 上傳工作:

事件類型 一般用量
TaskState.running 在資料傳輸過程中定期發出,可用來填入上傳/下載指標。
TaskState.paused 工作暫停時發出。
TaskState.success 工作順利完成時發出。
TaskState.canceled 工作取消時發出。
TaskState.error 上傳失敗時發出。可能的原因包括網路逾時、授權失敗或是您取消工作。
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;
  }
});

處理錯誤

導致上傳發生錯誤的原因有很多種,包括 本機檔案不存在,或使用者無權上傳 指定要上傳的檔案如要進一步瞭解錯誤,請參閱 請參閱本文件的「處理錯誤」一節。

完整範例

含有進度監控和錯誤處理機制的完整上傳示例 如下所示:

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

上傳檔案後,請參閱這篇文章,瞭解如何下載這些檔案。 從 Cloud Storage 執行