إدراج الملفات باستخدام Cloud Storage على Android

يتيح لك Cloud Storage for Firebase إدراج محتوى حزمة Cloud Storage. تعرض حِزم تطوير البرامج (SDK) كلاً من العناصر وبادئات الكائنات ضمن مرجع Cloud Storage الحالي.

تتطلّب المشاريع التي تستخدم List API Cloud Storage for Firebase الإصدار 2 من القواعد. إذا كان لديك مشروع حالي على Firebase، اتّبِع الخطوات الواردة في دليل قواعد الأمان.

تستخدم list() Google Cloud Storage List API. في Cloud Storage for Firebase، نستخدم / كمحدّد، ما يتيح لنا محاكاة دلالات نظام الملفات. للسماح بالتصفّح الفعّال لمجموعات كبيرة ذات بنية هرمية Cloud Storage، تعرض واجهة برمجة التطبيقات List البادئات والعناصر بشكل منفصل. على سبيل المثال، إذا حمّلت ملفًا واحدًا /images/uid/file1،

  • ستعرض السمة root.child('images').listAll() القيمة /images/uid كبادئة.
  • ستعرض root.child('images/uid').listAll() الملف كعنصر.

لا تعرض حزمة تطوير البرامج (SDK) الخاصة بـ Cloud Storage for Firebase مسارات عناصر تحتوي على علامتَي / متتاليتَين أو تنتهي بعلامة /. على سبيل المثال، لنفترض أنّ لديك حزمة تتضمّن الكائنات التالية:

  • correctPrefix/happyItem
  • wrongPrefix//sadItem
  • lonelyItem/

ستؤدي عمليات القائمة على العناصر في هذه الحزمة إلى النتائج التالية:

  • تعرض عملية القائمة في الجذر المراجع إلى correctPrefix وwrongPrefix وlonelyItem على النحو prefixes.
  • تعرض عملية القائمة في correctPrefix/ المراجع إلى correctPrefix/happyItem على النحو items.
  • لا تعرض عملية القائمة في wrongPrefix/ أي مراجع لأنّ wrongPrefix//sadItem يحتوي على / متتاليَين.
  • لا تعرض عملية القائمة في lonelyItem/ أي مراجع لأنّ العنصر lonelyItem/ ينتهي بـ /.

عرض قائمة بجميع الملفات

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

بالنسبة إلى القوائم الكبيرة، استخدِم طريقة list() المقسّمة إلى صفحات لأنّ listAll() تخزّن جميع النتائج مؤقتًا في الذاكرة.

يوضّح المثال التالي listAll.

Kotlin

val storage = Firebase.storage
val listRef = storage.reference.child("files/uid")

// You'll need to import com.google.firebase.storage.component1 and
// com.google.firebase.storage.component2
listRef.listAll()
    .addOnSuccessListener { (items, prefixes) ->
        for (prefix in prefixes) {
            // All the prefixes under listRef.
            // You may call listAll() recursively on them.
        }

        for (item in items) {
            // All the items under listRef.
        }
    }
    .addOnFailureListener {
        // Uh-oh, an error occurred!
    }
StorageActivity.kt

Java

StorageReference listRef = storage.getReference().child("files/uid");

listRef.listAll()
        .addOnSuccessListener(new OnSuccessListener<ListResult>() {
            @Override
            public void onSuccess(ListResult listResult) {
                for (StorageReference prefix : listResult.getPrefixes()) {
                    // All the prefixes under listRef.
                    // You may call listAll() recursively on them.
                }

                for (StorageReference item : listResult.getItems()) {
                    // All the items under listRef.
                }
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Uh-oh, an error occurred!
            }
        });
StorageActivity.java

تقسيم نتائج القائمة إلى صفحات

تفرض واجهة برمجة التطبيقات list() حدًا أقصى على عدد النتائج التي تعرضها. توفّر list() مشاهدة صفحة متسقة وتعرض pageToken يتيح التحكّم في وقت استرداد نتائج إضافية.

تشفّر pageToken المسار والإصدار الخاصين بآخر عنصر تم عرضه في النتيجة السابقة. في طلب لاحق باستخدام pageToken، يتم عرض العناصر التي تلي pageToken.

يوضّح المثال التالي كيفية تقسيم النتائج إلى صفحات:

Kotlin

fun listAllPaginated(pageToken: String?) {
    val storage = Firebase.storage
    val listRef = storage.reference.child("files/uid")

    // Fetch the next page of results, using the pageToken if we have one.
    val listPageTask = if (pageToken != null) {
        listRef.list(100, pageToken)
    } else {
        listRef.list(100)
    }

    // You'll need to import com.google.firebase.storage.component1 and
    // com.google.firebase.storage.component2
    listPageTask
        .addOnSuccessListener { (items, prefixes, pageToken) ->
            // Process page of results
            processResults(items, prefixes)

            // Recurse onto next page
            pageToken?.let {
                listAllPaginated(it)
            }
        }.addOnFailureListener {
            // Uh-oh, an error occurred.
        }
}
StorageActivity.kt

Java

public void listAllPaginated(@Nullable String pageToken) {
    FirebaseStorage storage = FirebaseStorage.getInstance();
    StorageReference listRef = storage.getReference().child("files/uid");

    // Fetch the next page of results, using the pageToken if we have one.
    Task<ListResult> listPageTask = pageToken != null
            ? listRef.list(100, pageToken)
            : listRef.list(100);

    listPageTask
            .addOnSuccessListener(new OnSuccessListener<ListResult>() {
                @Override
                public void onSuccess(ListResult listResult) {
                    List<StorageReference> prefixes = listResult.getPrefixes();
                    List<StorageReference> items = listResult.getItems();

                    // Process page of results
                    // ...

                    // Recurse onto next page
                    if (listResult.getPageToken() != null) {
                        listAllPaginated(listResult.getPageToken());
                    }
                }
            }).addOnFailureListener(new OnFailureListener() {
                @Override
                public void onFailure(@NonNull Exception e) {
                    // Uh-oh, an error occurred.
                }
            });
}
StorageActivity.java

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

ستتعذّر عملية list() وlistAll() إذا لم تتم ترقية &quot;قواعد الأمان&quot; إلى الإصدار 2. يمكنك ترقية &quot;قواعد الأمان&quot; إذا ظهر لك الخطأ التالي:

Listing objects in a bucket is disallowed for rules_version = "1".
Please update storage security rules to rules_version = "2" to use list.

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