उद्देश्य-सी पर एक और ActiveRecord कार्यान्वयन

मैं ऑब्जेक्टिव-सी पर और विशेष रूप से iOS के लिए ActiveRecord पैटर्न का एक और कार्यान्वयन साझा करना चाहता हूं।

जब मैं आईओएस विकास में कोरडाटा का उपयोग करना शुरू कर रहा था, तब भी विचार थे कि इस बातचीत को किसी भी तरह से सरल बनाया जा सकता है। कुछ समय बाद, मैं RubyOnRails से ActiveRecord के साथ मिला, और तब मुझे एहसास हुआ कि मैं क्या याद कर रहा था।
गिथब पर थोड़ा खोज करने पर मुझे बहुत सारे कार्यान्वयन मिले, लेकिन विभिन्न कारणों से मुझे वे पसंद नहीं आए। कुछ CoreData के लिए लिखे गए हैं, लेकिन मुझे यह पसंद नहीं है, दूसरों में आपको अपने हाथों से तालिकाओं को बनाने या कच्चे sql प्रश्नों को लिखने की आवश्यकता है। और कुछ मामलों में कोड अश्लील रूप से भयानक था, मैं कभी-कभी खुद को बहुत सफाई से नहीं लिखता, लेकिन संलग्न से विशाल बाड़ अगर / स्विच / अगर / स्विच बहुत अधिक है।
अंत में, मैंने अपनी बाइक लिखने का फैसला किया, बिना CoreData और उपयोगकर्ता के लिए SQL के बिना।
इस विकास का मुख्य कारण था, और मुझे आशा है कि विकास में रुचि होगी।

यहाँ यह सब क्या आया है।
और बिल्ली के नीचे संभावनाओं और कार्यान्वयन का एक छोटा विवरण है (वास्तव में, बहुत सारे पाठ और कोड के टुकड़े, लेख के बहुत अंत में एक सारांश)।

टेबल निर्माण

पहली समस्या टेबल बनाने की थी।
कोरडाटा के मामले में, आपको कुछ भी बनाने की आवश्यकता नहीं है, आपको बस संस्थाओं का वर्णन करने की आवश्यकता है, और सीडी बाकी काम करेगी।
मैंने लंबे समय तक सोचा कि इसे कैसे बेहतर तरीके से व्यवस्थित किया जाए, और थोड़ी देर बाद यह मुझ पर हावी हो गया।
ऑब्जेक्टिव-सी आपको किसी भी वर्ग के लिए सभी उपवर्गों की एक सूची प्राप्त करने की अनुमति देता है, और इसके सभी गुणों की सूची प्राप्त करने के लिए। इस प्रकार, इकाई का विवरण कक्षा का एक सरल विवरण होगा, और मेरे लिए जो कुछ भी करना है वह इस जानकारी को एकत्र करना है और इसके आधार पर एक SQL क्वेरी की रचना करना है।
इकाई विवरण

@interface User : ActiveRecord @property (nonatomic, retain) NSString *name; @end 

सभी उपवर्ग प्राप्त करना

 static NSArray *class_getSubclasses(Class parentClass) { int numClasses = objc_getClassList(NULL, 0); Class *classes = NULL; classes = malloc(sizeof(Class) * numClasses); numClasses = objc_getClassList(classes, numClasses); NSMutableArray *result = [NSMutableArray array]; for (NSInteger i = 0; i < numClasses; i++) { Class superClass = classes[i]; do{ superClass = class_getSuperclass(superClass); } while(superClass && superClass != parentClass); if (superClass == nil) { continue; } [result addObject:classes[i]]; } return result; } 

