تتيح لك خدمة 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 لتنزيل ملف عن طريق استدعاء الطريقة
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 توفّر روابط بسيطة، قابلة للتخصيص وجاهزة للاستخدام في التطبيقات الأصلية للأجهزة الجوّالة، ما يزيل التعليمات البرمجية المتكرّرة ويعزّز أفضل ممارسات 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);
التعامل مع تغييرات مراحل النشاط
تستمر عمليات التنزيل في الخلفية حتى بعد تغييرات مراحل النشاط (مثل عرض مربّع حوار أو تدوير الشاشة). ستظلّ أي أدوات استماع أرفقتها مرفقة أيضًا. قد يؤدي ذلك إلى نتائج غير متوقّعة إذا تم استدعاؤها بعد إيقاف النشاط.
يمكنك حلّ هذه المشكلة عن طريق ربط أدوات الاستماع بنطاق نشاط لإلغاء تسجيلها تلقائيًا عند إيقاف النشاط. بعد ذلك، استخدِم الطريقة 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 وتعديلها.