30分鐘快速帶你理解iOS中的謂詞NSPredicate

更新時(shí)間：2018年03月14日 08:54:03 作者：琿少

NSPredicate類是用來(lái)定義邏輯條件約束的獲取或內(nèi)存中的過(guò)濾搜索。下面這篇文章將通過(guò)30分鐘快速帶大家理解iOS中的謂詞NSPredicate類，文中通過(guò)示例代碼介紹的非常詳細(xì)，需要的朋友可以參考借鑒，下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧。

一、引言

在現(xiàn)代漢語(yǔ)的解釋中，謂詞是用來(lái)描述或判斷客體性質(zhì)、特征或者客體之間關(guān)系的詞項(xiàng)。通俗的說(shuō)，它是描述事物屬性的。在iOS開發(fā)Cocoa框架中，有提供NSPredicate類，這個(gè)類通常也被成為謂詞類，其主要的作用是在Cocoa中幫助查詢和檢索，但是需要注意，實(shí)質(zhì)上謂詞并不是提供查詢和檢索的支持，它是一種描述查詢檢索條件的方式，就像更加標(biāo)準(zhǔn)通用的正則表達(dá)式一樣。

NSPredicate提供的謂詞可以分為兩類：比較謂詞和復(fù)合謂詞。

比較謂詞：比較謂詞通過(guò)使用比較運(yùn)算符來(lái)描述所符合條件的屬性狀態(tài)。
復(fù)合謂詞：復(fù)合謂詞用來(lái)組合多個(gè)比較謂詞的結(jié)果，取交集，并集或補(bǔ)集。

對(duì)于比較謂詞，可以描述精準(zhǔn)的比較也可以通過(guò)范圍或者包含等進(jìn)行模糊比較。需要注意，任何Cocoa類對(duì)象都可以支持謂詞，但是此類需要實(shí)現(xiàn)鍵值編碼(key-value-coding)協(xié)議。

二、NSPredicate類的應(yīng)用解析

NSPredicate提供創(chuàng)建謂詞對(duì)象和解析謂詞對(duì)象的方法，它也是Cocoa中有關(guān)謂詞的類中的基類。我們?cè)谌粘ｉ_發(fā)中，NSPredicate類的應(yīng)用頻率也最高。

創(chuàng)建謂詞對(duì)象有3種方式，分別是通過(guò)格式化字符串創(chuàng)建謂詞，直接通過(guò)代碼創(chuàng)建謂詞，通過(guò)模板創(chuàng)建謂詞。NSPredicate提供了如下函數(shù)來(lái)進(jìn)行初始化：

