Your files are stored in a Cloud Storage bucket. The files in this bucket are presented in a hierarchical structure, just like the file system on your local hard disk, or the data in the Firebase Realtime Database . By creating a reference to a file, your app gains access to it. These references can then be used to upload or download data, get or update metadata or delete the file. A reference can either point to a specific file or to a higher level node in the hierarchy.
Если вы использовали Firebase Realtime Database , эти пути должны показаться вам очень знакомыми. Однако ваши файловые данные хранятся в Cloud Storage , а не в Realtime Database .
Создать ссылку
Создайте ссылку для загрузки, скачивания или удаления файла, а также для получения или обновления его метаданных. Ссылку можно рассматривать как указатель на файл в облаке. Ссылки являются легковесными, поэтому вы можете создать столько ссылок, сколько вам нужно. Они также могут быть использованы повторно для различных операций.
Создайте ссылку, используя экземпляр синглтона FirebaseStorage и вызвав его метод getReference() .
Kotlin
// Create a storage reference from our app var storageRef = storage.reference
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference();
Далее, вы можете создать ссылку на местоположение, расположенное ниже в дереве, например, "images/space.jpg" , используя метод child() для уже существующей ссылки.
Kotlin
// 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
// 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
// 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
// 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, но на них накладываются определенные ограничения, в том числе:
- Общая длина reference.fullPath должна составлять от 1 до 1024 байт при кодировке UTF-8.
- Символы возврата каретки и перевода строки отсутствуют.
- Избегайте использования
#,[,],*или?, поскольку они плохо работают с другими инструментами, такими как Firebase Realtime Database или gsutil .
Полный пример
Kotlin
// 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();
Далее давайте узнаем, как загружать файлы в Cloud Storage .