सभी गुणों को आधार वर्ग तक ले जाना

 Class BaseClass = NSClassFromString(@"NSObject"); id CurrentClass = aRecordClass; while(nil != CurrentClass && CurrentClass != BaseClass){ unsigned int outCount, i; objc_property_t *properties = class_copyPropertyList(CurrentClass, &outCount); for (i = 0; i < outCount; i++) { // do something with concrete property => properties[i] } CurrentClass = class_getSuperclass(CurrentClass); } 

डेटा प्रकार

अधिक लचीलेपन के लिए, हमें बुनियादी डेटा प्रकारों (इंट, डबल आदि) को छोड़ना पड़ा और केवल टेबल फ़ील्ड के रूप में कक्षाओं के साथ काम करना पड़ा।
इस प्रकार, किसी भी वर्ग का उपयोग तालिका क्षेत्र के रूप में किया जा सकता है, एकमात्र आवश्यकता: इसे स्वयं को बचाने और लोड करने में सक्षम होना चाहिए।
ऐसा करने के लिए, इसे ARRepresentationProtocol को लागू करना होगा

 @protocol ARRepresentationProtocol @required + (const char *)sqlType; - (NSString *)toSql; + (id)fromSql:(NSString *)sqlData; @end 

मैंने इन पद्धतियों को श्रेणियों का उपयोग करते हुए फाउंडेशन फ्रेमवर्क के लिए लागू किया है
- NSDecimalNumber - वास्तविक
- NSNumber - पूर्णांक
- एनएसएसट्रिंग - पाठ
- एनएसडेटा - बूँद
- NSDate - तिथि (वास्तविक)
लेकिन इन वर्गों के सेट को किसी भी समय, बिना किसी कठिनाई के विस्तारित किया जा सकता है।

ट्रांसफॉर्मेबल डेटा प्रकार के साथ CoreData आपको एक ही चीज हासिल करने की अनुमति देता है, लेकिन मुझे अभी भी यह पता नहीं चला है कि इसके साथ कैसे काम करना है।

रिकॉर्ड के लिए सी.आर.यू.डी.

बनाएं

एक नया रिकॉर्ड बनाने की प्रक्रिया बहुत सरल और पारदर्शी है।

 User *user = [User newRecord]; user.name = @"Alex"; [user save]; 

पढ़ें

सभी रिकॉर्ड्स को पुनः प्राप्त कर रहा है

 NSArray *users = [User allRecords]; 

अक्सर, सभी रिकॉर्ड की आवश्यकता नहीं होती है, इसलिए मैंने फ़िल्टर के कार्यान्वयन को जोड़ा, लेकिन बाद में उनके बारे में अधिक।

अद्यतन

 User *user = [User newRecord]; user.name = @"Alex"; [user save]; NSArray *users = [User allRecords]; User *userForUpdate = [users first]; userForUpdate.name = @"John"; [userForUpdate update]; //  [userForUpdate save]; 

ActiveRecord सभी गुणों में परिवर्तनों पर नज़र रखता है, और जब अद्यतन करता है तो केवल परिवर्तित फ़ील्ड को अद्यतन करने के लिए अनुरोध करता है।

हटाएं

 NSArray *users = [User allRecords]; User *userForRemove = [users first]; [userForRemove dropRecord]; 

सभी रिकॉर्ड में आईडी (NSNumber) प्रॉपर्टी होती है, जिसे डिलीट करने के लिए इस्तेमाल किया जाता है।

अनावश्यक खेत

उन फ़ील्ड के बारे में जो डेटाबेस को बचाने के लिए आवश्यक नहीं हैं? बस उन्हें अनदेखा करें :)
ऐसा करने के लिए, वर्ग के कार्यान्वयन में आपको निम्नलिखित निर्माण को जोड़ने की आवश्यकता है, यह एक सरल मैक्रो सिस्टम है।

 @implementation User ... @synthesize ignoredProperty; ... ignore_fields_do( ignore_field(ignoredProperty) ) ... @end 

मान्यता

विकास में मैंने खुद के लिए जो मांगें रखीं उनमें से एक है मान्यताओं का समर्थन।
फिलहाल, दो प्रकार के सत्यापन कार्यान्वित किए जाते हैं: उपलब्धता के लिए और विशिष्टता के लिए।
सिंटैक्स सरल है और यह भी कोल मैक्रो का उपयोग करता है। इसके अलावा, कक्षा को ARValidatableProtocol को लागू करना चाहिए, उपयोगकर्ता से कुछ भी आवश्यक नहीं है, यह इसलिए किया जाता है ताकि वर्गों के लिए सत्यापन तंत्र को शुरू न करें जो इसका उपयोग नहीं करते हैं।

 // User.h @interface User : ActiveRecord <ARValidatableProtocol> ... @property (nonatomic, copy) NSString *name; ... @end // User.m @implementation User ... validation_do( validate_uniqueness_of(name) validate_presence_of(name) ) ... @end 

इसके अलावा, मैंने कस्टम सत्यापनकर्ताओं के लिए समर्थन लागू किया जिसे उपयोगकर्ता स्वयं जोड़ सकता है।
ऐसा करने के लिए, आपको एक सत्यापनकर्ता वर्ग बनाने की आवश्यकता है जो ARValidatorProtocol को कार्यान्वित करे और इसे एक मान्य वर्ग में वर्णित करे।
ARValidatorProtocol

 @protocol ARValidatorProtocol <NSObject> @optional - (NSString *)errorMessage; @required - (BOOL)validateField:(NSString *)aField ofRecord:(id)aRecord; @end 

कस्टम सत्यापनकर्ता

 // PrefixValidator.h @interface PrefixValidator : NSObject <ARValidatorProtocol> @end // PrefixValidator.m @implementation PrefixValidator - (NSString *)errorMessage { return @"Invalid prefix"; } - (BOOL)validateField:(NSString *)aField ofRecord:(id)aRecord { NSString *aValue = [aRecord valueForKey:aField]; BOOL valid = [aValue hasPrefix:@"LOL"]; return valid; } @end 

हैंडलिंग में त्रुटि

सहेजें, अपडेट, और isValid तरीके बूलियन मान लौटाते हैं; यदि गलत / NO लौटाया गया है, तो आप त्रुटियों की सूची प्राप्त कर सकते हैं

 [user errors]; 

जिसके बाद क्लास अरेस्टर की वस्तुओं की एक सरणी वापस आ जाएगी

 @interface ARError : NSObject @property (nonatomic, copy) NSString *modelName; @property (nonatomic, copy) NSString *propertyName; @property (nonatomic, copy) NSString *errorName; - (id)initWithModel:(NSString *)aModel property:(NSString *)aProperty error:(NSString *)anError; @end 

इस वर्ग में कोई विस्तृत त्रुटि संदेश नहीं है, लेकिन केवल वे कीवर्ड हैं जिनके आधार पर आप एक स्थानीय संदेश बना सकते हैं और इसे अनुप्रयोग उपयोगकर्ता को प्रदर्शित कर सकते हैं।

प्रवास

माइग्रेशन एक आदिम स्तर पर लागू किया जाता है: यह केवल संस्थाओं के लिए नए क्षेत्रों को जोड़ने या नई संस्थाओं को जोड़ने के लिए प्रतिक्रिया करता है।
माइग्रेशन का उपयोग करने के लिए आपको कहीं भी कुछ भी पंजीकृत करने की आवश्यकता नहीं है।
पहली बार जब एप्लिकेशन लॉन्च किया जाता है, तो सभी टेबल बनाए जाते हैं, और बाद में लॉन्च होने पर, यह देखने के लिए जांचता है कि क्या नए क्षेत्र या टेबल हैं, और यदि कोई हैं, तो परिवर्तन तालिका प्रश्न किए जाते हैं।
तालिका संरचनाओं में बदलाव के लिए चेक को तुरंत नहीं करने के लिए, आपको ActiveRecord के किसी भी कॉल से पहले निम्न संदेश भेजने की आवश्यकता है

 [ActiveRecord disableMigrations]; 

लेन-देन

मैंने लेनदेन का उपयोग करने की क्षमता भी लागू की, इसके लिए ब्लॉक का उपयोग किया जाता है

 [ActiveRecord transaction:^{ User *alex = [User newRecord]; alex.name = @"Alex"; [alex save]; rollback }]; 

रोलबैक - एक साधारण मैक्रो जो प्रकार के अपवाद का अपवाद फेंकता है।
Tarnzaktsii का उपयोग न केवल विफलता के मामले में रोलबैक के लिए किया जा सकता है, बल्कि रिकॉर्ड जोड़ते समय क्वेरी निष्पादन की गति को बढ़ाने के लिए भी किया जा सकता है।
जब 9,000 से अधिक रिकॉर्ड बनाने की कोशिश की जा रही थी, तो परियोजनाओं में एक भयानक ब्रेक था। डंप निष्पादन का समय लगभग 180 सेकंड था जब मैंने इसे एक BEGIN लेनदेन में लपेटा था; ... COMMIT; समय घटकर ~ 4-5 सेकंड हो गया। इसलिए मैं हर किसी को सलाह देता हूं, जो नहीं जानता।

संचार

जब मैं RoR में ActiveRecord के कार्यान्वयन से परिचित हुआ, तो मुझे संस्थाओं के बीच संबंध बनाने की सरलता से खुशी हुई। द्वारा और बड़ी, इस सादगी ने इस ढांचे के निर्माण के लिए पहली शर्त के रूप में कार्य किया। और अब मैं अपनी बाइक में सबसे महत्वपूर्ण विशेषता संस्थाओं, और उनके सापेक्ष सादगी के बीच संबंध मानता हूं।

हस्मानी <-> बिलोंग्सटो

 // User.h @interface User : ActiveRecord ... @property (nonatomic, retain) NSNumber *groupId; ... belongs_to_dec(Group, group, ARDependencyNullify) ... @end // User.m @implementation User ... @synthesize groupId; ... belonsg_to_imp(Group, group, ARDependencyNullify) ... @end 

अंतर्गत_तक_dec belonsg_to_imp मैक्रोज़ तीन मापदंडों को स्वीकार करते हैं: जिस वर्ग के साथ हम संपर्क कर रहे हैं उसका नाम है, गेट्टर का नाम और निर्भरता का प्रकार।
दो प्रकार की निर्भरताएं हैं: ARD dependencyNullify और ARD dependencyDestroy, पहला जब मॉडल को हटाना उसके रिश्तों को कम करता है, और दूसरा सभी संबंधित संस्थाओं को हटा देता है।
इस संबंध के लिए क्षेत्र को मॉडल के नाम से मेल खाना चाहिए और लोअरकेस अक्षर से शुरू करना चाहिए
समूह <-> groupId
उपयोगकर्ता <-> userId
ContentManager <-> contentManagerId
EMCategory <-> eMCategory // थोड़ा अनाड़ी है, लेकिन यह ऐतिहासिक है

प्रतिक्रिया (हस्मानी)

 // Group.h @interface Group : ActiveRecord ... has_many_dec(User, users, ARDependencyDestroy) ... @end // Group.m @implementation Group ... has_many_imp(User, users, ARDependencyDestroy) ... @end 

BelongsTo प्रकार के संचार के साथ भी।
याद रखने वाली मुख्य बात: लिंक बनाने से पहले, दोनों रिकॉर्ड को सहेजना होगा, अन्यथा उनके पास एक आईडी नहीं है, और लिंक इसे से बंधा हुआ है।

HasManyThrough

इस कनेक्शन को बनाने के लिए, आपको एक अन्य मॉडल, एक इंटरमीडिएट बनाना होगा।

 // User.h @interface User : ActiveRecord ... has_many_through_dec(Project, UserProjectRelationship, projects, ARDependencyNullify) ... @end // User.m @implementation User ... has_many_through_imp(Project, UserProjectRelationship, projects, ARDependencyNullify) ... @end // Project.h @interface Project : ActiveRecord ... has_many_through_dec(User, UserProjectRelationship, users, ARDependencyDestroy) ... @end // Project.m @implementation Project ... has_many_through_imp(User, UserProjectRelationship, users, ARDependencyDestroy) ... @end 

इंटरमीडिएट बाइंडिंग मॉडल

 // UserProjectRelationship.h @interface UserProjectRelationship : ActiveRecord @property (nonatomic, retain) NSNumber *userId; @property (nonatomic, retain) NSNumber *projectId; @end // UserProjectRelationship.m @implementation UserProjectRelationship @synthesize userId; @synthesize projectId; @end 

इस कनेक्शन में हसनी के समान ही नुकसान हैं।

* _Dec / * _ imp मैक्रो लिंक जोड़ने के लिए सहायक विधियाँ जोड़ते हैं

 set#ModelName:(ActiveRecord *)aRecord; // BelongsTo add##ModelName:(ActiveRecord *)aRecord; // HasMany, HasManyThrough remove##ModelName:(ActiveRecord *)aRecord; // HasMany, HasManyThrough 

क्वेरी फ़िल्टर

बहुत बार, आपको किसी तरह डेटाबेस से चयन को फ़िल्टर करने की आवश्यकता होती है:
- कुछ टेम्प्लेट (UISearchBar) के अनुरूप रिकॉर्ड की खोज
- तालिका में आउटपुट हजारों में से केवल 5 रिकॉर्ड है
- केवल "भारी" चित्रों के डेटाबेस ढेर से प्राप्त किए बिना, रिकॉर्ड के केवल पाठ क्षेत्र प्राप्त करना
- अभी भी बहुत सारे विकल्प :)

