הורדת קבצים באמצעות Cloud Storage ב-Flutter

‫Cloud Storage for Firebase מאפשר להוריד קבצים במהירות ובקלות מקטגוריה של Cloud Storage שמוקצית ומנוהלת על ידי Firebase.

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

כדי להוריד קובץ, קודם צריך ליצור הפניה ל-Cloud Storage לקובץ שרוצים להוריד.

אפשר ליצור הפניה על ידי הוספת נתיבי צאצא לשורש של קטגוריית Cloud Storage, או ליצור הפניה מכתובת URL קיימת של gs:// או https:// שמפנה לאובייקט ב-Cloud Storage.

// Create a storage reference from our app
final storageRef = FirebaseStorage.instance.ref();

// Create a reference with an initial file path and name
final pathReference = storageRef.child("images/stars.jpg");

// Create a reference to a file from a Google Cloud Storage URI
final gsReference =
    FirebaseStorage.instance.refFromURL("gs://YOUR_BUCKET/images/stars.jpg");

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
final httpsReference = FirebaseStorage.instance.refFromURL(
    "https://firebasestorage.googleapis.com/b/YOUR_BUCKET/o/images%20stars.jpg");

הורדת קבצים

אחרי שיש לכם הפניה, אתם יכולים להוריד קבצים מ-Cloud Storage על ידי קריאה ל-getData(). אם אתם מעדיפים להוריד את הקובץ עם ספרייה אחרת, אתם יכולים לקבל כתובת URL להורדה באמצעות getDownloadUrl().

הורדה בזיכרון

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

final islandRef = storageRef.child("images/island.jpg");

try {
  const oneMegabyte = 1024 * 1024;
  final Uint8List? data = await islandRef.getData(oneMegabyte);
  // Data for "images/island.jpg" is returned, use this as needed.
} on FirebaseException catch (e) {
  // Handle any errors.
}

הורדה לקובץ מקומי

השיטה writeToFile() מורידה קובץ ישירות למכשיר מקומי. משתמשים בשיטה הזו אם המשתמשים רוצים לגשת לקובץ במצב אופליין או לשתף את הקובץ באפליקציה אחרת. הפונקציה writeToFile() מחזירה DownloadTask שאפשר להשתמש בו כדי לנהל את ההורדה ולעקוב אחרי הסטטוס שלה.

final islandRef = storageRef.child("images/island.jpg");

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);

final downloadTask = islandRef.writeToFile(file);
downloadTask.snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // TODO: Handle this case.
      break;
    case TaskState.paused:
      // TODO: Handle this case.
      break;
    case TaskState.success:
      // TODO: Handle this case.
      break;
    case TaskState.canceled:
      // TODO: Handle this case.
      break;
    case TaskState.error:
      // TODO: Handle this case.
      break;
  }
});

הורדת נתונים באמצעות כתובת URL

אם כבר יש לכם תשתית להורדה שמבוססת על כתובות URL, או שאתם רק רוצים כתובת URL לשיתוף, אתם יכולים לקבל את כתובת ה-URL להורדה של קובץ על ידי קריאה לשיטה getDownloadURL() בהפניה ל-Cloud Storage.

final imageUrl =
    await storageRef.child("users/me/profile.png").getDownloadURL();

טיפול בשגיאות

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

דוגמה מלאה

דוגמה מלאה להורדה עם טיפול בשגיאות מוצגת בהמשך:

final islandRef = storageRef.child("images/island.jpg");

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);

final downloadTask = islandRef.writeToFile(file);
downloadTask.snapshotEvents.listen((taskSnapshot) {
  switch (taskSnapshot.state) {
    case TaskState.running:
      // TODO: Handle this case.
      break;
    case TaskState.paused:
      // TODO: Handle this case.
      break;
    case TaskState.success:
      // TODO: Handle this case.
      break;
    case TaskState.canceled:
      // TODO: Handle this case.
      break;
    case TaskState.error:
      // TODO: Handle this case.
      break;
  }
});

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