Importer des fichiers avec Cloud Storage pour Unity

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 au fichier que vous souhaitez importer.

Vous pouvez créer une référence en ajoutant des chemins d'accès enfants à la racine de votre bucket Cloud Storage, ou à partir d'une URL gs:// ou https:// existante référençant 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 rediriger vers une URL enfant.

Importer des fichiers

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

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

Importer à partir de données en mémoire

La méthode PutBytesAsync() est le moyen le plus simple d'importer un fichier dans Cloud Storage. PutBytesAsync() prend un byte[] et renvoie un System.Task<Firebase.Storage.StorageMetadata> qui contient 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 importation.

// 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);
        }
    });

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, à l'aide de la méthode PutFileAsync(). PutFileAsync() utilise un 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 importation.

// 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 importation, vous pouvez utiliser une classe StorageProgress ou votre propre classe implémentant IProgress<UploadState>, avec les méthodes PutFileAsync() ou PutBytesAsync(). 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 ContentType (généralement appelées type MIME). La méthode PutFileAsync() infère automatiquement le type de contenu à partir de l'extension de 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 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 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 de l'importation

Vous pouvez associer des écouteurs aux importations afin de surveiller leur progression. L'écouteur suit l'interface System.IProgress<T> standard. Vous pouvez utiliser une instance de la classe StorageProgress pour fournir votre propre Action<T> en tant que rappel pour les "tic-tacs" 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.");
    }
});

Traitement des erreurs

Plusieurs raisons peuvent expliquer l'apparition d'erreurs lors de l'importation, par exemple si le fichier local n'existe pas ou si l'utilisateur n'est pas autorisé à 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, découvrez comment les télécharger depuis Cloud Storage.