دانلود فایل ها با Cloud Storage در اندروید

Cloud Storage for Firebase به شما امکان می‌دهد تا به سرعت و به راحتی فایل‌ها را از یک مخزن Cloud Storage که توسط فایربیس ارائه و مدیریت می‌شود، دانلود کنید.

ایجاد یک مرجع

برای دانلود یک فایل، ابتدا یک مرجع Cloud Storage برای فایلی که می‌خواهید دانلود کنید ایجاد کنید .

شما می‌توانید با اضافه کردن مسیرهای فرزند به ریشه‌ی مخزن Cloud Storage خود، یک مرجع ایجاد کنید، یا می‌توانید از یک آدرس اینترنتی 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");

دانلود فایل‌ها

وقتی مرجع را داشته باشید، می‌توانید با فراخوانی getBytes() یا getStream() فایل‌ها را از Cloud Storage دانلود کنید. اگر ترجیح می‌دهید فایل را با کتابخانه دیگری دانلود کنید، می‌توانید با getDownloadUrl() یک URL دانلود دریافت کنید.

دانلود در حافظه

با استفاده از متد getBytes() فایل را به byte[] دانلود کنید. این ساده‌ترین راه برای دانلود یک فایل است، اما باید کل محتوای فایل شما را در حافظه بارگذاری کند. اگر فایلی بزرگتر از حافظه موجود برنامه خود درخواست کنید، برنامه شما از کار می‌افتد. برای محافظت در برابر مشکلات حافظه، 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 برای اشتراک‌گذاری داشته باشید، می‌توانید با فراخوانی متد getDownloadUrl() در یک مرجع Cloud Storage URL دانلود یک فایل را دریافت کنید.

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 اتصالات بومی موبایل ساده، قابل تنظیم و آماده برای تولید را فراهم می‌کند تا کدهای تکراری را حذف کرده و بهترین شیوه‌های گوگل را ترویج دهد. با استفاده از FirebaseUI می‌توانید با استفاده از ادغام ما با Glide، تصاویر را به سرعت و به راحتی از Cloud Storage دانلود، ذخیره و نمایش دهید.

ابتدا، 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);

مدیریت تغییرات چرخه حیات فعالیت

دانلودها حتی پس از تغییرات چرخه حیات اکتیویتی (مانند نمایش یک دیالوگ یا چرخش صفحه) در پس‌زمینه ادامه می‌یابند. هر شنونده‌ای که پیوست کرده‌اید نیز همچنان پیوست باقی خواهد ماند. اگر پس از توقف اکتیویتی فراخوانی شوند، این امر می‌تواند منجر به نتایج غیرمنتظره‌ای شود.

شما می‌توانید این مشکل را با مشترک کردن شنونده‌های خود با یک محدوده فعالیت حل کنید تا هنگام توقف فعالیت، به‌طور خودکار آنها را لغو ثبت کنید. سپس، هنگام راه‌اندازی مجدد فعالیت، از متد 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 ذخیره شده‌اند را دریافت و به‌روزرسانی کنید .