सबसे पहले, मुझे यह भी पता नहीं था कि एक सुविधाजनक रूप में यह सब कैसे लागू किया जाए, लेकिन फिर मुझे रूबी और उसके निहित "आलस्य" को याद आया, अंत में मैंने एक ऐसा वर्ग बनाने का फैसला किया जो केवल मांग पर रिकॉर्ड प्राप्त करेगा, लेकिन किसी भी क्रम में फ़िल्टर स्वीकार करें।
यहाँ क्या यह आया है।

सीमा / ऑफसेट

 NSArray *users = [[[User lazyFetcher] limit:5] fetchRecords]; NSArray *users = [[[User lazyFetcher] offset:5] fetchRecords]; NSArray *users = [[[[User lazyFetcher] offset:5] limit:2] fetchRecords]; 

केवल / छोड़कर

 ARLazyFetcher *fetcher = [[User lazyFetcher] only:@"name", @"id", nil]; ARLazyFetcher *fetcher = [[User lazyFetcher] except:@"veryBigImage", nil]; 

जहाँ

iActiveRecord जहां आधार स्थितियों का समर्थन करता है

 - (ARLazyFetcher *)whereField:(NSString *)aField equalToValue:(id)aValue; - (ARLazyFetcher *)whereField:(NSString *)aField notEqualToValue:(id)aValue; - (ARLazyFetcher *)whereField:(NSString *)aField in:(NSArray *)aValues; - (ARLazyFetcher *)whereField:(NSString *)aField notIn:(NSArray *)aValues; - (ARLazyFetcher *)whereField:(NSString *)aField like:(NSString *)aPattern; - (ARLazyFetcher *)whereField:(NSString *)aField notLike:(NSString *)aPattern; - (ARLazyFetcher *)whereField:(NSString *)aField between:(id)startValue and:(id)endValue; - (ARLazyFetcher *)where:(NSString *)aFormat, ...; 

