יצירת הפניה ל-Cloud Storage ב-Android

הקבצים מאוחסנים בקטגוריה Cloud Storage. הקבצים בקטגוריה הזו מוצגים במבנה היררכי, בדיוק כמו מערכת הקבצים בדיסק הקשיח המקומי או הנתונים ב-Firebase Realtime Database. כשיוצרים הפניה לקובץ, האפליקציה מקבלת גישה אליו. לאחר מכן אפשר להשתמש בהפניות האלה כדי להעלות או להוריד נתונים, לקבל או לעדכן מטא-נתונים או למחוק את הקובץ. הפניה יכולה להצביע על קובץ ספציפי או על צומת ברמה גבוהה יותר בהיררכיה.

אם השתמשתם ב-Firebase Realtime Database, הנתיבים האלה אמורים להיות מוכרים לכם מאוד. עם זאת, נתוני הקבצים נשמרים ב-Cloud Storage, לא ב-Realtime Database.

יצירת קובץ עזר

יוצרים קובץ עזר כדי להעלות, להוריד או למחוק קובץ, או כדי לקבל או לעדכן את המטא-נתונים שלו. אפשר לחשוב על הפניה כעל פוינטר לקובץ בענן. ההפניות הן קלילות, כך שאפשר ליצור כמה שרוצים. אפשר גם להשתמש בהם שוב במספר פעולות.

יוצרים הפניה באמצעות מופע היחיד (singleton) של 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();

לאחר מכן, אפשר ליצור הפניה למיקום נמוך יותר בעץ, למשל "images/space.jpg", באמצעות השיטה child() בהפניה קיימת.

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. האורך הכולל של reference.fullPath צריך להיות בין 1 ל-1,024 בייטים בקידוד UTF-8.
  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

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.