在 Flutter 上创建 Cloud Storage 引用

您的文件存储在 Cloud Storage 存储分区中。此存储桶中的文件以分层结构存储,就像本地硬盘中的文件系统或 Firebase Realtime Database 中的数据一样。通过创建指向文件的引用,您的应用便可以访问相应文件。然后,借助所创建的这些引用,您可以上传或下载数据、获取或更新元数据,也可以删除文件。引用可以指向特定的文件,也可以指向层次结构中更高层级的节点。

如果您使用过 Firebase Realtime Database,应当很熟悉这些路径。只不过,您的文件数据存储在 Cloud Storage 中,而不是 Realtime Database 中。

创建引用

如需上传、下载或删除文件,或者需要获取或更新文件的元数据,请创建引用。引用可以看作是指向云端文件的指针。由于引用属于轻型对象,因此您可以根据需要创建任意多个引用。 这些引用可以重复用于多个操作。

使用 FirebaseStorage 单例实例并调用其 ref() 方法创建引用。

final storageRef = FirebaseStorage.instance.ref();

接下来,您可以对现有引用使用 child() 方法,创建对树中层级较低位置(如 "images/space.jpg")的引用。

// Create a child reference
// imagesRef now points to "images"
final imagesRef = storageRef.child("images");

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
final spaceRef = storageRef.child("images/space.jpg");

您还可以使用 parentroot 属性,在我们的文件层次结构中向上导航。parent 可以向上导航一级,而 root 可以一直导航至根目录。

// parent allows us to move our reference to a parent node
// imagesRef2 now points to 'images'
final imagesRef2 = spaceRef.parent;

// root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
final rootRef = spaceRef.root;

child()parentroot 可以链接在一起并链接多次,因为每个属性都是一个引用。不过,访问 root.parent 会产生 null

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
final earthRef = spaceRef.parent?.child("earth.jpg");

// nullRef is null, since the parent of root is null
final nullRef = spaceRef.root.parent;

引用的属性

您可以检查引用的 fullPathnamebucket 属性,以便更好地了解它们指向的文件。这些属性会获取文件的完整路径、名称和存储桶。

// 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 that the files are stored in
spaceRef.bucket;

引用的限制

引用路径和名称可以包含有效 Unicode 字符的任意序列,但也必须遵循一些限制,具体包括:

  1. 使用 UTF-8 编码时,reference.fullPath 的总长度必须介于 1 到 1024 个字节之间。
  2. 不得包含回车符或换行符。
  3. 避免使用 #[]*?,因为这些字符在 Firebase Realtime Databasegsutil 等其他工具中无法正常显示。

完整示例

// Points to the root reference
final storageRef = FirebaseStorage.instance.ref();

// Points to "images"
Reference? imagesRef = storageRef.child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
final fileName = "space.jpg";
final spaceRef = imagesRef.child(fileName);

// File path is "images/space.jpg"
final path = spaceRef.fullPath;

// File name is "space.jpg"
final name = spaceRef.name;

// Points to "images"
imagesRef = spaceRef.parent;

接下来,我们将了解如何向 Cloud Storage 上传文件