יצירת חומר עזר של Cloud Storage ב-Flutter

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

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

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

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

יוצרים הפניה באמצעות מופע הסינגלטון FirebaseStorage וקוראים לשיטה ref() שלו.

final storageRef = FirebaseStorage.instance.ref();

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

// 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");

אפשר גם להשתמש במאפיינים parent ו-root כדי לנווט למעלה בהיררכיית הקבצים. ‫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(),‏ parent ו-root כמה פעמים, כי כל אחד מהם הוא הפניה. אבל הגישה אל 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;

מאפייני קובץ העזר

אפשר לבדוק את ההפניות כדי להבין טוב יותר את הקבצים שהן מצביעות עליהם באמצעות המאפיינים fullPath, name ו-bucket. המאפיינים האלה מקבלים את הנתיב המלא, השם והבאקט של הקובץ.

// 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. האורך הכולל של reference.fullPath צריך להיות בין 1 ל-1,024 בייטים בקידוד UTF-8.
  2. אסור להשתמש בתו של חזרה לתחילת השורה או בתו של מעבר שורה.
  3. מומלץ להימנע משימוש בפונקציות #,‏ [,‏ ],‏ * או ?, כי הן לא פועלות טוב עם כלים אחרים כמו מסד נתונים בזמן אמת ב-Firebase או gsutil.

דוגמה מלאה

// 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.