تمت ترجمة هذه الصفحة بواسطة 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 على التوالي. يؤدي إلغاء عملية 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`	عنوان URL يمكن استخدامه لمواصلة هذه المهمة من خلال طلب آخر إلى 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

بعد إعادة تشغيل العملية مع مقاطعة التحميل، يمكنك استدعاء PlaceFile مرة أخرى. لَكِنْ هذه المرة أيضًا تمرير معرف الموارد المنتظم (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