Cloud Storage for Firebase מאפשר לכם להוריד קבצים במהירות ובקלות מקטגוריית Cloud Storage שמסופקת ומנוהלת על ידי Firebase.
יצירת קובץ עזר
כדי להוריד קובץ, קודם צריך ליצור הפניה מסוג Cloud Storage לקובץ שרוצים להוריד.
אפשר ליצור קובץ עזר על ידי הוספת נתיבי צאצא לשורש של קטגוריית Cloud Storage, או ליצור קובץ עזר מכתובת URL קיימת של gs:// או https:// שמפנה לאובייקט ב-Cloud Storage.
Kotlin
// Create a storage reference from our app val storageRef = storage.reference // Create a reference with an initial file path and name val pathReference = storageRef.child("images/stars.jpg") // Create a reference to a file from a Google Cloud Storage URI val gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg") // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! val httpsReference = storage.getReferenceFromUrl( "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg", )
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference(); // Create a reference with an initial file path and name StorageReference pathReference = storageRef.child("images/stars.jpg"); // Create a reference to a file from a Google Cloud Storage URI StorageReference gsReference = storage.getReferenceFromUrl("gs://bucket/images/stars.jpg"); // Create a reference from an HTTPS URL // Note that in the URL, characters are URL escaped! StorageReference httpsReference = storage.getReferenceFromUrl("https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg");
הורדת קבצים
אחרי שיש לכם הפניה, אתם יכולים להוריד קבצים מ-Cloud Storage באמצעות קריאה ל-getBytes() או ל-getStream(). אם אתם מעדיפים להוריד את הקובץ באמצעות ספרייה אחרת, אתם יכולים לקבל כתובת URL להורדה באמצעות getDownloadUrl().
הורדה לזיכרון
מורידים את הקובץ אל byte[] באמצעות השיטה getBytes(). זו הדרך הכי קלה להוריד קובץ, אבל היא מחייבת טעינה של כל תוכן הקובץ לזיכרון. אם תבקשו קובץ שגדול מהזיכרון הפנוי של האפליקציה, היא תקרוס. כדי למנוע בעיות בזיכרון, getBytes() מוריד כמות מקסימלית של בייטים. צריך להגדיר את הגודל המקסימלי למשהו שהאפליקציה יכולה להתמודד איתו, או להשתמש בשיטת הורדה אחרת.
Kotlin
var islandRef = storageRef.child("images/island.jpg") val ONE_MEGABYTE: Long = 1024 * 1024 islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener { // Data for "images/island.jpg" is returned, use this as needed }.addOnFailureListener { // Handle any errors }
Java
StorageReference islandRef = storageRef.child("images/island.jpg"); final long ONE_MEGABYTE = 1024 * 1024; islandRef.getBytes(ONE_MEGABYTE).addOnSuccessListener(new OnSuccessListener<byte[]>() { @Override public void onSuccess(byte[] bytes) { // Data for "images/island.jpg" is returns, use this as needed } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
הורדה לקובץ מקומי
השיטה getFile() מורידה קובץ ישירות למכשיר מקומי. השתמשו בשיטה הזו אם המשתמשים רוצים לגשת לקובץ במצב אופליין או לשתף אותו באפליקציה אחרת. getFile() מחזירה DownloadTask שבאמצעותה אפשר לנהל את ההורדה ולעקוב אחרי הסטטוס שלה.
Kotlin
islandRef = storageRef.child("images/island.jpg") val localFile = File.createTempFile("images", "jpg") islandRef.getFile(localFile).addOnSuccessListener { // Local temp file has been created }.addOnFailureListener { // Handle any errors }
Java
islandRef = storageRef.child("images/island.jpg"); File localFile = File.createTempFile("images", "jpg"); islandRef.getFile(localFile).addOnSuccessListener(new OnSuccessListener<FileDownloadTask.TaskSnapshot>() { @Override public void onSuccess(FileDownloadTask.TaskSnapshot taskSnapshot) { // Local temp file has been created } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
אם אתם רוצים לנהל את ההורדה באופן פעיל, עיינו במאמר ניהול הורדות.
הורדת נתונים באמצעות כתובת URL
אם כבר יש לכם תשתית הורדה שמבוססת על כתובות URL, או שאתם רק רוצים כתובת URL לשיתוף, אתם יכולים לקבל את כתובת ה-URL להורדה של קובץ על ידי קריאה ל-method getDownloadUrl() בהפניה של Cloud Storage.
Kotlin
storageRef.child("users/me/profile.png").downloadUrl.addOnSuccessListener { // Got the download URL for 'users/me/profile.png' }.addOnFailureListener { // Handle any errors }
Java
storageRef.child("users/me/profile.png").getDownloadUrl().addOnSuccessListener(new OnSuccessListener<Uri>() { @Override public void onSuccess(Uri uri) { // Got the download URL for 'users/me/profile.png' } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
הורדת תמונות באמצעות FirebaseUI
FirebaseUI מספק קישורים פשוטים, ניתנים להתאמה אישית ומוכנים לייצור לניידים, כדי למנוע קוד שחוזר על עצמו (boilerplate) ולקדם את השיטות המומלצות של Google. באמצעות FirebaseUI אפשר להוריד, לשמור במטמון ולהציג תמונות מ-Cloud Storage במהירות ובקלות, בעזרת השילוב שלנו עם Glide.
קודם כול, מוסיפים את FirebaseUI לקובץ app/build.gradle:
dependencies { // FirebaseUI Storage only implementation 'com.firebaseui:firebase-ui-storage:9.0.0' }
אחר כך אפשר לטעון תמונות ישירות מ-Cloud Storage אל ImageView:
Kotlin
// Reference to an image file in Cloud Storage val storageReference = Firebase.storage.reference // ImageView in your Activity val imageView = findViewById<ImageView>(R.id.imageView) // Download directly from StorageReference using Glide // (See MyAppGlideModule for Loader registration) Glide.with(context) .load(storageReference) .into(imageView)
Java
// Reference to an image file in Cloud Storage StorageReference storageReference = FirebaseStorage.getInstance().getReference(); // ImageView in your Activity ImageView imageView = findViewById(R.id.imageView); // Download directly from StorageReference using Glide // (See MyAppGlideModule for Loader registration) Glide.with(context) .load(storageReference) .into(imageView);
טיפול בשינויים במחזור החיים של פעילות
ההורדות ממשיכות ברקע גם אחרי שינויים במחזור החיים של הפעילות (כמו הצגת תיבת דו-שיח או סיבוב המסך). כל המאזינים שצירפתם יישארו מצורפים. אם הפונקציות האלה יופעלו אחרי שהפעילות תופסק, יכול להיות שהתוצאות יהיו בלתי צפויות.
כדי לפתור את הבעיה הזו, אפשר להירשם למאזינים עם היקף פעילות, כדי לבטל את הרישום שלהם באופן אוטומטי כשהפעילות נפסקת. לאחר מכן, משתמשים ב-method getActiveDownloadTasks כשהפעילות מתחילה מחדש כדי לקבל משימות הורדה שעדיין פועלות או שהושלמו לאחרונה.
בדוגמה הבאה אפשר לראות איך עושים את זה, וגם איך לשמור את נתיב ההפניה לאחסון שבו השתמשתם.
Kotlin
override fun onSaveInstanceState(outState: Bundle) { super.onSaveInstanceState(outState) // If there's a download in progress, save the reference so you can query it later outState.putString("reference", storageRef.toString()) } override fun onRestoreInstanceState(savedInstanceState: Bundle) { super.onRestoreInstanceState(savedInstanceState) // If there was a download in progress, get its reference and create a new StorageReference val stringRef = savedInstanceState.getString("reference") ?: return storageRef = Firebase.storage.getReferenceFromUrl(stringRef) // Find all DownloadTasks under this StorageReference (in this example, there should be one) val tasks = storageRef.activeDownloadTasks if (tasks.size > 0) { // Get the task monitoring the download val task = tasks[0] // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this) { // Success! // ... } } }
Java
@Override protected void onSaveInstanceState(Bundle outState) { super.onSaveInstanceState(outState); // If there's a download in progress, save the reference so you can query it later if (mStorageRef != null) { outState.putString("reference", mStorageRef.toString()); } } @Override protected void onRestoreInstanceState(Bundle savedInstanceState) { super.onRestoreInstanceState(savedInstanceState); // If there was a download in progress, get its reference and create a new StorageReference final String stringRef = savedInstanceState.getString("reference"); if (stringRef == null) { return; } mStorageRef = FirebaseStorage.getInstance().getReferenceFromUrl(stringRef); // Find all DownloadTasks under this StorageReference (in this example, there should be one) List<FileDownloadTask> tasks = mStorageRef.getActiveDownloadTasks(); if (tasks.size() > 0) { // Get the task monitoring the download FileDownloadTask task = tasks.get(0); // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this, new OnSuccessListener<FileDownloadTask.TaskSnapshot>() { @Override public void onSuccess(FileDownloadTask.TaskSnapshot state) { // Success! // ... } }); } }
טיפול בשגיאות
יכולות להיות כמה סיבות לשגיאות בהורדה, למשל: הקובץ לא קיים או שלמשתמש אין הרשאה לגשת לקובץ הרצוי. מידע נוסף על שגיאות זמין בקטע טיפול בשגיאות במסמכי התיעוד.
דוגמה מלאה
דוגמה מלאה להורדה עם טיפול בשגיאות:
Kotlin
storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener { // Use the bytes to display the image }.addOnFailureListener { // Handle any errors }
Java
storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener(new OnSuccessListener<byte[]>() { @Override public void onSuccess(byte[] bytes) { // Use the bytes to display the image } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle any errors } });
אפשר גם לקבל ולעדכן מטא-נתונים של קבצים שמאוחסנים ב-Cloud Storage.