在 Android 上建立 Cloud Storage 參考資料

檔案會儲存在 Cloud Storage 值區中。這個值區中的檔案會以階層式結構呈現，與本機硬碟中的檔案系統或 Firebase 即時資料庫中的資料一樣。建立檔案的參照後，應用程式就能存取該檔案。這些參照隨後可用於上傳或下載資料、取得或更新中繼資料，或是刪除檔案。參照可以指向特定檔案，或是階層中較高層級的節點。

如果您使用過 Firebase 即時資料庫，這些路徑應該對您而言十分熟悉。然而，檔案資料會儲存在 Cloud Storage 中，「不是」儲存在即時資料庫中。

可建立參照

建立參考資料來上傳、下載或刪除檔案，或是取得或更新檔案中繼資料。參照可以視為指向雲端中檔案的指標。參照是輕量級，因此您可以建立任意數量的參照。這些 API 可重複使用於多項作業

使用 FirebaseStorage 單例模式執行個體並呼叫其 getReference() 方法建立參照。

Kotlin+KTX

// Create a storage reference from our app
var storageRef = storage.reference
StorageActivity.kt

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();
StorageActivity.java

接下來，您可以對現有參照使用 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")
StorageActivity.kt

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");
StorageActivity.java

您也可以使用 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
StorageActivity.kt

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();
StorageActivity.java

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
StorageActivity.kt

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();
StorageActivity.java

參照屬性

您可以使用 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
StorageActivity.kt

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();
StorageActivity.java

參考檔案限制

參照路徑和名稱可包含任意順序的有效 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
StorageActivity.kt

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();
StorageActivity.java

接下來，我們要說明如何上傳檔案至 Cloud Storage。