Importer des fichiers avec Cloud Storage pour C++

Cloud Storage for Firebase vous permet d'importer rapidement et facilement des fichiers dans un bucket Cloud Storage fourni et géré par Firebase.

Créer une référence

Pour importer un fichier, commencez par créer une référence Cloud Storage à l'emplacement dans Cloud Storage où vous souhaitez importer le fichier.

Vous pouvez créer une référence en ajoutant des chemins enfants à la racine de votre bucket Cloud Storage :

// Create a root reference
StorageReference storage_ref = storage->GetReference();

// Create a reference to "mountains.jpg"
StorageReference mountains_ref = storage_ref.Child("mountains.jpg");

// Create a reference to 'images/mountains.jpg'
StorageReference mountain_images_ref = storage_ref.Child("images/mountains.jpg");

// While the file names are the same, the references point to different files
mountains_ref.name() == mountain_images_ref.name();           // true
mountains_ref.full_path() == mountain_images_ref.full_path(); // false

Vous ne pouvez pas importer de données avec une référence à la racine de votre bucket Cloud Storage. Votre référence doit pointer vers une URL enfant.

Importer des fichiers

Une fois que vous avez une référence, vous pouvez importer des fichiers dans Cloud Storage de deux manières :

  1. Importer à partir d'un tampon d'octets en mémoire
  2. Importer à partir d'un chemin d'accès représentant un fichier sur l'appareil

Importer des données en mémoire

La méthode PutData() est le moyen le plus simple d'importer un fichier dans Cloud Storage. PutData() accepte un tampon d'octets et renvoie un Future<Metadata> qui contiendra des informations sur le fichier une fois l'opération Future terminée. Vous pouvez utiliser un Controller pour gérer votre import et surveiller son état.

// Data in memory
const size_t kByteBufferSize = ...
uint8_t byte_buffer[kByteBufferSize] = { ... };

// Create a reference to the file you want to upload
StorageReference rivers_ref = storage_ref.Child("images/rivers.jpg");

// Upload the file to the path "images/rivers.jpg"
Future future = rivers_ref.PutBytes(byte_buffer, kByteBufferSize);

La requête a été effectuée, mais nous devons attendre que l'avenir se réalise avant que le fichier ne soit importé. Étant donné que les jeux s'exécutent généralement en boucle et sont moins axés sur les rappels que les autres applications, vous devez généralement interroger pour savoir si l'opération est terminée.

if (future.status() != firebase::kFutureStatusPending) {
  if (future.status() != firebase::kFutureStatusComplete) {
    LogMessage("ERROR: GetData() returned an invalid future.");
    // Handle the error...
  } else if (future.Error() != firebase::storage::kErrorNone) {
    LogMessage("ERROR: GetData() returned error %d: %s", future.Error(),
               future.error_message());
    // Handle the error...
    }
  } else {
    // Metadata contains file metadata such as size, content-type, and download URL.
    Metadata* metadata = future.Result();
    std::string download_url = metadata->download_url();
  }
}

Importer à partir d'un fichier local

Vous pouvez importer des fichiers locaux sur les appareils, tels que des photos et des vidéos de l'appareil photo, avec la méthode PutFile(). PutFile() prend un std::string représentant le chemin d'accès au fichier et renvoie un Future<Metadata> qui contiendra des informations sur le fichier une fois l'avenir terminé. Vous pouvez utiliser un Controller pour gérer votre import et surveiller son état.

// File located on disk
std::string local_file = ...

// Create a reference to the file you want to upload
StorageReference rivers_ref = storage_ref.Child("images/rivers.jpg");

// Upload the file to the path "images/rivers.jpg"
Future future = rivers_ref.PutFile(localFile);

// Wait for Future to complete...

if (future.Error() != firebase::storage::kErrorNone) {
  // Uh-oh, an error occurred!
} else {
  // Metadata contains file metadata such as size, content-type, and download URL.
  Metadata* metadata = future.Result();
  std::string download_url = metadata->download_url();
}

Si vous souhaitez gérer activement votre importation, vous pouvez fournir un Controller aux méthodes PutFile() ou PutBytes(). Cela vous permet d'utiliser le contrôleur pour observer l'opération d'importation en cours. Pour en savoir plus, consultez Gérer les importations.

Ajouter des métadonnées de fichier

Vous pouvez également inclure des métadonnées lorsque vous importez des fichiers. Ces métadonnées contiennent des propriétés de métadonnées de fichier typiques telles que name, size et content_type (communément appelées type MIME). La méthode PutFile() déduit automatiquement le type de contenu à partir de l'extension du nom de fichier, mais vous pouvez remplacer le type détecté automatiquement en spécifiant content_type dans les métadonnées. Si vous ne fournissez pas de content_type et que Cloud Storage ne peut pas déduire de valeur par défaut à partir de l'extension de fichier, Cloud Storage utilise application/octet-stream. Pour en savoir plus sur les métadonnées de fichier, consultez la section Utiliser les métadonnées de fichier.

// Create storage reference
StorageReference mountains_ref = storage_ref.Child("images/mountains.jpg");

// Create file metadata including the content type
StorageMetadata metadata;
metadata.set_content_type("image/jpeg");

// Upload data and metadata
mountains_ref.PutBytes(data, metadata);

// Upload file and metadata
mountains_ref.PutFile(local_file, metadata);

Gérer les importations

En plus de démarrer des importations, vous pouvez les mettre en pause, les reprendre et les annuler à l'aide des méthodes Pause(), Resume() et Cancel() sur Controller, que vous pouvez éventuellement transmettre aux méthodes PutBytes() ou PutFile().

// Start uploading a file
firebase::storage::Controller controller;
storage_ref.Child("images/mountains.jpg").PutFile(local_file, nullptr, &controller);

// Pause the upload
controller.Pause();

// Resume the upload
controller.Resume();

// Cancel the upload
controller.Cancel();

Surveiller la progression de l'importation

Vous pouvez associer des écouteurs aux importations pour suivre leur progression.

class MyListener : public firebase::storage::Listener {
 public:
  virtual void OnProgress(firebase::storage::Controller* controller) {
    // A progress event occurred
  }
};

{
  // Start uploading a file
  MyEventListener my_listener;
  storage_ref.Child("images/mountains.jpg").PutFile(local_file, my_listener);
}

Traitement des erreurs

Plusieurs raisons peuvent expliquer les erreurs d'importation, y compris l'absence du fichier local ou le manque d'autorisation de l'utilisateur pour importer le fichier souhaité. Pour en savoir plus sur les erreurs, consultez la section Gérer les erreurs de la documentation.

Étapes suivantes

Maintenant que vous avez importé des fichiers, voyons comment les télécharger depuis Cloud Storage.