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

בעזרת Cloud Storage for Firebase תוכלו להוריד במהירות ובקלות קבצים מקטגוריה ב-Cloud Storage ש-Firebase מספקת ומנהלת.

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

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

כדי להוריד קובץ, קודם צריך ליצור מסמך עזר של 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() או getStream(). אם אתם מעדיפים להוריד את הקובץ עם ספרייה אחרת, תוכלו לקבל כתובת URL להורדה דרך getDownloadUrl().

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

מורידים את הקובץ ל-UInt8List באמצעות השיטה 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 להורדה של קובץ על ידי קריאה ל-method‏ 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.