檔案會儲存在 Cloud Storage 值區中。這個值區中的檔案會以階層結構呈現,就像本機硬碟上的檔案系統,或是 Firebase Realtime Database 中的資料。 建立檔案的參照後,應用程式就能存取該檔案。然後,您可以使用這些參照上傳或下載資料、取得或更新中繼資料,或刪除檔案。參照可以指向特定檔案,也可以指向階層中的較高層級節點。
如果您使用過 Firebase Realtime Database,應該會覺得這些路徑非常熟悉。不過,檔案資料會儲存在 Cloud Storage 中,不會儲存在 Realtime Database 中。
可建立參照
如要上傳或下載檔案、刪除檔案,或是取得或更新中繼資料, 請先建立要操作的檔案參照。您可以將參照視為指向雲端檔案的指標。參照是輕量級物件,因此您可以視需要建立多個參照,並重複用於多項作業。
如要建立參照,請使用 getStorage()
取得 Storage 服務的執行個體,然後以該服務做為引數呼叫 ref()
。這個參照會指向 Cloud Storage 值區的根目錄。
Web
import { getStorage, ref } from "firebase/storage"; // Get a reference to the storage service, which is used to create references in your storage bucket const storage = getStorage(); // Create a storage reference from our storage service const storageRef = ref(storage);
Web
// Get a reference to the storage service, which is used to create references in your storage bucket var storage = firebase.storage(); // Create a storage reference from our storage service var storageRef = storage.ref();
您可以建立樹狀結構中較低位置的參照 (例如 'images/space.jpg'
),方法是在呼叫 ref()
時,將這個路徑做為第二個引數傳遞。
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); // Create a child reference const imagesRef = ref(storage, 'images'); // imagesRef now points to 'images' // Child references can also take paths delimited by '/' const spaceRef = ref(storage, 'images/space.jpg'); // spaceRef now points to "images/space.jpg" // imagesRef still points to "images"
Web
// Create a child reference var imagesRef = storageRef.child('images'); // imagesRef now points to 'images' // Child references can also take paths delimited by '/' var spaceRef = storageRef.child('images/space.jpg'); // spaceRef now points to "images/space.jpg" // imagesRef still points to "images"
使用參照瀏覽
您也可以使用 parent
和 root
屬性,在檔案階層中向上導覽。parent
會向上導覽一層,root
則會導覽至最上層。
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); const spaceRef = ref(storage, 'images/space.jpg'); // Parent allows us to move to the parent of a reference const imagesRef = spaceRef.parent; // imagesRef now points to 'images' // Root allows us to move all the way back to the top of our bucket const rootRef = spaceRef.root; // rootRef now points to the root
Web
// Parent allows us to move to the parent of a reference var imagesRef = spaceRef.parent; // imagesRef now points to 'images' // Root allows us to move all the way back to the top of our bucket var rootRef = spaceRef.root; // rootRef now points to the root
child()
、parent
和 root
可以多次串連,因為每個都會傳回參照。但 parent
的 root
例外狀況為 null
。
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); const spaceRef = ref(storage, 'images/space.jpg'); // References can be chained together multiple times const earthRef = ref(spaceRef.parent, 'earth.jpg'); // earthRef points to 'images/earth.jpg' // nullRef is null, since the parent of root is null const nullRef = spaceRef.root.parent;
Web
// References can be chained together multiple times var earthRef = spaceRef.parent.child('earth.jpg'); // earthRef points to 'images/earth.jpg' // nullRef is null, since the parent of root is null var nullRef = spaceRef.root.parent;
參考屬性
您可以使用 fullPath
、name
和 bucket
屬性檢查參照,進一步瞭解參照指向的檔案。這些屬性會取得檔案的完整路徑、檔案名稱,以及檔案儲存所在的值區。
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); const spaceRef = ref(storage, 'images/space.jpg'); // Reference's path is: 'images/space.jpg' // This is analogous to a file path on disk spaceRef.fullPath; // 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 where files are stored spaceRef.bucket;
Web
// Reference's path is: 'images/space.jpg' // This is analogous to a file path on disk spaceRef.fullPath; // 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 where files are stored spaceRef.bucket;
參考資料限制
參照路徑和名稱可包含按任何順序排列的有效 Unicode 字元,但須遵守特定限制,包括:
- 以 UTF-8 編碼時,
reference.fullPath
的總長度必須介於 1 到 1024 個位元組。 - 不得使用回車或換行字元。
- 請避免使用
#
、[
、]
、*
或?
,因為這些符號無法與 Firebase Realtime Database 或 gsutil 等其他工具搭配使用。
完整範例
Web
import { getStorage, ref } from "firebase/storage"; const storage = getStorage(); // Points to the root reference const storageRef = ref(storage); // Points to 'images' const imagesRef = ref(storageRef, 'images'); // Points to 'images/space.jpg' // Note that you can use variables to create child values const fileName = 'space.jpg'; const spaceRef = ref(imagesRef, fileName); // File path is 'images/space.jpg' const path = spaceRef.fullPath; // File name is 'space.jpg' const name = spaceRef.name; // Points to 'images' const imagesRefAgain = spaceRef.parent;
Web
// Points to the root reference var storageRef = firebase.storage().ref(); // Points to 'images' var imagesRef = storageRef.child('images'); // Points to 'images/space.jpg' // Note that you can use variables to create child values var fileName = 'space.jpg'; var spaceRef = imagesRef.child(fileName); // File path is 'images/space.jpg' var path = spaceRef.fullPath; // File name is 'space.jpg' var name = spaceRef.name; // Points to 'images' var imagesRef = spaceRef.parent;
接著,我們將瞭解如何將檔案上傳至 Cloud Storage。