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

تتيح لك أداة Cloud Storage for Firebase تحميل الملفات بسرعة وسهولة إلى حزمة Cloud Storage التي توفّرها وتديرها منصة Firebase.

تحميل ملفات

لتحميل ملف إلى Cloud Storage، عليك أولاً إنشاء مرجع للمسار الكامل للملف، بما في ذلك اسم الملف.

Kotlin

// 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.

لا يمكنك تحميل البيانات مع مرجع إلى جذر حزمة Cloud Storage. يجب أن تشير المرجعية إلى عنوان URL فرعي.

التحميل من البيانات في الذاكرة

تُعد طريقة putBytes() أبسط طريقة لتحميل ملف إلى Cloud Storage. تتلقّى الدالة putBytes() مَعلمة byte[] وتُرجع UploadTask يمكنك استخدامه لإدارة حالة التحميل ومراقبتها.

Kotlin

// 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

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

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

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

// 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

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

// 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

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

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 مرة أخرى. ولكن هذه المرة أيضًا مرر معرّف الموارد المنتظم الذي تم حفظه.

Kotlin

// 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

// 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".