वही परिचित और सुविधाजनक NSPredicate'ov की शैली में वर्णित किया जा सकता है

 NSArray *ids = [NSArray arrayWithObjects: [NSNumber numberWithInt:1], [NSNumber numberWithInt:15], nil]; NSString *username = @"john"; ARLazyFetcher *fetcher = [User lazyFetcher]; [fetcher where:@"'user'.'name' = %@ or 'user'.'id' in %@", username, ids, nil]; NSArray *records = [fetcher fetchRecords]; 

एसोसिएशन (शामिल होने)

मैंने लगभग कभी भी इसका उपयोग नहीं किया, लेकिन मैंने फैसला किया कि मुझे इसे पूर्णता के लिए लागू करने की आवश्यकता है।

 - (ARLazyFetcher *)join:(Class)aJoinRecord useJoin:(ARJoinType)aJoinType onField:(NSString *)aFirstField andField:(NSString *)aSecondField; 

विभिन्न प्रकार के जुड़ने का समर्थन किया
- ARJoinLeft
- ARJoinRight
- ARJoinInner
- ARJoinOuter
मुझे लगता है कि नाम अपने लिए बोलते हैं।
एक छोटी बैसाखी इस सुविधा के साथ जुड़ी हुई है, इसलिए संयुक्त रिकॉर्ड प्राप्त करने के लिए आपको कॉल करने की आवश्यकता है

 - (NSArray *)fetchJoinedRecords; 

