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

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

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

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

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

// Create a reference with an initial file path and name
StorageReference path_reference = storage->GetReference("images/stars.jpg");

// Create a reference from a Cloud Storage URI
StorageReference gs_reference = storage->GetReferenceFromUrl("gs://bucket/images/stars.jpg");

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
StorageReference https_reference = storage->GetReferenceFromUrl("https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg");

הורדת קבצים

אחרי שתיצרו קובץ עזר, תוכלו להוריד קבצים מ-Cloud Storage בשלוש דרכים:

1. הורדה למאגר נתונים זמני בזיכרון
2. להוריד לנתיב ספציפי במכשיר
3. יצירת מחרוזת של כתובת URL שמייצגת את הקובץ באינטרנט

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

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

// Create a reference to the file you want to download
StorageReference island_ref = storage_ref.Child("images/island.jpg");

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
const size_t kMaxAllowedSize = 1 * 1024 * 1024
int8_t byte_buffer[kMaxAllowedSize];
firebase::Future future = island_ref.GetBytes(byte_buffer, kMaxAllowedSize);

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

// In the game loop that polls for the result...

if (future.status() != firebase::kFutureStatusPending) {
  if (future.status() != firebase::kFutureStatusComplete) {
    LogMessage("ERROR: GetBytes() returned an invalid future.");
    // Handle the error...
  } else if (future.Error() != firebase::storage::kErrorNone) {
    LogMessage("ERROR: GetBytes() returned error %d: %s", future.Error(),
               future.error_message());
    // Handle the error...
  } else {
    // byte_buffer is now populated with data for "images/island.jpg"
  }
}

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

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

// Create a reference to the file you want to download
StorageReference islandRef = storage_ref.Child("images/island.jpg"];

// Create local filesystem URL
const char* local_url = "file:///local/images/island.jpg";

// Download to the local filesystem
Future future = islandRef.GetFile(local_url);

// Wait for Future to complete...

if (future.Error() != firebase::storage::kErrorNone) {
  // Uh-oh, an error occurred!
} else {
  // The file has been downloaded to local file URL "images/island.jpg"
}

הפונקציה GetFile() מקבלת את הארגומנט האופציונלי Controller, שבעזרתו אפשר לנהל את ההורדה. מידע נוסף זמין במאמר ניהול ההורדות.

יצירת כתובת URL להורדה

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

// Create a reference to the file you want to download
StorageReference stars_ref = storage_ref.Child("images/stars.jpg");

// Fetch the download URL
firebase::Future future = stars_ref.GetDownloadUrl();

// Wait for Future to complete...

if (future.Error() != firebase::storage::kErrorNone) {
  // Uh-oh, an error occurred!
} else {
  // Get the download URL for 'images/stars.jpg'
  std::string download_url = future.Result();
}

ניהול ההורדות

בנוסף להפעלת הורדות, אפשר להשהות, להמשיך ולבטל הורדות באמצעות השיטות Pause(),‏ Resume() ו-Cancel() ב-Controller, שאפשר להעביר לשיטות GetBytes() או GetFile().

// Start downloading a file
Controller controller;
storage_ref.Child("images/mountains.jpg").GetFile(local_file, nullptr, &controller);

// Pause the download
controller.Pause();

// Resume the download
controller.Resume();

// Cancel the download
controller.Cancel();

מעקב אחר התקדמות ההורדה

אפשר לצרף מאזינים להורדות כדי לעקוב אחרי התקדמות ההורדה.

class MyListener : public firebase::storage::Listener {
 public:
  virtual void OnProgress(firebase::storage::Controller* controller) {
    // A progress event occurred
  }
};

{
  // Start uploading a file
  MyEventListener my_listener;
  storage_ref.Child("images/mountains.jpg").GetFile(local_file, my_listener);
}

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

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

השלבים הבאים

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