Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

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

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

يتيح لك Cloud Storage for Firebase تحميل الملفات بسرعة وسهولة إلى حاوية التخزين السحابية التي توفرها وتديرها 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 . راجع قسم Use File Metadata للحصول على مزيد من المعلومات حول البيانات الأولية للملف.

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.ktx.component1 and 
// com.google.firebase.storage.ktx.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.ktx.component1 and 
// com.google.firebase.storage.ktx.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.