تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

تحميل الملفات باستخدام 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 // falseStorageActivity.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());    // falseStorageActivity.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 على التوالي. يؤدي إلغاء التحميل إلى تعذُّر التحميل وعرض رسالة خطأ تشير إلى أنّه تم إلغاء التحميل.

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 على السمات التالية:

الموقع	Type	الوصف
`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")
}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 مرة أخرى. لكن هذه المرة أيضًا تجتاز معرف الموارد المنتظم (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,
)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.