//通過(guò)格式化字符串來(lái)進(jìn)行謂詞對(duì)象的初始化
+ (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat argumentArray:(nullable NSArray *)arguments;
+ (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat, ...;
+ (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat arguments:(va_list)argList;

使用格式化字符串進(jìn)行謂詞的初始化十分靈活，但是需要注意，其謂詞字符串的語(yǔ)法和正則表達(dá)式并不一樣，后面會(huì)有具體的介紹，下面是一個(gè)謂詞檢索示例：

 //檢索屬性length為5的對(duì)象
 NSPredicate * predicate = [NSPredicate predicateWithFormat:@"length = 5"];
 //對(duì)于這個(gè)數(shù)組中的字符串，即是檢索字符串長(zhǎng)度為5的元素
 NSArray * test = @[@"sda",@"321",@"sf12",@"dsdwq1",@"swfas"];
 NSArray * result = [test filteredArrayUsingPredicate:predicate];
 //將打印@[@"swfas"]
 NSLog(@"%@",result);

其實(shí)，你也可以像使用NSLog函數(shù)一樣來(lái)進(jìn)行格式化字符串的構(gòu)造，可以使用%@,%d等等格式化字符來(lái)在運(yùn)行時(shí)替換為變量的實(shí)際值。同時(shí)也需要注意，這種格式化字符串創(chuàng)建的謂詞語(yǔ)句并不會(huì)進(jìn)行語(yǔ)法檢查，錯(cuò)誤的語(yǔ)法會(huì)產(chǎn)生運(yùn)行時(shí)錯(cuò)誤，要格外小心。有一個(gè)小細(xì)節(jié)需要注意，在進(jìn)行格式化時(shí)，如果使用的是變量則不需要添加引號(hào)，解析器會(huì)幫助你添加，如果使用到常量，則要用轉(zhuǎn)義字符進(jìn)行轉(zhuǎn)義，例如：

NSPredicate * predicate = [NSPredicate predicateWithFormat:@"name = %@ && age = \"25\"",name];

對(duì)于屬性名，如果也需要進(jìn)行格式化，需要注意不能使用%@符號(hào)，這個(gè)符號(hào)在解析時(shí)會(huì)被解析器自動(dòng)添加上引號(hào)，可以使用%K，示例如下：

 NSString * key = @"length";
 NSPredicate * predicate = [NSPredicate predicateWithFormat:@"%K = 5",key];
 NSArray * test = @[@"sda",@"321",@"sf12",@"dsdwq1",@"swfas"];
 NSArray * result = [test filteredArrayUsingPredicate:predicate];
 //將打印@[@"swfas"]
 NSLog(@"%@",result);

通過(guò)模板來(lái)創(chuàng)建謂詞對(duì)象也是一種十分常用的方式，和格式化字符串不同的是，謂詞模板中只有鍵名，沒(méi)有鍵值，鍵值需要在字典中進(jìn)行提供，例如：

 NSPredicate * predicate = [NSPredicate predicateWithFormat:@"length = $LENGTH"];
 predicate = [predicate predicateWithSubstitutionVariables:@{@"LENGTH":@5}];
 NSArray * test = @[@"sda",@"321",@"sf12",@"dsdwq1",@"swfas"];
 NSArray * result = [test filteredArrayUsingPredicate:predicate];
 //將打印@[@"swfas"]
 NSLog(@"%@",result);

NSPredicate中其他屬性與方法解析如下：

//創(chuàng)建一個(gè)總是驗(yàn)證通過(guò)(YES)或不通過(guò)(NO)的謂詞對(duì)象
/*
如果創(chuàng)建的是驗(yàn)證通過(guò)的，則任何檢索都會(huì)成功進(jìn)行返回，否則任何檢索都會(huì)失敗不返回任何對(duì)象
*/
+ (NSPredicate *)predicateWithValue:(BOOL)value;
//自定義實(shí)現(xiàn)檢索函數(shù)
/*

例如前面的示例也可以這樣寫

NSPredicate * predicate = [NSPredicate predicateWithBlock:^BOOL(id _Nullable evaluatedObject, NSDictionary<NSString *,id> * _Nullable bindings) {
 if ([evaluatedObject length]==5) {
 return YES;
 }
 return NO;
 }];
*/
+ (NSPredicate*)predicateWithBlock:(BOOL (^)(id _Nullable evaluatedObject, NSDictionary<NSString *, id> * _Nullable bindings))block;
//格式化字符串屬性
@property (readonly, copy) NSString *predicateFormat; 
//當(dāng)使用謂詞模板來(lái)進(jìn)行對(duì)象創(chuàng)建時(shí)，這個(gè)函數(shù)用來(lái)設(shè)置謂詞模板中變量替換
- (instancetype)predicateWithSubstitutionVariables:(NSDictionary<NSString *, id> *)variables;
//檢查一個(gè)Object對(duì)象是否可以通過(guò)驗(yàn)證
- (BOOL)evaluateWithObject:(nullable id)object; 
//用謂詞模板進(jìn)行對(duì)象的驗(yàn)證
- (BOOL)evaluateWithObject:(nullable id)object substitutionVariables:(nullable NSDictionary<NSString *, id> *)bindings;

三、通過(guò)代碼來(lái)創(chuàng)建謂詞對(duì)象

前面我們說(shuō)有3種創(chuàng)建謂詞對(duì)象的方式，有兩種我們已經(jīng)有介紹，通過(guò)代碼直接創(chuàng)建謂詞對(duì)象是最復(fù)雜的一種。通過(guò)代碼來(lái)創(chuàng)建謂詞對(duì)象十分類似通過(guò)代碼來(lái)創(chuàng)建Autolayout約束。通過(guò)前面我們的介紹，謂詞實(shí)際是用表達(dá)式來(lái)驗(yàn)證對(duì)象，用代碼來(lái)創(chuàng)建謂詞實(shí)際就是用代碼來(lái)創(chuàng)建表達(dá)式。

1.先來(lái)看NSComparisonPredicate類

這個(gè)類是NSPredicate的子類，其用來(lái)創(chuàng)建比較類型的謂詞。例如使用下面的代碼來(lái)改寫上面的例子：

 //創(chuàng)建左側(cè)表達(dá)式對(duì)象 對(duì)應(yīng)為鍵
 NSExpression * left = [NSExpression expressionForKeyPath:@"length"];
 //創(chuàng)建右側(cè)表達(dá)式對(duì)象 對(duì)應(yīng)為值
 NSExpression * right = [NSExpression expressionForConstantValue:[NSNumber numberWithInt:5]];
 //創(chuàng)建比較謂詞對(duì)象 這里設(shè)置為嚴(yán)格等于
 NSComparisonPredicate * pre = [NSComparisonPredicate predicateWithLeftExpression:left rightExpression:right modifier:NSDirectPredicateModifier type:NSEqualToPredicateOperatorType options:NSCaseInsensitivePredicateOption];
 NSArray * test = @[@"sda",@"321",@"sf12",@"dsdwq1",@"swfas"];
 NSArray * result = [test filteredArrayUsingPredicate:pre];
 //將打印@[@"swfas"]
 NSLog(@"%@",result);

NSComparisonPredicateModifier用來(lái)進(jìn)行條件的修飾設(shè)置，枚舉如下：

typedef NS_ENUM(NSUInteger, NSComparisonPredicateModifier) {
 NSDirectPredicateModifier = 0, //直接進(jìn)行比較操作
 NSAllPredicateModifier, //用于數(shù)組或集合 只有當(dāng)內(nèi)部所有元素都通過(guò)驗(yàn)證時(shí) 集合才算通過(guò)
 NSAnyPredicateModifier //同于數(shù)組或集合 當(dāng)內(nèi)部有一個(gè)元素滿足時(shí) 集合算通過(guò)驗(yàn)證
};

關(guān)于NSAllPredicateModifier和NSAnyPredicateModifier，這兩個(gè)枚舉專門用于數(shù)組或集合類型對(duì)象的驗(yàn)證，ALL會(huì)驗(yàn)證其中所有元素，全部通過(guò)后數(shù)組或集合才算驗(yàn)證通過(guò)，ANY則只要有一個(gè)元素驗(yàn)證通過(guò)，數(shù)組或集合就算驗(yàn)證通過(guò)，例如：

 NSPredicate * pre = [NSPredicate predicateWithFormat:@"ALL length = 5"];
 NSArray * test = @[@[@"aaa",@"aa"],@[@"bbbb",@"bbbbb"],@[@"ccccc",@"ccccc"]];
 NSArray * result = [test filteredArrayUsingPredicate:pre];
 //將打印@[@[@"ccccc",@"ccccc"]]
 NSLog(@"%@",result);

NSPredicateOperatorType枚舉用來(lái)設(shè)置運(yùn)算符類型，如下：

typedef NS_ENUM(NSUInteger, NSPredicateOperatorType) {
 NSLessThanPredicateOperatorType = 0, // 小于
 NSLessThanOrEqualToPredicateOperatorType, // 小于等于
 NSGreaterThanPredicateOperatorType, // 大于
 NSGreaterThanOrEqualToPredicateOperatorType, // 大于等于
 NSEqualToPredicateOperatorType, // 等于
 NSNotEqualToPredicateOperatorType, //不等于
 NSMatchesPredicateOperatorType, //正則比配
 NSLikePredicateOperatorType, //Like匹配 與SQL類似
 NSBeginsWithPredicateOperatorType, //左邊的表達(dá)式 以右邊的表達(dá)式作為開頭
 NSEndsWithPredicateOperatorType,//左邊的表達(dá)式 以右邊的表達(dá)式作為結(jié)尾
 NSInPredicateOperatorType, // 左邊的表達(dá)式 出現(xiàn)在右邊的集合中 
 NSCustomSelectorPredicateOperatorType,//使用自定義的函數(shù)來(lái)進(jìn)行 驗(yàn)證
 NSContainsPredicateOperatorType, //左邊的集合包括右邊的元素
 NSBetweenPredicateOperatorType //左邊表達(dá)式的值在右邊的范圍中 例如 1 BETWEEN { 0 , 33 }
};

NSComparisonPredicateOptions枚舉用來(lái)設(shè)置比較的方式，如下：

//如果不需要特殊指定 這個(gè)枚舉值也可以傳0
typedef NS_OPTIONS(NSUInteger, NSComparisonPredicateOptions) {
 NSCaseInsensitivePredicateOption = 0x01, //不區(qū)分大小寫
 NSDiacriticInsensitivePredicateOption = 0x02,//不區(qū)分讀音符號(hào)
 NSNormalizedPredicateOption //比較前進(jìn)行預(yù)處理 代替上面兩個(gè)選項(xiàng)
};

2.NSExpression類

NSExpression類則是提供創(chuàng)建表達(dá)式，下面列出了其中一些方便理解的方法：

//通過(guò)格式化字符串創(chuàng)建表達(dá)式
+ (NSExpression *)expressionWithFormat:(NSString *)expressionFormat argumentArray:(NSArray *)arguments;
+ (NSExpression *)expressionWithFormat:(NSString *)expressionFormat, ...;
+ (NSExpression *)expressionWithFormat:(NSString *)expressionFormat arguments:(va_list)argList;
//直接通過(guò)對(duì)象創(chuàng)建常亮的表達(dá)式
+ (NSExpression *)expressionForConstantValue:(nullable id)obj; 
//創(chuàng)建變量表達(dá)式 驗(yàn)證時(shí)將從binding字典中進(jìn)行替換
+ (NSExpression *)expressionForVariable:(NSString *)string; 
//將多個(gè)表達(dá)式組合成一個(gè)
+ (NSExpression *)expressionForAggregate:(NSArray<NSExpression *> *)subexpressions;
+ (NSExpression *)expressionForUnionSet:(NSExpression *)left with:(NSExpression *)right;
+ (NSExpression *)expressionForIntersectSet:(NSExpression *)left with:(NSExpression *)right;
+ (NSExpression *)expressionForMinusSet:(NSExpression *)left with:(NSExpression *)right;
+ (NSExpression *)expressionForSubquery:(NSExpression *)expression usingIteratorVariable:(NSString *)variable predicate:(NSPredicate *)predicate;
//通過(guò)預(yù)定義的函數(shù)和參數(shù)數(shù)組來(lái)構(gòu)建表達(dá)式對(duì)象 預(yù)定義的函數(shù) 可見(jiàn)dev開發(fā)文檔
+ (NSExpression *)expressionForFunction:(NSString *)name arguments:(NSArray *)parameters;

3.NSCompoundPredicate類

這個(gè)類也是NSPredicate類的子類，其使用邏輯關(guān)系來(lái)組合多個(gè)謂詞對(duì)象，解析如下：

//進(jìn)行對(duì)象初始化
/*
typedef NS_ENUM(NSUInteger, NSCompoundPredicateType) {
 NSNotPredicateType = 0, //取非
 NSAndPredicateType, //與運(yùn)算 
 NSOrPredicateType, //或運(yùn)算
};
*/
- (instancetype)initWithType:(NSCompoundPredicateType)type subpredicates:(NSArray<NSPredicate *> *)subpredicates;
//快速創(chuàng)建與運(yùn)算
+ (NSCompoundPredicate *)andPredicateWithSubpredicates:(NSArray<NSPredicate *> *)subpredicates;
//快速創(chuàng)建或運(yùn)算
+ (NSCompoundPredicate *)orPredicateWithSubpredicates:(NSArray<NSPredicate *> *)subpredicates;
//快速創(chuàng)建非運(yùn)算
+ (NSCompoundPredicate *)notPredicateWithSubpredicate:(NSPredicate *)predicate;

四、謂詞的幾種使用場(chǎng)景

謂詞主要用在驗(yàn)證對(duì)象，數(shù)組和集合的過(guò)濾。對(duì)象的驗(yàn)證前面有介紹，關(guān)于數(shù)據(jù)和集合的過(guò)濾函數(shù)，類別如下：

@interface NSArray<ObjectType> (NSPredicateSupport)
//不可變數(shù)組使用過(guò)濾器后返回新數(shù)組
- (NSArray<ObjectType> *)filteredArrayUsingPredicate:(NSPredicate *)predicate; 
@end
@interface NSMutableArray<ObjectType> (NSPredicateSupport)
//可變數(shù)組可以直接進(jìn)行過(guò)濾操作
- (void)filterUsingPredicate:(NSPredicate *)predicate;
@end
@interface NSSet<ObjectType> (NSPredicateSupport)
//不可變集合過(guò)濾后返回新集合
- (NSSet<ObjectType> *)filteredSetUsingPredicate:(NSPredicate *)predicate;
@end
@interface NSMutableSet<ObjectType> (NSPredicateSupport)
//可變集合可以直接進(jìn)行過(guò)濾操作
- (void)filterUsingPredicate:(NSPredicate *)predicate;
@end
@interface NSOrderedSet<ObjectType> (NSPredicateSupport)
- (NSOrderedSet<ObjectType> *)filteredOrderedSetUsingPredicate:(NSPredicate *)p;
@end
@interface NSMutableOrderedSet<ObjectType> (NSPredicateSupport)
- (void)filterUsingPredicate:(NSPredicate *)p;
@end

五、謂詞的格式化語(yǔ)法總覽

下面列出了在謂詞的格式化字符串規(guī)則語(yǔ)法。

語(yǔ)法規(guī)則	意義
=	左側(cè)等于右側(cè)
==	左側(cè)等于右側(cè)，與=一致
>=	左側(cè)大于等于右側(cè)
=>	左側(cè)大于等于右側(cè) 與 >=一致
<=	左側(cè)小于等于右側(cè)
=<	左側(cè)小于等于右側(cè) 與<=一致
>	左側(cè)大于右側(cè)
<	左側(cè)小于右側(cè)
!=	左側(cè)不等于右側(cè)
<>	左側(cè)不等于右側(cè) 與!=一致
BETWEEN	左側(cè)在右側(cè)的集合中 key BETWEEN @[@1,@2]
TRUEPREDICATE	總是返回YES的謂詞
FALSEPREDICATE	總是返回NO的謂詞
AND	邏輯與
&&	邏輯與與AND一致
OR	邏輯或
\|\|	邏輯或與OR一致
NOT	邏輯非
!	邏輯非與NOT一致
BEGINWITH	左側(cè)以右側(cè)字符串開頭
ENDWITH	左側(cè)以右側(cè)字符串結(jié)尾
CONTAINS	左側(cè)集合包含右側(cè)元素
LIKE	左側(cè)等于右側(cè) 并且 *和?等通配符可以使用
MATCHES	正則匹配
ANY	對(duì)于數(shù)組集合類，驗(yàn)證其中任一元素
SOME	同ANY一致
ALL	對(duì)于數(shù)組集合類，驗(yàn)證其中所有元素
NONE	作用等同于NOT (ANY)
IN	左側(cè)在右側(cè)集合中
SELF	被驗(yàn)證的對(duì)象本身