Cloud Storage for Firebase 可让您快速轻松地将文件上传到 Firebase 提供和管理的 Cloud Storage 存储桶中。
创建引用
如需上传文件,请首先为要上传的文件创建一个 Cloud Storage 引用。
您可以通过将子路径附加到 Cloud Storage 存储桶的根目录来创建引用,也可以根据指向 Cloud Storage 中的对象的现有 gs://
或 https://
网址创建引用。
// 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);
您无法通过指向 Cloud Storage 存储桶根目录的引用来上传数据。您的引用必须指向一个子网址。
上传文件
有了引用之后,您可以通过两种方式将文件上传到 Cloud Storage:
- 通过内存中的某个字节型数组上传
- 通过表示设备上文件的某个文件路径上传
通过内存中的数据上传
PutBytesAsync()
方法是将文件上传到 Cloud Storage 最简单的方法。PutBytesAsync()
用 byte[] 作为参数,并返回 System.Task<Firebase.Storage.StorageMetadata>
,其中将包含当任务完成时该文件的相关信息。您可以选择使用一个 IProgress<UploadState>
(通常为 StorageProgress<UploadState>
)来监控您的上传状态。
// 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); } });
通过本地文件上传
您可以使用 PutFileAsync()
方法上传设备上的本地文件,如相机中的照片和视频。PutFileAsync()
用一个表示文件路径的 string
作为参数,并返回一个 System.Task<Firebase.Storage.StorageMetadata>
,其中将包含当任务完成时该文件的相关信息。您可以选择使用一个 IProgress<UploadState>
(通常为 StorageProgress<UploadState>
)来监控您的上传状态。
// 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); } });
如果您想主动监控上传进度,可以通过 PutFileAsync()
或 PutBytesAsync()
方法使用 StorageProgress
类(或您自己的用于实现 IProgress<UploadState>
的类)。如需了解详情,请参阅管理上传。
添加文件元数据
在上传文件时,您还可以包含元数据。这些元数据包括常见的文件元数据属性,如 Name
、Size
和 ContentType
(通常称为 MIME 类型)。PutFileAsync()
方法会自动根据文件扩展名推断内容类型,您也可以通过在元数据中指定 ContentType
来覆盖自动检测到的类型。如果您未提供 ContentType
,并且 Cloud Storage 无法根据文件扩展名推断出默认值,Cloud Storage 将使用 application/octet-stream
。如需详细了解文件元数据,请参阅使用文件元数据部分。
// 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(...
监控上传进度
您可以将侦听器附加到上传操作中,以便监控上传的进度。监听器采用标准 System.IProgress<T>
接口。您可以使用 StorageProgress
类的一个实例,提供自己的 Action<T>
作为进度完成的回调。
// 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."); } });
错误处理
导致上传时出现错误的原因有很多,包括本地文件不存在,或者用户不具备上传所需文件的权限。如需了解错误详情,请参阅相关文档的处理错误部分。
后续步骤
现在您已经上传了文件,接下来,我们将学习如何从 Cloud Storage 下载文件。