在 Flutter 中使用 Cloud Storage 下載檔案

透過 Cloud Storage for Firebase，您可以從 Firebase 提供及管理的 Cloud Storage 值區，快速輕鬆地下載檔案。

可建立參照

如要下載檔案，請先建立 Cloud Storage 參照，指向要下載的檔案。

您可以將子路徑附加至 Cloud Storage bucket 的根目錄，藉此建立參照，也可以從現有的 gs:// 或 https:// 網址建立參照，參照 Cloud Storage 中的物件。

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

// Create a reference with an initial file path and name
final pathReference = storageRef.child("images/stars.jpg");

// Create a reference to a file from a Google Cloud Storage URI
final gsReference =
    FirebaseStorage.instance.refFromURL("gs://YOUR_BUCKET/images/stars.jpg");

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
final httpsReference = FirebaseStorage.instance.refFromURL(
    "https://firebasestorage.googleapis.com/b/YOUR_BUCKET/o/images%20stars.jpg");

下載檔案

取得參照後，您就可以呼叫 getData()，從 Cloud Storage 下載檔案。如要使用其他程式庫下載檔案，可以透過 getDownloadUrl() 取得下載網址。

下載到記憶體

使用 getData() 方法將檔案下載至 UInt8List。這是下載檔案最簡單的方法，但必須將檔案的完整內容載入記憶體。如果要求的檔案大於應用程式的可用記憶體，應用程式就會當機。為避免記憶體問題，getData() 下載的位元組數量設有上限。將大小上限設為應用程式可處理的大小，或使用其他下載方法。

final islandRef = storageRef.child("images/island.jpg");

try {
  const oneMegabyte = 1024 * 1024;
  final Uint8List? data = await islandRef.getData(oneMegabyte);
  // Data for "images/island.jpg" is returned, use this as needed.
} on FirebaseException catch (e) {
  // Handle any errors.
}

下載至本機檔案

writeToFile() 方法會將檔案直接下載到本機裝置。如果使用者想在離線時存取檔案，或在其他應用程式中共用檔案，請使用這項功能。writeToFile() 會傳回 DownloadTask，您可以使用這個物件管理下載作業，並監控下載狀態。

final islandRef = storageRef.child("images/island.jpg");

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);

final downloadTask = islandRef.writeToFile(file);
downloadTask.snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // TODO: Handle this case.
      break;
    case TaskState.paused:
      // TODO: Handle this case.
      break;
    case TaskState.success:
      // TODO: Handle this case.
      break;
    case TaskState.canceled:
      // TODO: Handle this case.
      break;
    case TaskState.error:
      // TODO: Handle this case.
      break;
  }
});

透過網址下載資料

如果您已有以網址為基礎的下載基礎架構，或只是想分享網址，可以對 Cloud Storage 參照呼叫 getDownloadURL() 方法，取得檔案的下載網址。

final imageUrl =
    await storageRef.child("users/me/profile.png").getDownloadURL();

處理錯誤

下載時發生錯誤的原因有很多，包括檔案不存在，或是使用者沒有存取所需檔案的權限。如要進一步瞭解錯誤，請參閱文件中的「處理錯誤」一節。

完整範例

以下是包含錯誤處理機制的完整下載範例：

final islandRef = storageRef.child("images/island.jpg");

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);

final downloadTask = islandRef.writeToFile(file);
downloadTask.snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // TODO: Handle this case.
      break;
    case TaskState.paused:
      // TODO: Handle this case.
      break;
    case TaskState.success:
      // TODO: Handle this case.
      break;
    case TaskState.canceled:
      // TODO: Handle this case.
      break;
    case TaskState.error:
      // TODO: Handle this case.
      break;
  }
});

您也可以取得及更新儲存在 Cloud Storage 中的檔案中繼資料。