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

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

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

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

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

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",
)
StorageActivity.kt

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");
StorageActivity.java

הורדת קבצים

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

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

מורידים את הקובץ ל-byte[] באמצעות ה-method‏ 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
}
StorageActivity.kt

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
    }
});
StorageActivity.java

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

השיטה 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
}
StorageActivity.kt

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
    }
});
StorageActivity.java

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

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

אם כבר יש לכם תשתית להורדות שמבוססת על כתובות URL, או שאתם פשוט רוצים כתובת URL לשיתוף, אתם יכולים לקבל את כתובת ה-URL להורדה של קובץ על ידי קריאה לשיטה 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
}
StorageActivity.kt

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
    }
});
StorageActivity.java

הורדת תמונות באמצעות FirebaseUI

‫FirebaseUI מספקת קשירות מקומיות פשוטות, ניתנות להתאמה אישית ומוכנות לייצור לנייד, כדי לבטל קוד חוזר ולקדם שיטות מומלצות של 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)
FirebaseUIActivity.kt

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);
FirebaseUIActivity.java

טיפול בשינויים במחזור החיים של פעילות

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

כדי לפתור את הבעיה הזו, צריך לרשום את המאזינים עם היקף פעילות כדי לבטל את הרישום שלהם באופן אוטומטי כשהפעילות מפסיקה. לאחר מכן, משתמשים בשיטה 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!
            // ...
        }
    }
}
DownloadActivity.kt

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!
                // ...
            }
        });
    }
}
DownloadActivity.java

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

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

דוגמה מלאה

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

Kotlin

storageRef.child("users/me/profile.png").getBytes(Long.MAX_VALUE).addOnSuccessListener {
    // Use the bytes to display the image
}.addOnFailureListener {
    // Handle any errors
}
StorageActivity.kt

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
    }
});
StorageActivity.java

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