创建 Cloud Storage 引用 (Android)

您的文件存储在 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
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 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
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。