使用 Unity 適用的 Cloud Storage 下載檔案

Cloud Storage for Firebase 可讓您快速輕鬆地從 Firebase 提供及管理的 Cloud Storage 儲存體下載檔案。

可建立參照

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

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

// Create a reference with an initial file path and name
StorageReference pathReference =
    storage.GetReference("images/stars.jpg");

// Create a reference from a Google Cloud Storage URI
StorageReference gsReference =
    storage.GetReferenceFromUrl("gs://bucket/images/stars.jpg");

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

下載檔案

取得參照後，您可以透過四種方式下載 Cloud Storage 中的檔案：

  1. 從網址下載
  2. 下載至位元組陣列
  3. 透過串流下載
  4. 下載至本機檔案

您用來擷取檔案的方法，取決於您要在遊戲中如何使用資料。

從網址下載

如果您想使用網址搭配 Unity 的 WWW 或 UnityWebRequest，可以呼叫 GetDownloadUrlAsync() 取得檔案的下載網址。

// Fetch the download URL
reference.GetDownloadUrlAsync().ContinueWithOnMainThread(task => {
    if (!task.IsFaulted && !task.IsCanceled) {
        Debug.Log("Download URL: " + task.Result);
        // ... now download the file via WWW or UnityWebRequest.
    }
});

下載至位元組陣列

您可以使用 GetBytesAsync() 方法，將檔案下載至記憶體中的位元組緩衝區。這個方法會將檔案的整個內容載入記憶體。如果您要求的檔案大小超過應用程式可用的記憶體，應用程式就會當機。為避免記憶體問題，請務必將最大大小設為應用程式可處理的大小，或改用其他下載方法。

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
const long maxAllowedSize = 1 * 1024 * 1024;
reference.GetBytesAsync(maxAllowedSize).ContinueWithOnMainThread(task => {
    if (task.IsFaulted || task.IsCanceled) {
        Debug.LogException(task.Exception);
        // Uh-oh, an error occurred!
    }
    else {
        byte[] fileContents = task.Result;
        Debug.Log("Finished downloading!");
    }
});

透過串流下載

使用串流下載檔案，可讓您在資料載入時進行處理。這樣一來，您就能在下載時享有最大的彈性。呼叫 GetStreamAsync()，並將您自己的串流處理器做為第一個引數傳遞。這個委派作業會在背景執行緒上使用 Stream 呼叫，讓您執行延遲密集的作業或計算，例如將內容儲存至磁碟。

// Download via a Stream
reference.GetStreamAsync(stream => {
    // Do something with the stream here.
    //
    // This code runs on a background thread which reduces the impact
    // to your framerate.
    //
    // If you want to do something on the main thread, you can do that in the
    // progress eventhandler (second argument) or ContinueWith to execute it
    // at task completion.
}, null, CancellationToken.None);

GetStreamAsync() 會在串流處理器後方接收可選的引數，讓您取消作業或接收進度通知。

下載至本機檔案

GetFileAsync() 方法會將檔案直接下載到本機裝置。如果使用者想在離線時存取檔案，或在其他應用程式中分享檔案，請使用此選項。

// Create local filesystem URL
string localUrl = "file:///local/images/island.jpg";

// Download to the local filesystem
reference.GetFileAsync(localUrl).ContinueWithOnMainThread(task => {
    if (!task.IsFaulted && !task.IsCanceled) {
        Debug.Log("File downloaded.");
    }
});

您可以將事件監聽器附加至下載作業，以便監控下載進度。監聽器遵循標準 System.IProgress<T> 介面。您可以使用 StorageProgress 類別的例項，提供自己的 Action<T> 做為進度時間點的回呼。

// Create local filesystem URL
string localUrl = "file:///local/images/island.jpg";

// Start downloading a file
Task task = reference.GetFileAsync(localFile,
    new StorageProgress<DownloadState>(state => {
        // called periodically during the download
        Debug.Log(String.Format(
            "Progress: {0} of {1} bytes transferred.",
            state.BytesTransferred,
            state.TotalByteCount
        ));
    }), CancellationToken.None);

task.ContinueWithOnMainThread(resultTask => {
    if (!resultTask.IsFaulted && !resultTask.IsCanceled) {
        Debug.Log("Download finished.");
    }
});

處理錯誤

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

後續步驟

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