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

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

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

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

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

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