دریافت FIRDatabaseReference
برای خواندن یا نوشتن دادهها از پایگاه داده، به نمونهای از
FIRDatabaseReference نیاز دارید:
Swift
var ref: DatabaseReference! ref = Database.database().reference()
Objective-C
@property (strong, nonatomic) FIRDatabaseReference *ref; self.ref = [[FIRDatabase database] reference];
خواندن و نوشتن فهرستها
افزودن به فهرست دادهها
از روش childByAutoId برای افزودن داده به فهرست در برنامههای چندکاربره استفاده کنید. روش childByAutoId هربار که فرزند جدیدی به مرجع Firebase مشخصشده اضافه میشود، کلید منحصربهفردی تولید میکند. بااستفاده از این کلیدهای خودکار تولیدشده برای هر عنصر جدید در فهرست، چندین کارخواه میتوانند بهطور همزمان و بدون تداخل نوشتن، فرزندان را به یک مکان اضافه کنند. کلید
یکتای تولیدشده توسط childByAutoId براساس مُهر زمان است، بنابراین موارد فهرست
بهطور خودکار بهترتیب زمانی مرتب میشوند.
میتوانید از ارجاع به دادههای جدید برگرداندهشده توسط روش childByAutoId استفاده کنید
تا مقدار کلید خودکار تولیدشده فرزند را دریافت کنید یا دادهها را برای فرزند تنظیم کنید.
فراخوانی getKey در مرجع childByAutoId کلید تولیدشده خودکار را برمیگرداند.
میتوانید از این کلیدهای تولیدشده بهطور خودکار برای ساده کردن مسطحسازی ساختار دادههایتان استفاده کنید. برای اطلاعات بیشتر، نمونه توزیع داده را ببینید.
گوش دادن به رویدادهای فرزند
رویدادهای فرزند در پاسخ به عملیات خاصی که برای فرزندان یک گره اتفاق میافتد، راهاندازی میشوند، مانند اضافه شدن یک فرزند جدید ازطریق روش childByAutoId یا بهروزرسانی یک فرزند ازطریق روش updateChildValues.
| نوع رویداد | استفاده معمول |
|---|---|
FIRDataEventTypeChildAdded |
فهرست موارد را بازیابی کند یا به موارد اضافهشده به فهرست موارد گوش دهد. این رویداد یکبار برای هر فرزند موجود و سپس دوباره هر بار که فرزند جدیدی به مسیر مشخصشده اضافه میشود راهاندازی میشود. شنونده یک عکس آنی حاوی دادههای فرزند جدید را دریافت میکند. |
FIRDataEventTypeChildChanged |
گوش دادن به تغییرات موارد موجود در فهرست. این رویداد هرزمان که گره فرعی اصلاح شود راهاندازی میشود. این شامل هرگونه تغییر در فرزندان گره فرزند میشود. عکس آنی ارسالشده به شنونده رویداد حاوی دادههای بهروزشده برای فرزند است. |
FIRDataEventTypeChildRemoved |
به مواردی که از فهرست برداشته میشوند گوش دهید. این رویداد زمانی راهاندازی میشود که یک فرزند مستقیم حذف شود.عکس آنی ارسالشده به بلوک فراخوانی حاوی دادههای فرزند حذفشده است. |
FIRDataEventTypeChildMoved |
به تغییرات ترتیب موارد در فهرست مرتبشده گوش دهید.
این رویداد هر زمان که بهروزرسانی باعث تغییر ترتیب
فرزند شود راهاندازی میشود. این تابع با دادههایی استفاده میشود که براساس queryOrderedByChild
یا queryOrderedByValue مرتب شدهاند.
|
هرکدام از اینها باهم میتوانند برای گوش دادن به تغییرات در گره خاصی در پایگاه داده مفید باشند. برای مثال، یک برنامه وبلاگنویسی اجتماعی ممکن است از این روشها با هم برای نظارت بر فعالیت در نظرات یک پست استفاده کند، همانطور که در زیر نشان داده شده است:
Swift
// Listen for new comments in the Firebase database commentsRef.observe(.childAdded, with: { (snapshot) -> Void in self.comments.append(snapshot) self.tableView.insertRows( at: [IndexPath(row: self.comments.count - 1, section: self.kSectionComments)], with: UITableView.RowAnimation.automatic ) }) // Listen for deleted comments in the Firebase database commentsRef.observe(.childRemoved, with: { (snapshot) -> Void in let index = self.indexOfMessage(snapshot) self.comments.remove(at: index) self.tableView.deleteRows( at: [IndexPath(row: index, section: self.kSectionComments)], with: UITableView.RowAnimation.automatic ) })
Objective-C
// Listen for new comments in the Firebase database [_commentsRef observeEventType:FIRDataEventTypeChildAdded withBlock:^(FIRDataSnapshot *snapshot) { [self.comments addObject:snapshot]; [self.tableView insertRowsAtIndexPaths:@[ [NSIndexPath indexPathForRow:self.comments.count - 1 inSection:kSectionComments] ] withRowAnimation:UITableViewRowAnimationAutomatic]; }]; // Listen for deleted comments in the Firebase database [_commentsRef observeEventType:FIRDataEventTypeChildRemoved withBlock:^(FIRDataSnapshot *snapshot) { int index = [self indexOfMessage:snapshot]; [self.comments removeObjectAtIndex:index]; [self.tableView deleteRowsAtIndexPaths:@[[NSIndexPath indexPathForRow:index inSection:kSectionComments]] withRowAnimation:UITableViewRowAnimationAutomatic]; }];
گوش دادن به رویدادهای مقدار
درحالیکه گوش دادن به رویدادهای فرزند روش توصیهشده برای خواندن فهرستهای داده است، موقعیتهایی وجود دارد که گوش دادن به رویدادهای مقدار در مرجع فهرست مفید است.
Attaching a FIRDataEventTypeValue observer to a list of data will return the
entire list of data as a single DataSnapshot, which you can then loop over to
access individual children.
حتی وقتی فقط یک مورد منطبق برای پُرسمان وجود دارد، عکس آنی همچنان بهصورت فهرست است؛ فقط یک مورد دارد. برای دسترسی به مورد، باید نتیجه را تکرار کنید:
Swift
_commentsRef.observe(.value) { snapshot in for child in snapshot.children { ... } }
Objective-C
[_commentsRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) { // Loop over children NSEnumerator *children = [snapshot children]; FIRDataSnapshot *child; while (child = [children nextObject]) { // ... } }];
این الگو زمانی میتواند مفید باشد که میخواهید همه فرزندان یک فهرست را در یک عملیات واکشی کنید، بهجای اینکه برای رویدادهای اضافه شدن فرزندان اضافی گوش دهید.
مرتبسازی و فیلتر کردن دادهها
میتوانید از کلاس Realtime Database FIRDatabaseQuery برای بازیابی دادههای مرتبشده
براساس کلید، براساس مقدار، یا براساس مقدار فرزند استفاده کنید. همچنین میتوانید
نتیجه مرتبشده را به تعداد خاصی از نتایج یا محدودهای از کلیدها یا
مقادیر فیلتر کنید.
مرتبسازی دادهها
برای بازیابی دادههای مرتبشده، ابتدا یکی از روشهای بهترتیب کردن را برای تعیین نحوه مرتبسازی نتایج مشخص کنید:
| روش | کاربرد |
|---|---|
queryOrderedByKey
| نتایج را براساس کلیدهای فرزند مرتب کنید. |
queryOrderedByValue |
نتایج را براساس مقادیر فرزند مرتب میکند. |
queryOrderedByChild |
نتایج را براساس مقدار کلید فرزند مشخصشده یا مسیر فرزند تودرتو مرتب کنید. |
در هر زمان فقط میتوانید از یک روش بهترتیب کردن استفاده کنید. فراخوانی روش بهترتیب کردن بهدفعات در یک پُرسمان باعث ایجاد خطا میشود.
مثال زیر نشان میدهد که چگونه میتوانید فهرستی از پستهای برتر کاربر را که براساس تعداد ستارههایشان مرتب شدهاند بازیابی کنید:
Swift
// My top posts by number of stars let myTopPostsQuery = ref.child("user-posts").child(getUid()).queryOrdered(byChild: "starCount")
Objective-C
// My top posts by number of stars FIRDatabaseQuery *myTopPostsQuery = [[[self.ref child:@"user-posts"] child:[super getUid]] queryOrderedByChild:@"starCount"];
این پرسمان پستهای کاربر را از مسیر موجود در پایگاه داده براساس شناسه کاربر بازیابی میکند و آنها را براساس تعداد ستارههایی که هر پست دریافت کرده است مرتب میکند. این تکنیک استفاده از شناسهها بهعنوان کلیدهای نمایه، «پخش داده» نامیده میشود، میتوانید اطلاعات بیشتر درباره آن را در ساختاربندی پایگاه داده بخوانید.
فراخوانی روش queryOrderedByChild کلید فرزند را برای مرتبسازی نتایج مشخص میکند. در این مثال، پستها براساس مقدار
"starCount" فرزند در هر پست مرتب شدهاند. پُرسمانها را میتوان براساس فرزندان تودرتو نیز مرتب کرد، درصورتیکه دادههایی شبیه به این داشته باشید:
"posts": {
"ts-functions": {
"metrics": {
"views" : 1200000,
"likes" : 251000,
"shares": 1200,
},
"title" : "Why you should use TypeScript for writing Cloud Functions",
"author": "Doug",
},
"android-arch-3": {
"metrics": {
"views" : 900000,
"likes" : 117000,
"shares": 144,
},
"title" : "Using Android Architecture Components with Firebase Realtime Database (Part 3)",
"author": "Doug",
}
},In this case, we can order our list elements by values nested under the
metrics key by specifying the relative path to the nested child in our
queryOrderedByChild call.
Swift
let postsByMostPopular = ref.child("posts").queryOrdered(byChild: "metrics/views")
Objective-C
FIRDatabaseQuery *postsByMostPopular = [[ref child:@"posts"] queryOrderedByChild:@"metrics/views"];
برای اطلاعات بیشتر درباره نحوه مرتبسازی انواع دیگر دادهها، نحوه مرتبسازی دادههای پُرسمان را ببینید.
فیلتر کردن دادهها
برای فیلتر کردن دادهها، میتوانید هریک از روشهای محدوده یا حد را با روش بهترتیب کردن هنگام ساختن پرسمان ترکیب کنید.
| روش | کاربرد |
|---|---|
queryLimitedToFirst |
حداکثر تعداد مواردی را که باید از ابتدای فهرست مرتبشده نتایج برگردانده شود تنظیم میکند. |
queryLimitedToLast |
حداکثر تعداد مواردی را که باید از انتهای فهرست مرتبشده نتایج برگردانده شود تنظیم میکند. |
queryStartingAtValue |
موارد بزرگتر یا مساوی با کلید یا مقدار مشخصشده را برمیگرداند، بسته به روش بهترتیب کردن انتخابشده. |
queryStartingAfterValue |
موارد بزرگتر از کلید یا مقدار مشخصشده را برمیگرداند، بسته به روش بهترتیب کردن انتخابشده. |
queryEndingAtValue |
موارد کمتر یا مساوی با کلید یا مقدار مشخصشده را برمیگرداند، بسته به روش بهترتیب کردن انتخابشده. |
queryEndingBeforeValue |
موارد کمتر از کلید یا مقدار مشخصشده را برمیگرداند، بسته به روش بهترتیب کردن انتخابشده. |
queryEqualToValue |
موارد برابر با کلید یا مقدار مشخصشده را بسته به روش بهترتیب کردن انتخابشده برمیگرداند. |
برخلاف روشهای بهترتیب کردن، میتوانید چندین تابع محدوده یا حد را ترکیب کنید.
برای مثال، میتوانید روشهای queryStartingAtValue و queryEndingAtValue را ترکیب کنید تا نتایج را به گستره مشخصی از مقادیر محدود کنید.
محدود کردن تعداد نتایج
میتوانید از روشهای queryLimitedToFirst و queryLimitedToLast برای تنظیم
حداکثر تعداد فرزندان برای همگامسازی برای یک فراخوانی معین استفاده کنید. برای مثال، اگر
از queryLimitedToFirst برای تنظیم حد ۱۰۰ استفاده کنید، در ابتدا فقط تا
۱۰۰ بازخوانی FIRDataEventTypeChildAdded دریافت میکنید. اگر کمتر از ۱۰۰ مورد در پایگاه داده Firebase شما ذخیره شده باشد،
یک فراخوانی برگشتی FIRDataEventTypeChildAdded برای هر مورد اجرا میشود.
با تغییر موارد، FIRDataEventTypeChildAdded فراخوانی برگشتی برای مواردی که وارد پُرسمان میشوند و FIRDataEventTypeChildRemoved فراخوانی برگشتی برای مواردی که از آن خارج میشوند دریافت میکنید تا تعداد کل روی ۱۰۰ باقی بماند.
مثال زیر نشان میدهد که چگونه یک برنامه وبلاگنویسی نمونه ممکن است فهرستی از ۱۰۰ پست اخیر همه کاربران را بازیابی کند:
Swift
// Last 100 posts, these are automatically the 100 most recent // due to sorting by push() keys let recentPostsQuery = (ref?.child("posts").queryLimited(toFirst: 100))!
Objective-C
// Last 100 posts, these are automatically the 100 most recent // due to sorting by push() keys FIRDatabaseQuery *recentPostsQuery = [[self.ref child:@"posts"] queryLimitedToFirst:100];
فیلتر کردن براساس کلید یا مقدار
میتوانید از queryStartingAtValue، queryStartingAfterValue،
queryEndingAtValue، queryEndingBeforeValue، و queryEqualToValue
برای انتخاب نقاط شروع، پایان، و برابری دلخواه برای پُرسمانها استفاده کنید. این
میتواند برای صفحهبندی دادهها یا پیدا کردن موارد دارای فرزند با مقدار خاصی
مفید باشد.
نحوه مرتبسازی دادههای پُرسمان
این بخش توضیح میدهد که دادهها چگونه توسط هریک از روشهای بهترتیب کردن در کلاس
FIRDatabaseQuery مرتب میشوند.
queryOrderedByKey
هنگام استفاده از queryOrderedByKey برای مرتبسازی دادهها، دادهها بهترتیب صعودی براساس کلید برگردانده میشوند.
- فرزندانی که کلیدی دارند که میتواند بهعنوان عدد صحیح ۳۲ بیتی تجزیه شود، ابتدا میآیند و بهصورت صعودی مرتب میشوند.
- فرزندانی که مقدار رشتهای بهعنوان کلید دارند در ردیف بعدی قرار میگیرند و بهترتیب صعودی واژهنامهای مرتب میشوند.
queryOrderedByValue
هنگام استفاده از queryOrderedByValue، فرزندان براساس مقدارشان مرتب میشوند. معیارهای ترتیببندی همانند queryOrderedByChild است، با این تفاوت که بهجای مقدار کلید فرزند مشخصشده، از مقدار گره استفاده میشود.
queryOrderedByChild
هنگام استفاده از queryOrderedByChild، دادههایی که حاوی کلید فرزند مشخصشده هستند
بهصورت زیر مرتب میشوند:
- فرزندان با مقدار
nilبرای کلید فرزند مشخصشده در ابتدا میآیند. - فرزندان با مقدار
falseبرای کلید فرزند مشخصشده در ردیف بعدی قرار میگیرند. اگر چند فرزند مقدارfalseداشته باشند، براساس کلید بهترتیب الفبایی مرتب میشوند. - فرزندان با مقدار
trueبرای کلید فرزند مشخصشده در ردیف بعدی قرار میگیرند. اگر چند فرزند مقدارtrueداشته باشند، بهترتیب الفبایی براساس کلید مرتب میشوند. - فرزندان با مقدار عددی در ردیف بعدی قرار میگیرند و بهترتیب صعودی مرتب میشوند. اگر چندین فرزند مقدار عددی یکسانی برای گره فرزند مشخصشده داشته باشند، براساس کلید مرتب میشوند.
- رشتهها بعداز اعداد میآیند و بهترتیب صعودی واژهنامهای مرتب میشوند. اگر چند فرزند مقدار یکسانی برای گره فرزند مشخصشده داشته باشند، آنها بهترتیب واژهنامهای براساس کلید مرتب میشوند.
- اشیاء در آخر میآیند و بهترتیب صعودی براساس کلید مرتب میشوند.
جدا کردن شنوندهها
وقتی ViewController را ترک میکنید، همگامسازی دادههای ناظران بهطور خودکار متوقف نمیشود. اگر ناظر بهدرستی برداشته نشود، به همگامسازی دادهها با حافظه محلی ادامه میدهد و هر شیء ضبطشده در بسته کنترلکننده رویداد را حفظ میکند که میتواند باعث نشت حافظه شود. وقتی دیگر به ناظر نیازی نیست،
آن را با ارسال FIRDatabaseHandle مربوطه به
روش removeObserverWithHandle بردارید.
وقتی بلوک فراخوانی برگشتی را به مرجع اضافه میکنید، FIRDatabaseHandle برگردانده میشود.
از این دستهها میتوان برای برداشتن بلوک بازخوانی استفاده کرد.
اگر چندین شنونده به یک مرجع پایگاه داده اضافه شده باشند، هر شنونده هنگام وقوع یک رویداد فراخوانی میشود. برای متوقف کردن همگامسازی دادهها در آن مکان،
باید همه ناظران را در مکان با فراخوانی روش removeAllObservers
بردارید.
فراخوانی removeObserverWithHandle یا removeAllObservers در شنونده، شنوندههای ثبتشده در گرههای فرزند آن را بهطور خودکار حذف نمیکند؛ همچنین باید آن ارجاعها یا دستگیرهها را پیگیری کنید تا آنها را حذف کنید.