您的檔案會儲存在 Cloud Storage 值區中。這個值區中的檔案會以階層結構呈現,就像本機硬碟上的檔案系統,或 Firebase Realtime Database 中的資料一樣。建立檔案參照後,應用程式就能取得檔案存取權。這些參照項目可用於上傳或下載資料、取得或更新中繼資料,或刪除檔案。參照可以指向特定檔案,也可以指向階層中較高層級的節點。
如果您已使用過 Firebase Realtime Database,應該對這些路徑並不陌生。不過,檔案資料會儲存在 Cloud Storage 中,而不是 Realtime Database 中。
可建立參照
建立參照以上傳、下載或刪除檔案,或是取得或更新其中繼資料。您可以將參照視為指向雲端檔案的指標。參照項目的大小輕巧,因此您可以視需要建立多個參照項目。這些作業也能重複用於多項作業。
使用 FirebaseStorage
單例例項建立參照,並呼叫其 getReference()
方法。
Kotlin+KTX
// Create a storage reference from our app var storageRef = storage.reference
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference();
接著,您可以使用現有參照的 child()
方法,建立樹狀結構中較低位置的參照,例如 "images/space.jpg"
。
Kotlin+KTX
// Create a child reference // imagesRef now points to "images" var imagesRef: StorageReference? = storageRef.child("images") // Child references can also take paths // spaceRef now points to "images/space.jpg // imagesRef still points to "images" var spaceRef = storageRef.child("images/space.jpg")
Java
// Create a child reference // imagesRef now points to "images" StorageReference imagesRef = storageRef.child("images"); // Child references can also take paths // spaceRef now points to "images/space.jpg // imagesRef still points to "images" StorageReference spaceRef = storageRef.child("images/space.jpg");
使用參照導覽
您也可以使用 getParent()
和 getRoot()
方法,在檔案階層中向上瀏覽。getParent()
會向上一層瀏覽,而 getRoot()
會一直瀏覽至頂端。
Kotlin+KTX
// parent allows us to move our reference to a parent node // imagesRef now points to 'images' imagesRef = spaceRef.parent // root allows us to move all the way back to the top of our bucket // rootRef now points to the root val rootRef = spaceRef.root
Java
// getParent allows us to move our reference to a parent node // imagesRef now points to 'images' imagesRef = spaceRef.getParent(); // getRoot allows us to move all the way back to the top of our bucket // rootRef now points to the root StorageReference rootRef = spaceRef.getRoot();
child()
、getParent()
和 getRoot()
可以連結多次,因為每個都會傳回參照。但呼叫 getRoot().getParent()
會傳回 null
。
Kotlin+KTX
// References can be chained together multiple times // earthRef points to 'images/earth.jpg' val earthRef = spaceRef.parent?.child("earth.jpg") // nullRef is null, since the parent of root is null val nullRef = spaceRef.root.parent
Java
// References can be chained together multiple times // earthRef points to 'images/earth.jpg' StorageReference earthRef = spaceRef.getParent().child("earth.jpg"); // nullRef is null, since the parent of root is null StorageReference nullRef = spaceRef.getRoot().getParent();
參照屬性
您可以使用 getPath()
、getName()
和 getBucket()
方法檢查參照,以便進一步瞭解參照所指向的檔案。這些方法會取得檔案的完整路徑、名稱和值區。
Kotlin+KTX
// Reference's path is: "images/space.jpg" // This is analogous to a file path on disk spaceRef.path // Reference's name is the last segment of the full path: "space.jpg" // This is analogous to the file name spaceRef.name // Reference's bucket is the name of the storage bucket that the files are stored in spaceRef.bucket
Java
// Reference's path is: "images/space.jpg" // This is analogous to a file path on disk spaceRef.getPath(); // Reference's name is the last segment of the full path: "space.jpg" // This is analogous to the file name spaceRef.getName(); // Reference's bucket is the name of the storage bucket that the files are stored in spaceRef.getBucket();
參考資料限制
參照路徑和名稱可包含任何有效的 Unicode 字元序列,但有以下限制:
- 如果使用 UTF-8 編碼,reference.fullPath 的總長度必須介於 1 到 1024 個位元組之間。
- 不得使用回車或換行字元。
- 請避免使用
#
、[
、]
、*
或?
,因為這些工具無法與其他工具 (例如 Firebase Realtime Database 或 gsutil) 搭配使用。
完整範例
Kotlin+KTX
// Points to the root reference storageRef = storage.reference // Points to "images" imagesRef = storageRef.child("images") // Points to "images/space.jpg" // Note that you can use variables to create child values val fileName = "space.jpg" spaceRef = imagesRef.child(fileName) // File path is "images/space.jpg" val path = spaceRef.path // File name is "space.jpg" val name = spaceRef.name // Points to "images" imagesRef = spaceRef.parent
Java
// Points to the root reference storageRef = storage.getReference(); // Points to "images" imagesRef = storageRef.child("images"); // Points to "images/space.jpg" // Note that you can use variables to create child values String fileName = "space.jpg"; spaceRef = imagesRef.child(fileName); // File path is "images/space.jpg" String path = spaceRef.getPath(); // File name is "space.jpg" String name = spaceRef.getName(); // Points to "images" imagesRef = spaceRef.getParent();
接下來,我們將說明如何上傳檔案至 Cloud Storage。