के बजाय

 - (NSArray *)fetchRecords; 

यह विधि शब्दकोशों से एक सरणी देता है, जहां कुंजी इकाई नाम हैं और मान डेटाबेस से डेटा हैं।

छंटाई

 - (ARLazyFetcher *)orderBy:(NSString *)aField ascending:(BOOL)isAscending; - (ARLazyFetcher *)orderBy:(NSString *)aField;// ASC   ARLazyFetcher *fetcher = [[[User lazyFetcher] offset:2] limit:10]; [[fetcher whereField:@"name" equalToValue:@"Alex"] orderBy:@"name"]; NSArray *users = [fetcher fetchRecords]; 

कोष

डेटाबेस को कैश और दस्तावेज़ों में संग्रहीत किया जा सकता है, और दस्तावेज़ों में भंडारण के मामले में, बैकअप को डिस्कनेक्ट करने वाली विशेषता को फ़ाइल में जोड़ा जाता है

 u_int8_t b = 1; setxattr([[url path] fileSystemRepresentation], "com.apple.MobileBackup", &b, 1, 0, 0); 

अन्यथा एप्लिकेशन को Apple से अस्वीकार कर दिया जाएगा।

सारांश

गथब प्रोजेक्ट iActiveRecord है ।
अवसरों

• एआरसी समर्थन करते हैं
• यूनिकोड समर्थन
• प्रवास
• सत्यापन, कस्टम सत्यापनकर्ताओं के समर्थन के साथ
• लेन-देन
• कस्टम डेटा प्रकार
• संचार (BelongsTo, HasMany, HasManyThrough)
• छंटाई
• फ़िल्टर (जहाँ =; = =, IN, NOT IN और अन्य)
• संघों
• कोकोपोड्स समर्थन करते हैं

निष्कर्ष

निष्कर्ष को सही ठहराने के लिए , मैं कहना चाहता हूं कि यह परियोजना सिर्फ मनोरंजन के लिए शुरू हुई थी, और यह विकसित करना जारी है, अंत में "गंदे" कोड का एक गुच्छा साफ करने और अन्य उपयोगी सुविधाओं को जोड़ने की योजना है।

मैं पर्याप्त आलोचना सुनकर प्रसन्न हूं।

PS लैन को त्रुटि संदेश लिखें, कृपया।