إنشاء مرجع Cloud Storage على Android

يتم تخزين ملفاتك في حاوية Cloud Storage. تظهر الملفات في هذه الحاوية في بنية هرمية، تمامًا مثل نظام الملفات على القرص الثابت المحلي أو البيانات في Firebase Realtime Database. من خلال إنشاء مرجع لملف، يمكن لتطبيقك الوصول إليه. يمكن بعد ذلك استخدام هذه المراجع لتحميل البيانات أو تنزيلها، أو الحصول على البيانات الوصفية أو تعديلها، أو حذف الملف. يمكن أن يشير المرجع إلى ملف معيّن أو إلى عقدة أعلى مستوى في التسلسل الهرمي.

إذا كنت قد استخدمت Firebase Realtime Database، من المفترض أن تبدو لك هذه المسارات مألوفة جدًا. ومع ذلك، يتم تخزين بيانات ملفك في Cloud Storage, وليس في الـ Realtime Database.

إنشاء مرجع

يمكنك إنشاء مرجع لتحميل ملف أو تنزيله أو حذفه، أو للحصول على بياناته الوصفية أو تعديلها. يمكن اعتبار المرجع مؤشرًا إلى ملف في السحابة الإلكترونية. المراجع خفيفة الوزن، لذا يمكنك إنشاء أي عدد تريده منها. ويمكنك أيضًا إعادة استخدامها في عمليات متعددة.

يمكنك إنشاء مرجع باستخدام مثيل أحادي لـ FirebaseStorage واستدعاء طريقة getReference().

Kotlin

// Create a storage reference from our app
var storageRef = storage.reference

Java

// Create a storage reference from our app
StorageReference storageRef = storage.getReference();

بعد ذلك، يمكنك إنشاء مرجع لموقع أدنى في الشجرة، مثلاً "images/space.jpg" باستخدام طريقة child() على مرجع حالي.

Kotlin

// Create a child reference
// imagesRef now points to "images"
var imagesRef: StorageReference? = storageRef.child("images")

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
var spaceRef = storageRef.child("images/space.jpg")

Java

// Create a child reference
// imagesRef now points to "images"
StorageReference imagesRef = storageRef.child("images");

// Child references can also take paths
// spaceRef now points to "images/space.jpg
// imagesRef still points to "images"
StorageReference spaceRef = storageRef.child("images/space.jpg");

يمكنك أيضًا استخدام الطريقتَين getParent() وgetRoot() للتنقّل للأعلى في التسلسل الهرمي للملفات. تنتقل الطريقة getParent() مستوى واحدًا للأعلى، بينما تنتقل الطريقة getRoot() إلى أعلى مستوى.

Kotlin

// parent allows us to move our reference to a parent node
// imagesRef now points to 'images'
imagesRef = spaceRef.parent

// root allows us to move all the way back to the top of our bucket
// rootRef now points to the root
val rootRef = spaceRef.root

Java

// getParent allows us to move our reference to a parent node
// imagesRef now points to 'images'
imagesRef = spaceRef.getParent();

// getRoot allows us to move all the way back to the top of our bucket
// rootRef now points to the root
StorageReference rootRef = spaceRef.getRoot();

يمكن ربط الطرق child() وgetParent() وgetRoot() معًا عدة مرات، لأنّ كل طريقة تعرض مرجعًا. لكن استدعاء getRoot().getParent() يعرض null.

Kotlin

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
val earthRef = spaceRef.parent?.child("earth.jpg")

// nullRef is null, since the parent of root is null
val nullRef = spaceRef.root.parent

Java

// References can be chained together multiple times
// earthRef points to 'images/earth.jpg'
StorageReference earthRef = spaceRef.getParent().child("earth.jpg");

// nullRef is null, since the parent of root is null
StorageReference nullRef = spaceRef.getRoot().getParent();

خصائص المرجع

يمكنك فحص المراجع لفهم الملفات التي تشير إليها بشكل أفضل باستخدام الطرق getPath() وgetName() وgetBucket(). تحصل هذه الطرق على المسار الكامل للملف واسمه والحاوية التي يتم تخزينه فيها.

Kotlin

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
spaceRef.path

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
spaceRef.name

// Reference's bucket is the name of the storage bucket that the files are stored in
spaceRef.bucket

Java

// Reference's path is: "images/space.jpg"
// This is analogous to a file path on disk
spaceRef.getPath();

// Reference's name is the last segment of the full path: "space.jpg"
// This is analogous to the file name
spaceRef.getName();

// Reference's bucket is the name of the storage bucket that the files are stored in
spaceRef.getBucket();

القيود المفروضة على المراجع

يمكن أن تحتوي مسارات المراجع وأسماؤها على أي تسلسل من أحرف Unicode الصالحة، ولكن يتم فرض قيود معيّنة، بما في ذلك:

  1. يجب أن يتراوح الطول الإجمالي لـ reference.fullPath بين بايت واحد و1024 بايت عند استخدام الترميز UTF-8.
  2. يجب عدم استخدام أحرف "إرجاع المؤشر" أو "تغذية السطر".
  3. تجنَّب استخدام الرموز # أو [ أو ] أو * أو ?، لأنّها لا تعمل بشكل جيد مع الأدوات الأخرى، مثل Firebase Realtime Database أو gsutil.

مثال كامل

Kotlin

// Points to the root reference
storageRef = storage.reference

// Points to "images"
imagesRef = storageRef.child("images")

// Points to "images/space.jpg"
// Note that you can use variables to create child values
val fileName = "space.jpg"
spaceRef = imagesRef.child(fileName)

// File path is "images/space.jpg"
val path = spaceRef.path

// File name is "space.jpg"
val name = spaceRef.name

// Points to "images"
imagesRef = spaceRef.parent

Java

// Points to the root reference
storageRef = storage.getReference();

// Points to "images"
imagesRef = storageRef.child("images");

// Points to "images/space.jpg"
// Note that you can use variables to create child values
String fileName = "space.jpg";
spaceRef = imagesRef.child(fileName);

// File path is "images/space.jpg"
String path = spaceRef.getPath();

// File name is "space.jpg"
String name = spaceRef.getName();

// Points to "images"
imagesRef = spaceRef.getParent();

بعد ذلك، لنتعرّف على كيفية تحميل الملفات إلى Cloud Storage.