Как скачивать файлы с помощью Cloud Storage для Unity

Cloud Storage for Firebase позволяет быстро и легко скачивать файлы из корзины Cloud Storage, предоставленной и управляемой Firebase.

Создание ссылки

Чтобы скачать файл, сначала создайте ссылку Cloud Storage на него.

Вы можете создать ссылку, добавив дочерние пути к корню сегмента Cloud Storage, или создать ссылку из существующего URL-адреса gs:// или https://, ссылающегося на объект в Cloud Storage.

// 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. Скачивание по URL
2. Скачивание в массив байтов
3. Скачивание с помощью Stream
4. Скачать в локальный файл

Способ получения файлов зависит от того, как вы хотите использовать данные в игре.

Скачивание по URL

Если вы хотите использовать URL с WWW или UnityWebRequest Unity, вы можете получить URL для скачивания файла, вызвав 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!");
    }
});

Скачивание через поток

Скачивание файла с помощью Stream позволяет обрабатывать данные по мере их загрузки. Это дает вам максимальную гибкость при работе со скачиванием. Вызовите 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.