يسمح لك Cloud Storage for Firebase بتحميل الملفات بسرعة وسهولة إلى مجموعة Cloud Storage التي توفرها وتديرها Firebase.
تحميل الملفات
لتحميل ملف إلى Cloud Storage، عليك أولاً إنشاء مرجع للمسار الكامل للملف، بما في ذلك اسم الملف.
Kotlin+KTX
// Create a storage reference from our app val storageRef = storage.reference // Create a reference to "mountains.jpg" val mountainsRef = storageRef.child("mountains.jpg") // Create a reference to 'images/mountains.jpg' val mountainImagesRef = storageRef.child("images/mountains.jpg") // While the file names are the same, the references point to different files mountainsRef.name == mountainImagesRef.name // true mountainsRef.path == mountainImagesRef.path // false
Java
// Create a storage reference from our app StorageReference storageRef = storage.getReference(); // Create a reference to "mountains.jpg" StorageReference mountainsRef = storageRef.child("mountains.jpg"); // Create a reference to 'images/mountains.jpg' StorageReference mountainImagesRef = storageRef.child("images/mountains.jpg"); // While the file names are the same, the references point to different files mountainsRef.getName().equals(mountainImagesRef.getName()); // true mountainsRef.getPath().equals(mountainImagesRef.getPath()); // false
بمجرد إنشاء مرجع مناسب، يمكنك بعد ذلك استدعاء الأسلوب putBytes()
أو putFile()
أو putStream()
لتحميل الملف إلى Cloud Storage.
لا يمكنك تحميل البيانات بالإشارة إلى جذر مجموعة التخزين السحابي الخاصة بك. يجب أن يشير مرجعك إلى عنوان URL فرعي.
التحميل من البيانات الموجودة في الذاكرة
تعد طريقة putBytes()
هي أبسط طريقة لتحميل ملف إلى Cloud Storage. يأخذ putBytes()
byte[]
ويعيد UploadTask
الذي يمكنك استخدامه لإدارة ومراقبة حالة التحميل.
Kotlin+KTX
// Get the data from an ImageView as bytes imageView.isDrawingCacheEnabled = true imageView.buildDrawingCache() val bitmap = (imageView.drawable as BitmapDrawable).bitmap val baos = ByteArrayOutputStream() bitmap.compress(Bitmap.CompressFormat.JPEG, 100, baos) val data = baos.toByteArray() var uploadTask = mountainsRef.putBytes(data) uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
// Get the data from an ImageView as bytes imageView.setDrawingCacheEnabled(true); imageView.buildDrawingCache(); Bitmap bitmap = ((BitmapDrawable) imageView.getDrawable()).getBitmap(); ByteArrayOutputStream baos = new ByteArrayOutputStream(); bitmap.compress(Bitmap.CompressFormat.JPEG, 100, baos); byte[] data = baos.toByteArray(); UploadTask uploadTask = mountainsRef.putBytes(data); uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
نظرًا لأن putBytes()
يقبل byte[]
، فإنه يتطلب من تطبيقك الاحتفاظ بمحتويات الملف بالكامل في الذاكرة مرة واحدة. فكر في استخدام putStream()
أو putFile()
لاستخدام ذاكرة أقل.
تحميل من دفق
تعد طريقة putStream()
هي الطريقة الأكثر تنوعًا لتحميل ملف إلى Cloud Storage. يأخذ putStream()
InputStream
ويعيد UploadTask
الذي يمكنك استخدامه لإدارة ومراقبة حالة التحميل.
Kotlin+KTX
val stream = FileInputStream(File("path/to/images/rivers.jpg")) uploadTask = mountainsRef.putStream(stream) uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
InputStream stream = new FileInputStream(new File("path/to/images/rivers.jpg")); uploadTask = mountainsRef.putStream(stream); uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
تحميل من ملف محلي
يمكنك تحميل الملفات المحلية على الجهاز، مثل الصور ومقاطع الفيديو من الكاميرا، باستخدام طريقة putFile()
. يأخذ putFile()
File
ويعيد UploadTask
الذي يمكنك استخدامه لإدارة ومراقبة حالة التحميل.
Kotlin+KTX
var file = Uri.fromFile(File("path/to/images/rivers.jpg")) val riversRef = storageRef.child("images/${file.lastPathSegment}") uploadTask = riversRef.putFile(file) // Register observers to listen for when the download is done or if it fails uploadTask.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { taskSnapshot -> // taskSnapshot.metadata contains file metadata such as size, content-type, etc. // ... }
Java
Uri file = Uri.fromFile(new File("path/to/images/rivers.jpg")); StorageReference riversRef = storageRef.child("images/"+file.getLastPathSegment()); uploadTask = riversRef.putFile(file); // Register observers to listen for when the download is done or if it fails uploadTask.addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // taskSnapshot.getMetadata() contains file metadata such as size, content-type, etc. // ... } });
احصل على عنوان URL للتنزيل
بعد تحميل ملف، يمكنك الحصول على عنوان URL لتنزيل الملف عن طريق استدعاء الأسلوب getDownloadUrl()
في StorageReference
:
Kotlin+KTX
val ref = storageRef.child("images/mountains.jpg") uploadTask = ref.putFile(file) val urlTask = uploadTask.continueWithTask { task -> if (!task.isSuccessful) { task.exception?.let { throw it } } ref.downloadUrl }.addOnCompleteListener { task -> if (task.isSuccessful) { val downloadUri = task.result } else { // Handle failures // ... } }
Java
final StorageReference ref = storageRef.child("images/mountains.jpg"); uploadTask = ref.putFile(file); Task<Uri> urlTask = uploadTask.continueWithTask(new Continuation<UploadTask.TaskSnapshot, Task<Uri>>() { @Override public Task<Uri> then(@NonNull Task<UploadTask.TaskSnapshot> task) throws Exception { if (!task.isSuccessful()) { throw task.getException(); } // Continue with the task to get the download URL return ref.getDownloadUrl(); } }).addOnCompleteListener(new OnCompleteListener<Uri>() { @Override public void onComplete(@NonNull Task<Uri> task) { if (task.isSuccessful()) { Uri downloadUri = task.getResult(); } else { // Handle failures // ... } } });
إضافة بيانات تعريف الملف
يمكنك أيضًا تضمين بيانات التعريف عند تحميل الملفات. تحتوي هذه البيانات التعريفية على خصائص بيانات تعريف الملف النموذجية مثل name
size
ونوع contentType
(يشار إليها عادةً بنوع MIME). تستنتج طريقة putFile()
تلقائيًا نوع MIME من امتداد File
، ولكن يمكنك تجاوز النوع الذي تم اكتشافه تلقائيًا عن طريق تحديد contentType
في البيانات التعريفية. إذا لم تقم بتوفير contentType
ولم يتمكن Cloud Storage من استنتاج الإعداد الافتراضي من امتداد الملف، فإن Cloud Storage يستخدم application/octet-stream
. راجع قسم استخدام بيانات تعريف الملف لمزيد من المعلومات حول بيانات تعريف الملف.
Kotlin+KTX
// Create file metadata including the content type var metadata = storageMetadata { contentType = "image/jpg" } // Upload the file and metadata uploadTask = storageRef.child("images/mountains.jpg").putFile(file, metadata)
Java
// Create file metadata including the content type StorageMetadata metadata = new StorageMetadata.Builder() .setContentType("image/jpg") .build(); // Upload the file and metadata uploadTask = storageRef.child("images/mountains.jpg").putFile(file, metadata);
إدارة التحميلات
بالإضافة إلى بدء التحميلات، يمكنك إيقاف التحميلات مؤقتًا واستئنافها وإلغائها باستخدام طرق pause()
resume()
cancel()
. يؤدي الإيقاف المؤقت واستئناف الأحداث إلى رفع تغييرات حالة الإيقاف pause
progress
على التوالي. يؤدي إلغاء التحميل إلى فشل التحميل مع ظهور خطأ يشير إلى أنه تم إلغاء التحميل.
Kotlin+KTX
uploadTask = storageRef.child("images/mountains.jpg").putFile(file) // Pause the upload uploadTask.pause() // Resume the upload uploadTask.resume() // Cancel the upload uploadTask.cancel()
Java
uploadTask = storageRef.child("images/mountains.jpg").putFile(file); // Pause the upload uploadTask.pause(); // Resume the upload uploadTask.resume(); // Cancel the upload uploadTask.cancel();
مراقبة تقدم التحميل
يمكنك إضافة مستمعين للتعامل مع النجاح أو الفشل أو التقدم أو التوقف المؤقت في مهمة التحميل الخاصة بك:
نوع المستمع | الاستخدام النموذجي |
---|---|
OnProgressListener | يتم استدعاء هذا المستمع بشكل دوري أثناء نقل البيانات ويمكن استخدامه لملء مؤشر التحميل/التنزيل. |
OnPausedListener | يتم استدعاء هذا المستمع في أي وقت يتم فيه إيقاف المهمة مؤقتًا. |
OnSuccessListener | يتم استدعاء هذا المستمع عند اكتمال المهمة بنجاح. |
OnFailureListener | يتم استدعاء هذا المستمع في أي وقت يفشل فيه التحميل. يمكن أن يحدث هذا بسبب انتهاء مهلة الشبكة، أو فشل التفويض، أو إذا قمت بإلغاء المهمة. |
يتم استدعاء OnFailureListener
باستخدام مثيل Exception
. يتم استدعاء المستمعين الآخرين باستخدام كائن UploadTask.TaskSnapshot
. هذا الكائن عبارة عن عرض غير قابل للتغيير للمهمة في وقت وقوع الحدث. يحتوي UploadTask.TaskSnapshot
على الخصائص التالية:
ملكية | يكتب | وصف |
---|---|---|
getDownloadUrl | String | عنوان URL الذي يمكن استخدامه لتنزيل الكائن. هذا عنوان URL عام لا يمكن تخمينه ويمكن مشاركته مع عملاء آخرين. تتم تعبئة هذه القيمة بمجرد اكتمال التحميل. |
getError | Exception | إذا فشلت المهمة، فسيكون هذا هو السبب كاستثناء. |
getBytesTransferred | long | إجمالي عدد البايتات التي تم نقلها عند التقاط هذه اللقطة. |
getTotalByteCount | long | إجمالي عدد البايتات المتوقع تحميلها. |
getUploadSessionUri | String | عنوان URI يمكن استخدامه لمواصلة هذه المهمة عبر استدعاء آخر لـ putFile. |
getMetadata | StorageMetadata | قبل اكتمال التحميل، هذه هي البيانات التعريفية التي يتم إرسالها إلى الخادم. بعد اكتمال التحميل، هذه هي البيانات التعريفية التي يعرضها الخادم. |
getTask | UploadTask | المهمة التي أنشأت هذه اللقطة. استخدم هذه المهمة لإلغاء التحميل أو إيقافه مؤقتًا أو استئنافه. |
getStorage | StorageReference | تم استخدام StorageReference لإنشاء UploadTask . |
توفر مستمعي أحداث UploadTask
طريقة بسيطة وقوية لمراقبة أحداث التحميل.
Kotlin+KTX
// Observe state change events such as progress, pause, and resume // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 uploadTask.addOnProgressListener { (bytesTransferred, totalByteCount) -> val progress = (100.0 * bytesTransferred) / totalByteCount Log.d(TAG, "Upload is $progress% done") }.addOnPausedListener { Log.d(TAG, "Upload is paused") }
Java
// Observe state change events such as progress, pause, and resume uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { double progress = (100.0 * taskSnapshot.getBytesTransferred()) / taskSnapshot.getTotalByteCount(); Log.d(TAG, "Upload is " + progress + "% done"); } }).addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() { @Override public void onPaused(UploadTask.TaskSnapshot taskSnapshot) { Log.d(TAG, "Upload is paused"); } });
التعامل مع تغييرات دورة حياة النشاط
تستمر التحميلات في الخلفية حتى بعد حدوث تغييرات في دورة حياة النشاط (مثل عرض مربع حوار أو تدوير الشاشة). أي مستمعين قمت بإرفاقه سيظلون مرتبطين أيضًا. قد يتسبب هذا في نتائج غير متوقعة إذا تم الاتصال بهم بعد توقف النشاط.
يمكنك حل هذه المشكلة عن طريق اشتراك المستمعين في نطاق نشاط لإلغاء تسجيلهم تلقائيًا عند توقف النشاط. بعد ذلك، استخدم طريقة getActiveUploadTasks
عند إعادة تشغيل النشاط للحصول على مهام التحميل التي لا تزال قيد التشغيل أو اكتملت مؤخرًا.
يوضح المثال أدناه هذا ويوضح أيضًا كيفية استمرار المسار المرجعي للتخزين المستخدم.
Kotlin+KTX
override fun onSaveInstanceState(outState: Bundle) { super.onSaveInstanceState(outState) // If there's an upload 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 an upload in progress, get its reference and create a new StorageReference val stringRef = savedInstanceState.getString("reference") ?: return storageRef = Firebase.storage.getReferenceFromUrl(stringRef) // Find all UploadTasks under this StorageReference (in this example, there should be one) val tasks = storageRef.activeUploadTasks if (tasks.size > 0) { // Get the task monitoring the upload 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 an upload 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 an upload 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 UploadTasks under this StorageReference (in this example, there should be one) List<UploadTask> tasks = mStorageRef.getActiveUploadTasks(); if (tasks.size() > 0) { // Get the task monitoring the upload UploadTask task = tasks.get(0); // Add new listeners to the task using an Activity scope task.addOnSuccessListener(this, new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot state) { // Success! // ... } }); } }
يسترد getActiveUploadTasks
جميع مهام التحميل النشطة في المرجع المقدم وتحته، لذلك قد تحتاج إلى التعامل مع مهام متعددة.
استمرار التحميلات عبر عمليات إعادة التشغيل
إذا تم إيقاف العملية الخاصة بك، فسيتم مقاطعة أي عمليات تحميل قيد التقدم. ومع ذلك، يمكنك متابعة التحميل بمجرد إعادة تشغيل العملية عن طريق استئناف جلسة التحميل مع الخادم. يمكن أن يوفر هذا الوقت وعرض النطاق الترددي من خلال عدم بدء التحميل من بداية الملف.
للقيام بذلك، ابدأ بالتحميل عبر putFile
. في StorageTask
الناتج، اتصل بـ getUploadSessionUri
واحفظ القيمة الناتجة في التخزين المستمر (مثل SharedPreferences).
Kotlin+KTX
uploadTask = storageRef.putFile(localFile) uploadTask.addOnProgressListener { taskSnapshot -> sessionUri = taskSnapshot.uploadSessionUri if (sessionUri != null && !saved) { saved = true // A persisted session has begun with the server. // Save this to persistent storage in case the process dies. } }
Java
uploadTask = mStorageRef.putFile(localFile); uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { Uri sessionUri = taskSnapshot.getUploadSessionUri(); if (sessionUri != null && !mSaved) { mSaved = true; // A persisted session has begun with the server. // Save this to persistent storage in case the process dies. } } });
بعد إعادة تشغيل العملية مع توقف التحميل، اتصل بـ putFile مرة أخرى. ولكن هذه المرة أيضًا قم بتمرير Uri الذي تم حفظه.
Kotlin+KTX
// resume the upload task from where it left off when the process died. // to do this, pass the sessionUri as the last parameter uploadTask = storageRef.putFile( localFile, storageMetadata { }, sessionUri, )
Java
//resume the upload task from where it left off when the process died. //to do this, pass the sessionUri as the last parameter uploadTask = mStorageRef.putFile(localFile, new StorageMetadata.Builder().build(), sessionUri);
الجلسات تستمر لمدة أسبوع واحد. إذا حاولت استئناف جلسة عمل بعد انتهاء صلاحيتها أو في حالة حدوث خطأ، فسوف تتلقى رد اتصال فاشل. تقع على عاتقك مسؤولية التأكد من عدم تغير الملف بين عمليات التحميل.
معالجة الأخطاء
هناك عدد من الأسباب التي قد تؤدي إلى حدوث أخطاء عند التحميل، بما في ذلك الملف المحلي غير الموجود، أو عدم حصول المستخدم على إذن لتحميل الملف المطلوب. يمكنك العثور على مزيد من المعلومات حول الأخطاء في قسم التعامل مع الأخطاء في المستندات.
مثال كامل
فيما يلي مثال كامل للتحميل مع مراقبة التقدم ومعالجة الأخطاء:
Kotlin+KTX
// File or Blob file = Uri.fromFile(File("path/to/mountains.jpg")) // Create the file metadata metadata = storageMetadata { contentType = "image/jpeg" } // Upload file and metadata to the path 'images/mountains.jpg' uploadTask = storageRef.child("images/${file.lastPathSegment}").putFile(file, metadata) // Listen for state changes, errors, and completion of the upload. // You'll need to import com.google.firebase.storage.component1 and // com.google.firebase.storage.component2 uploadTask.addOnProgressListener { (bytesTransferred, totalByteCount) -> val progress = (100.0 * bytesTransferred) / totalByteCount Log.d(TAG, "Upload is $progress% done") }.addOnPausedListener { Log.d(TAG, "Upload is paused") }.addOnFailureListener { // Handle unsuccessful uploads }.addOnSuccessListener { // Handle successful uploads on complete // ... }
Java
// File or Blob file = Uri.fromFile(new File("path/to/mountains.jpg")); // Create the file metadata metadata = new StorageMetadata.Builder() .setContentType("image/jpeg") .build(); // Upload file and metadata to the path 'images/mountains.jpg' uploadTask = storageRef.child("images/"+file.getLastPathSegment()).putFile(file, metadata); // Listen for state changes, errors, and completion of the upload. uploadTask.addOnProgressListener(new OnProgressListener<UploadTask.TaskSnapshot>() { @Override public void onProgress(UploadTask.TaskSnapshot taskSnapshot) { double progress = (100.0 * taskSnapshot.getBytesTransferred()) / taskSnapshot.getTotalByteCount(); Log.d(TAG, "Upload is " + progress + "% done"); } }).addOnPausedListener(new OnPausedListener<UploadTask.TaskSnapshot>() { @Override public void onPaused(UploadTask.TaskSnapshot taskSnapshot) { Log.d(TAG, "Upload is paused"); } }).addOnFailureListener(new OnFailureListener() { @Override public void onFailure(@NonNull Exception exception) { // Handle unsuccessful uploads } }).addOnSuccessListener(new OnSuccessListener<UploadTask.TaskSnapshot>() { @Override public void onSuccess(UploadTask.TaskSnapshot taskSnapshot) { // Handle successful uploads on complete // ... } });
الآن بعد أن قمت بتحميل الملفات، فلنتعرف على كيفية تنزيلها من Cloud Storage.