تحميل الملفات باستخدام Cloud Storage على Android

يسمح لك 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
StorageActivity.kt

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
StorageActivity.java

بعد إنشاء مرجع مناسب، يمكنك استدعاء طريقة putBytes() أو putFile() أو putStream() لتحميل الملف إلى Cloud Storage.

لا يمكنك تحميل بيانات تتضمّن إشارة إلى جذر حزمة 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.
    // ...
}
StorageActivity.kt

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

بما أنّ 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.
    // ...
}
StorageActivity.kt

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

التحميل من ملف على الجهاز

يمكنك تحميل الملفات على الجهاز، مثل الصور والفيديوهات من الكاميرا، باستخدام الطريقة 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.
    // ...
}
StorageActivity.kt

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

الحصول على عنوان 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
        // ...
    }
}
StorageActivity.kt

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

إضافة البيانات الوصفية للملف

يمكنك أيضًا تضمين البيانات الوصفية عند تحميل الملفات. تحتوي هذه البيانات الوصفية على سمات البيانات الوصفية المعتادة للملفات، مثل 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)
StorageActivity.kt

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

إدارة التحميلات

بالإضافة إلى بدء عمليات التحميل، يمكنك إيقافها مؤقتًا واستئنافها وإلغاؤها باستخدام pause() وresume() وcancel(). تؤدي أحداث الإيقاف المؤقت والاستئناف إلى تغيير حالة pause وprogress على التوالي. يؤدي إلغاء عملية carregar إلى تعذُّر التحميل مع ظهور خطأ يشير إلى أنّه تم إلغاء عملية carregar.

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

Java

uploadTask = storageRef.child("images/mountains.jpg").putFile(file);

// Pause the upload
uploadTask.pause();

// Resume the upload
uploadTask.resume();

// Cancel the upload
uploadTask.cancel();
StorageActivity.java

مراقبة مستوى تقدّم عملية التحميل

يمكنك إضافة مستمعين للتعامل مع حالات النجاح أو الفشل أو التقدّم أو الفواصل في مهمة التحميل:

نوع المستمع الاستخدام المعتاد
OnProgressListener ويتم استدعاء أداة معالجة البيانات هذه بشكل دوري أثناء نقل البيانات ويمكن استخدامها لتعبئة مؤشر التحميل/التنزيل.
OnPausedListener يتمّ استدعاء هذا المستمع في أيّ وقت يتمّ فيه إيقاف المهمّة مؤقتًا.
OnSuccessListener يتمّ استدعاء هذا المستمع عند اكتمال المهمة بنجاح.
OnFailureListener يتم استدعاء هذا المستمع في أي وقت تعذّر فيه التحميل. ويمكن أن يحدث ذلك بسبب انتهاء مهلة الشبكة أو تعذُّر الحصول على إذن أو في حال إلغاء المهمة.

يتمّ استدعاء OnFailureListener باستخدام مثيل Exception. يتم استدعاء مثيل المستمع الآخر باستخدام عنصر UploadTask.TaskSnapshot. هذا الكائن عبارة عن طريقة عرض غير قابلة للتغيير للمهمة وقت وقوع الحدث. يحتوي UploadTask.TaskSnapshot على السمات التالية:

الموقع النوع الوصف
getDownloadUrl String عنوان URL يمكن استخدامه لتنزيل العنصر هذا عنوان URL علني لا يمكن تخمينه ويمكن مشاركته مع عملاء آخرين. تتم تعبئة هذه القيمة بعد اكتمال عملية التحميل.
getError Exception إذا تعذّر تنفيذ المهمة، سيكون السبب هو "استثناء".
getBytesTransferred long إجمالي عدد وحدات البايت التي تم نقلها عند الحصول على هذه اللقطة.
getTotalByteCount long إجمالي عدد وحدات البايت المتوقّع تحميلها.
getUploadSessionUri String معرّف موارد منتظم (URI) يمكن استخدامه لمتابعة هذه المهمة من خلال استدعاء آخر إلى PlaceFile.
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")
}
StorageActivity.kt

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

التعامل مع تغييرات مراحل النشاط

وتستمر عمليات التحميل في الخلفية حتى بعد تغيير مراحل نشاط النشاط (مثل عرض مربّع حوار أو تدوير الشاشة). وسيظلّ أيضًا أي مستمعين سبق أن ربطتهم. وقد يؤدي ذلك إلى نتائج غير متوقّعة في حال تم استدعاؤها بعد إيقاف النشاط.

يمكنك حلّ هذه المشكلة من خلال اشتراك المستمعين في نطاق نشاط لإلغاء تسجيلهم تلقائيًا عند إيقاف النشاط. بعد ذلك، استخدِم 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!
            // ...
        }
    }
}
UploadActivity.kt

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

يسترجع 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.
    }
}
UploadActivity.kt

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

بعد إعادة تشغيل العملية مع تحميل متقطّع، يمكنك استدعاء putFile مرة أخرى. ولكن هذه المرة، يجب أيضًا تمرير عنوان URL الذي تم حفظه.

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

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

تستمر الجلسات لمدة أسبوع واحد. إذا حاولت استئناف جلسة بعد انتهاء مهلة صلاحيتها أو إذا حدث خطأ فيها، ستتلقّى مكالمة استجابة تشير إلى تعذُّر إكمال الجلسة. تقع على عاتقك مسؤولية التأكّد من أنّ الملف لم يتغيّر بين عمليات التحميل.

خطأ أثناء المعالجة

هناك عدد من الأسباب التي قد تؤدي إلى حدوث أخطاء أثناء التحميل، بما في ذلك عدم توفّر الملف على الجهاز أو عدم توفّر إذن لدى المستخدم لتحميل الملف المطلوب. يمكنك العثور على مزيد من المعلومات حول الأخطاء في قسم معالجة الأخطاء في المستندات.

مثال كامل

في ما يلي مثال كامل على عملية تحميل تتضمّن مراقبة مستوى التقدّم ومعالجة الأخطاء:

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
    // ...
}
StorageActivity.kt

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

الآن بعد أن حمّلت الملفات، لنتعرّف على كيفية تنزيلها من Cloud Storage.