Importer des fichiers avec Cloud Storage pour Unity

Cloud Storage pour Firebase vous permet de télécharger rapidement et facilement des fichiers vers un bucket Cloud Storage fourni et géré par Firebase.

Créer une référence

Pour télécharger un fichier, créez d'abord une référence Cloud Storage au fichier que vous souhaitez télécharger.

Vous pouvez créer une référence en ajoutant des chemins enfants à la racine de votre bucket Cloud Storage, ou vous pouvez créer une référence à partir d'une URL gs:// ou https:// existante faisant référence à un objet dans Cloud Storage.

// Create a root reference
StorageReference storageRef = storage.RootReference;

// Create a reference to "mountains.jpg"
StorageReference mountainsRef = storageRef.Child("mountains.jpg");

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

// While the file names are the same, the references point to different files
Assert.AreEqual(mountainsRef.Name, mountainImagesRef.Name);
Assert.AreNotEqual(mountainsRef.Path, mountainImagesRef.Path);

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.

Télécharger des fichiers

Une fois que vous avez une référence, vous pouvez télécharger des fichiers sur Cloud Storage de deux manières :

  1. Télécharger à partir d'un tableau d'octets en mémoire
  2. Importer à partir d'un chemin de fichier représentant un fichier sur l'appareil

Télécharger à partir de données en mémoire

La méthode PutBytesAsync() constitue le moyen le plus simple de télécharger un fichier sur Cloud Storage. PutBytesAsync() prend un octet[] et renvoie un System.Task<Firebase.Storage.StorageMetadata> qui contiendra des informations sur le fichier une fois la tâche terminée. Vous pouvez éventuellement utiliser un IProgress<UploadState> (généralement StorageProgress<UploadState> ) pour surveiller l'état de votre téléchargement.

// Data in memory
var customBytes = new byte[] {
    /*...*/
};

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

// Upload the file to the path "images/rivers.jpg"
riversRef.PutBytesAsync(customBytes)
    .ContinueWith((Task<StorageMetadata> task) => {
        if (task.IsFaulted || task.IsCanceled) {
            Debug.Log(task.Exception.ToString());
            // Uh-oh, an error occurred!
        }
        else {
            // Metadata contains file metadata such as size, content-type, and md5hash.
            StorageMetadata metadata = task.Result;
            string md5Hash = metadata.Md5Hash;
            Debug.Log("Finished uploading...");
            Debug.Log("md5 hash = " + md5Hash);
        }
    });

Télécharger à partir d'un fichier local

Vous pouvez télécharger des fichiers locaux sur les appareils, tels que des photos et des vidéos de l'appareil photo, avec la méthode PutFileAsync() . PutFileAsync() prend une string représentant le chemin d'accès au fichier et renvoie un System.Task<Firebase.Storage.StorageMetadata> qui contiendra des informations sur le fichier une fois la tâche terminée. Vous pouvez éventuellement utiliser un IProgress<UploadState> (généralement StorageProgress<UploadState> ) pour surveiller l'état de votre téléchargement.

// File located on disk
string localFile = "...";

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

// Upload the file to the path "images/rivers.jpg"
riversRef.PutFileAsync(localFile)
    .ContinueWith((Task<StorageMetadata> task) => {
        if (task.IsFaulted || task.IsCanceled) {
            Debug.Log(task.Exception.ToString());
            // Uh-oh, an error occurred!
        }
        else {
            // Metadata contains file metadata such as size, content-type, and download URL.
            StorageMetadata metadata = task.Result;
            string md5Hash = metadata.Md5Hash;
            Debug.Log("Finished uploading...");
            Debug.Log("md5 hash = " + md5Hash);
        }
    });

Si vous souhaitez surveiller activement votre téléchargement, vous pouvez utiliser une classe StorageProgress ou votre propre classe qui implémente IProgress<UploadState> , avec les méthodes PutFileAsync() ou PutBytesAsync() . Voir Gérer les téléchargements pour plus d'informations.

Ajouter des métadonnées de fichier

Vous pouvez également inclure des métadonnées lorsque vous téléchargez des fichiers. Ces métadonnées contiennent des propriétés de métadonnées de fichier typiques telles que Name , Size et ContentType (communément appelé type MIME). La méthode PutFileAsync() 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 ContentType dans les métadonnées. Si vous ne fournissez pas de ContentType et que Cloud Storage ne peut pas déduire une valeur par défaut à partir de l'extension de fichier, Cloud Storage utilise application/octet-stream . Consultez la section Utiliser les métadonnées de fichier pour plus d’informations sur les métadonnées de fichier.

// Create storage reference
StorageReference mountainsRef = storageRef.Child("images/mountains.jpg");

byte[] customBytes = new byte[] {
    /*...*/
};
string localFile = "...";

// Create file metadata including the content type
var newMetadata = new MetadataChange();
newMetadata.ContentType = "image/jpeg";

// Upload data and metadata
mountainsRef.PutBytesAsync(customBytes, newMetadata, null,
    CancellationToken.None); // .ContinueWithOnMainThread(...
// Upload file and metadata
mountainsRef.PutFileAsync(localFile, newMetadata, null,
    CancellationToken.None); // .ContinueWithOnMainThread(...

Surveiller la progression du téléchargement

Vous pouvez associer des écouteurs aux téléchargements afin de surveiller la progression du téléchargement. L'écouteur suit l'interface standard System.IProgress<T> . Vous pouvez utiliser une instance de la classe StorageProgress pour fournir votre propre Action<T> comme rappel pour les ticks de progression.

// Start uploading a file
var task = storageRef.Child("images/mountains.jpg")
    .PutFileAsync(localFile, null,
        new StorageProgress<UploadState>(state => {
            // called periodically during the upload
            Debug.Log(String.Format("Progress: {0} of {1} bytes transferred.",
                state.BytesTransferred, state.TotalByteCount));
        }), CancellationToken.None, null);

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

La gestion des erreurs

Il existe un certain nombre de raisons pour lesquelles des erreurs peuvent survenir lors du téléchargement, notamment le fait que le fichier local n'existe pas ou que l'utilisateur n'a pas l'autorisation de télécharger le fichier souhaité. Vous pouvez trouver plus d'informations sur les erreurs dans la section Gérer les erreurs de la documentation.

Prochaines étapes

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