在 Android 上建立 Cloud Storage 參考

您的檔案儲存在Cloud Storage 儲存桶中。此儲存桶中的檔案以分層結構呈現,就像本機硬碟上的檔案系統或 Firebase 即時資料庫中的資料一樣。透過建立對文件的引用,您的應用程式可以存取它。然後,這些引用可用於上傳或下載資料、取得或更新元資料或刪除檔案。引用可以指向特定檔案或層次結構中的更高層級節點。

如果您使用過Firebase 即時資料庫,那麼您應該對這些路徑非常熟悉。但是,您的檔案資料儲存在 Cloud Storage 中,而不是儲存在即時資料庫中。

建立參考

建立引用以上傳、下載或刪除文件,或取得或更新其元資料。可以將引用視為指向雲端中檔案的指標。參考是輕量級的,因此您可以根據需要建立任意數量的參考。它們還可以重複用於多種操作。

使用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 字元序列,但有某些限制,包括:

  1. 當 UTF-8 編碼時,reference.fullPath 的總長度必須介於 1 到 1024 位元組之間。
  2. 沒有回車或換行字元。
  3. 避免使用#[]*? ,因為它們不能與其他工具(例如Firebase 即時資料庫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();

接下來,我們來學習如何將文件上傳到雲端儲存。