Начало работы с облачным хранилищем на Android

Cloud Storage for Firebase позволяет загружать и публиковать пользовательский контент, например изображения и видео, что позволяет встраивать мультимедийный контент в ваши приложения. Ваши данные хранятся в корзине Google Cloud Storage — решении для хранения объектов эксабайтного масштаба с высокой доступностью и глобальной избыточностью. Cloud Storage for Firebase позволяет безопасно загружать эти файлы непосредственно с мобильных устройств и веб-браузеров, с легкостью обрабатывая нестабильные сети.

Прежде чем начать

  1. Если вы еще этого не сделали, обязательно ознакомьтесь с руководством по началу работы с приложениями для Android . Это включает в себя:

    • Создание проекта Firebase.

    • Зарегистрируйте приложение Android в проекте и подключите его к Firebase, добавив в приложение зависимости Firebase, плагин сервисов Google и файл конфигурации Firebase ( google-services.json ).

  2. Убедитесь, что ваш проект Firebase включен в тарифный план Blaze с оплатой по факту использования . Если вы новичок в Firebase и Google Cloud, проверьте, имеете ли вы право на получение кредита в размере 300 долларов США .

Создайте сегмент Cloud Storage по умолчанию.

  1. На панели навигации консоли Firebase выберите Storage .

    Если ваш проект еще не включен в тарифный план Blaze с оплатой по мере использования, вам будет предложено обновить проект.

  2. Нажмите «Начать» .

  3. Выберите местоположение для корзины по умолчанию.

  4. Настройте Firebase Security Rules для корзины по умолчанию. Во время разработки рассмотрите возможность настройки правил публичного доступа .

  5. Нажмите Готово .

Теперь вы можете просмотреть корзину на вкладке « Файлы Cloud Storage консоли Firebase . Ваш формат имени сегмента по умолчанию: PROJECT_ID .firebasestorage.app .

Настройте общий доступ

Cloud Storage for Firebase предоставляет язык декларативных правил, который позволяет вам определить, как ваши данные должны быть структурированы, как они должны индексироваться и когда ваши данные можно читать и записывать. По умолчанию доступ для чтения и записи в Cloud Storage ограничен, поэтому только прошедшие проверку подлинности пользователи могут читать и записывать данные. Чтобы начать работу без настройки Authentication , вы можете настроить свои правила для публичного доступа .

Это делает Cloud Storage открытым для всех, даже для людей, не использующих ваше приложение, поэтому обязательно снова ограничьте свое Cloud Storage при настройке аутентификации.

Добавьте SDK Cloud Storage в свое приложение

В файле Gradle вашего модуля (на уровне приложения) (обычно <project>/<app-module>/build.gradle.kts или <project>/<app-module>/build.gradle ) добавьте зависимость для Cloud Storage . библиотека для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.6.0"))

    // Add the dependency for the Cloud Storage library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-storage")
}

Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.

(Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM

Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.

Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.

dependencies {
    // Add the dependency for the Cloud Storage library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-storage:21.0.1")
}
Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).

Настройте Cloud Storage в своем приложении.

  1. Убедитесь, что файл конфигурации Firebase ( google-services.json ) в кодовой базе вашего приложения обновлен с указанием имени вашего сегмента Cloud Storage по умолчанию.

    1. Получите обновленный файл конфигурации. .

    2. Используйте этот скачанный файл конфигурации, чтобы заменить существующий файл google-services.json в каталоге модуля вашего приложения (на уровне приложения).

      Убедитесь, что в вашем приложении есть только последний загруженный файл конфигурации и что к его имени не добавлены дополнительные символы, например (2) .

  2. Получите доступ к своему сегменту Cloud Storage , создав экземпляр FirebaseStorage :

    Kotlin+KTX

    storage = Firebase.storage
    StorageActivity.kt
    // Alternatively, explicitly specify the bucket name URL.
// val storage = Firebase.storage("gs://BUCKET_NAME")

    Java

    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageActivity.java
    // Alternatively, explicitly specify the bucket name URL.
// FirebaseStorage storage = FirebaseStorage.getInstance("gs://BUCKET_NAME");

Вы готовы начать использовать Cloud Storage !

Следующий шаг? Узнайте, как создать ссылку Cloud Storage .

Расширенная настройка

Есть несколько случаев использования, которые требуют дополнительной настройки:

Первый вариант использования идеален, если у вас есть пользователи по всему миру и вы хотите хранить их данные рядом с ними. Например, вы можете создать сегменты в США, Европе и Азии для хранения данных пользователей в этих регионах, чтобы уменьшить задержку.

Второй вариант использования полезен, если у вас есть данные с разными шаблонами доступа. Например: вы можете настроить мультирегиональную или региональную корзину, в которой хранятся изображения или другой часто используемый контент, а также корзину ближней или холодной линии, в которой хранятся резервные копии пользователей или другой контент, к которому редко обращаются.

В любом из этих случаев вам понадобится использовать несколько сегментов Cloud Storage .

Третий вариант использования полезен, если вы создаете приложение, такое как Google Drive, которое позволяет пользователям иметь несколько учетных записей для входа в систему (например, личную учетную запись и рабочую учетную запись). Вы можете использовать собственный экземпляр приложения Firebase для аутентификации каждой дополнительной учетной записи.

Используйте несколько сегментов Cloud Storage

Если вы хотите использовать корзину Cloud Storage отличную от корзины по умолчанию, описанной ранее в этом руководстве, или использовать несколько корзин Cloud Storage в одном приложении, вы можете создать экземпляр FirebaseStorage , который ссылается на вашу пользовательскую корзину:

Kotlin+KTX

// Get a non-default Storage bucket
val storage = Firebase.storage("gs://my-custom-bucket")
StorageActivity.kt

Java

// Get a non-default Storage bucket
FirebaseStorage storage = FirebaseStorage.getInstance("gs://my-custom-bucket");
StorageActivity.java

Работа с импортированными сегментами

При импорте существующего сегмента Cloud Storage в Firebase вам необходимо предоставить Firebase возможность доступа к этим файлам с помощью инструмента gsutil , включенного в Google Cloud SDK :

gsutil -m acl ch -r -u service-PROJECT_NUMBER@gcp-sa-firebasestorage.iam.gserviceaccount.com gs://BUCKET_NAME

Вы можете найти номер своего проекта, как описано во введении к проектам Firebase .

Это не влияет на вновь созданные сегменты, поскольку в них по умолчанию установлен контроль доступа, разрешающий использование Firebase. Это временная мера, и в будущем она будет выполняться автоматически.

Используйте собственное приложение Firebase

Если вы создаете более сложное приложение с использованием собственного FirebaseApp , вы можете создать экземпляр FirebaseStorage инициализированный с помощью этого приложения:

Kotlin+KTX

// Get the default bucket from a custom FirebaseApp
val storage = Firebase.storage(customApp!!)

// Get a non-default bucket from a custom FirebaseApp
val customStorage = Firebase.storage(customApp, "gs://my-custom-bucket")
StorageActivity.kt

Java

// Get the default bucket from a custom FirebaseApp
FirebaseStorage storage = FirebaseStorage.getInstance(customApp);

// Get a non-default bucket from a custom FirebaseApp
FirebaseStorage customStorage = FirebaseStorage.getInstance(customApp, "gs://my-custom-bucket");
StorageActivity.java

Следующие шаги