30分鐘摸透iOS中謂詞NSPredicate的前因後果

30分鐘摸透iOS中謂詞NSPredicate的前因後果

1、引言

    在現代漢語的解釋中，謂詞是用來描述或判斷客體性質、特徵或者客體之間關係的詞項。通俗的說，它是描述事物屬性的。在iOS開發Cocoa框架中，有提供NSPredicate類，這個類一般也被成爲謂詞類，其主要的做用是在Cocoa中幫助查詢和檢索，可是須要注意，實質上謂詞並非提供查詢和檢索的支持，它是一種描述查詢檢索條件的方式，就像更加標準通用的正則表達式同樣。

    NSPredicate提供的謂詞能夠分爲兩類：比較謂詞和複合謂詞。

• 比較謂詞：比較謂詞經過使用比較運算符來描述所符合條件的屬性狀態。
• 複合謂詞：複合謂詞用來組合多個比較謂詞的結果，取交集，並集或補集。

對於比較謂詞，能夠描述精準的比較也能夠經過範圍或者包含等進行模糊比較。須要注意，任何Cocoa類對象均可以支持謂詞，可是此類須要實現鍵值編碼(key-value-coding)協議。

2、NSPredicate類的應用解析

    NSPredicate提供建立謂詞對象和解析謂詞對象的方法，它也是Cocoa中有關謂詞的類中的基類。咱們在平常開發中，NSPredicate類的應用頻率也最高。

    建立謂詞對象有3種方式，分別是經過格式化字符串建立謂詞，直接經過代碼建立謂詞，經過模板建立謂詞。NSPredicate提供了以下函數來進行初始化：

//經過格式化字符串來進行謂詞對象的初始化
+ (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat argumentArray:(nullable NSArray *)arguments;
+ (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat, ...;
+ (NSPredicate *)predicateWithFormat:(NSString *)predicateFormat arguments:(va_list)argList;

使用格式化字符串進行謂詞的初始化十分靈活，可是須要注意，其謂詞字符串的語法和正則表達式並不同，後面會有具體的介紹，下面是一個謂詞檢索示例：

//檢索屬性length爲5的對象
    NSPredicate *  predicate = [NSPredicate predicateWithFormat:@"length = 5"];
    //對於這個數組中的字符串，便是檢索字符串長度爲5的元素
    NSArray * test = @[@"sda",@"321",@"sf12",@"dsdwq1",@"swfas"];
    NSArray * result = [test filteredArrayUsingPredicate:predicate];
    //將打印@[@"swfas"]
    NSLog(@"%@",result);

其實，你也能夠像使用NSLog函數同樣來進行格式化字符串的構造，可使用%@,%d等等格式化字符來在運行時替換爲變量的實際值。同時也須要注意，這種格式化字符串建立的謂詞語句並不會進行語法檢查，錯誤的語法會產生運行時錯誤，要格外當心。有一個小細節須要注意，在進行格式化時，若是使用的是變量則不須要添加引號，解析器會幫助你添加，若是使用到常量，則要用轉義字符進行轉義，例如：

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

對於屬性名，若是也須要進行格式化，須要注意不能使用%@符號，這個符號在解析時會被解析器自動添加上引號，可使用%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);

    經過模板來建立謂詞對象也是一種十分經常使用的方式，和格式化字符串不一樣的是，謂詞模板中只有鍵名，沒有鍵值，鍵值須要在字典中進行提供，例如：

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中其餘屬性與方法解析以下：

//建立一個老是驗證經過(YES)或不經過(NO)的謂詞對象
/*
若是建立的是驗證經過的，則任何檢索都會成功進行返回，不然任何檢索都會失敗不返回任何對象
*/
+ (NSPredicate *)predicateWithValue:(BOOL)value;
//自定義實現檢索函數
/*
例如前面的示例也能夠這樣寫
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;  
//當使用謂詞模板來進行對象建立時，這個函數用來設置謂詞模板中變量替換
- (instancetype)predicateWithSubstitutionVariables:(NSDictionary<NSString *, id> *)variables;
//檢查一個Object對象是否能夠經過驗證
- (BOOL)evaluateWithObject:(nullable id)object; 
//用謂詞模板進行對象的驗證
- (BOOL)evaluateWithObject:(nullable id)object substitutionVariables:(nullable NSDictionary<NSString *, id> *)bindings;

3、經過代碼來建立謂詞對象

    前面咱們說有3種建立謂詞對象的方式，有兩種咱們已經有介紹，經過代碼直接建立謂詞對象是最複雜的一種。經過代碼來建立謂詞對象十分相似經過代碼來建立Autolayout約束。經過前面咱們的介紹，謂詞實際是用表達式來驗證對象，用代碼來建立謂詞實際就是用代碼來建立表達式。

1.先來看NSComparisonPredicate類

    這個類是NSPredicate的子類，其用來建立比較類型的謂詞。例如使用下面的代碼來改寫上面的例子：

//建立左側表達式對象 對應爲鍵
    NSExpression * left = [NSExpression expressionForKeyPath:@"length"];
    //建立右側表達式對象 對應爲值
    NSExpression * right = [NSExpression expressionForConstantValue:[NSNumber numberWithInt:5]];
    //建立比較謂詞對象 這裏設置爲嚴格等於
    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用來進行條件的修飾設置，枚舉以下：

typedef NS_ENUM(NSUInteger, NSComparisonPredicateModifier) {
    NSDirectPredicateModifier = 0, //直接進行比較操做
    NSAllPredicateModifier,  //用於數組或集合 只有當內部全部元素都經過驗證時 集合纔算經過
    NSAnyPredicateModifier  //同於數組或集合 當內部有一個元素知足時 集合算經過驗證
};

關於NSAllPredicateModifier和NSAnyPredicateModifier，這兩個枚舉專門用於數組或集合類型對象的驗證，ALL會驗證其中全部元素，所有經過後數組或集合纔算驗證經過，ANY則只要有一個元素驗證經過，數組或集合就算驗證經過，例如：

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枚舉用來設置運算符類型，以下：

typedef NS_ENUM(NSUInteger, NSPredicateOperatorType) {
    NSLessThanPredicateOperatorType = 0, // 小於
    NSLessThanOrEqualToPredicateOperatorType, // 小於等於
    NSGreaterThanPredicateOperatorType, // 大於
    NSGreaterThanOrEqualToPredicateOperatorType, // 大於等於
    NSEqualToPredicateOperatorType, // 等於
    NSNotEqualToPredicateOperatorType, //不等於
    NSMatchesPredicateOperatorType, //正則比配
    NSLikePredicateOperatorType,  //Like匹配 與SQL相似
    NSBeginsWithPredicateOperatorType, //左邊的表達式 以右邊的表達式做爲開頭
    NSEndsWithPredicateOperatorType,//左邊的表達式 以右邊的表達式做爲結尾
    NSInPredicateOperatorType, // 左邊的表達式 出如今右邊的集合中 
    NSCustomSelectorPredicateOperatorType,//使用自定義的函數來進行 驗證
    NSContainsPredicateOperatorType, //左邊的集合包括右邊的元素
    NSBetweenPredicateOperatorType //左邊表達式的值在右邊的範圍中 例如 1 BETWEEN { 0 , 33 }
};

NSComparisonPredicateOptions枚舉用來設置比較的方式，以下：

//若是不須要特殊指定  這個枚舉值也能夠傳0
typedef NS_OPTIONS(NSUInteger, NSComparisonPredicateOptions) {
    NSCaseInsensitivePredicateOption = 0x01, //不區分大小寫
    NSDiacriticInsensitivePredicateOption = 0x02,//不區分讀音符號
    NSNormalizedPredicateOption //比較前進行預處理 代替上面兩個選項
};

2.NSExpression類

    NSExpression類則是提供建立表達式，下面列出了其中一些方便理解的方法：

//經過格式化字符串建立表達式
+ (NSExpression *)expressionWithFormat:(NSString *)expressionFormat argumentArray:(NSArray *)arguments;
+ (NSExpression *)expressionWithFormat:(NSString *)expressionFormat, ...;
+ (NSExpression *)expressionWithFormat:(NSString *)expressionFormat arguments:(va_list)argList;
//直接經過對象建立常亮的表達式
+ (NSExpression *)expressionForConstantValue:(nullable id)obj; 
//建立變量表達式  驗證時將從binding字典中進行替換
+ (NSExpression *)expressionForVariable:(NSString *)string; 
//將多個表達式組合成一個
+ (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;
//經過預約義的函數和參數數組來構建表達式對象  預約義的函數 可見dev開發文檔
+ (NSExpression *)expressionForFunction:(NSString *)name arguments:(NSArray *)parameters;

3.NSCompoundPredicate類

    這個類也是NSPredicate類的子類，其使用邏輯關係來組合多個謂詞對象，解析以下：

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

4、謂詞的幾種使用場景

    謂詞主要用在驗證對象，數組和集合的過濾。對象的驗證前面有介紹，關於數據和集合的過濾函數，類別以下：

@interface NSArray<ObjectType> (NSPredicateSupport)
//不可變數組使用過濾器後返回新數組
- (NSArray<ObjectType> *)filteredArrayUsingPredicate:(NSPredicate *)predicate; 
@end

@interface NSMutableArray<ObjectType> (NSPredicateSupport)
//可變數組能夠直接進行過濾操做
- (void)filterUsingPredicate:(NSPredicate *)predicate;
@end

@interface NSSet<ObjectType> (NSPredicateSupport)
//不可變集合過濾後返回新集合
- (NSSet<ObjectType> *)filteredSetUsingPredicate:(NSPredicate *)predicate;
@end

@interface NSMutableSet<ObjectType> (NSPredicateSupport)
//可變集合能夠直接進行過濾操做
- (void)filterUsingPredicate:(NSPredicate *)predicate;
@end

@interface NSOrderedSet<ObjectType> (NSPredicateSupport)

- (NSOrderedSet<ObjectType> *)filteredOrderedSetUsingPredicate:(NSPredicate *)p;

@end

@interface NSMutableOrderedSet<ObjectType> (NSPredicateSupport)

- (void)filterUsingPredicate:(NSPredicate *)p;

@end

5、謂詞的格式化語法總覽

    下面列出了在謂詞的格式化字符串規則語法。

語法規則	意義
=	左側等於右側
==	左側等於右側，與=一致
>=	左側大於等於右側
=>	左側大於等於右側 與 >=一致
<=	左側小於等於右側
=<	左側小於等於右側 與<=一致
>	左側大於右側
<	左側小於右側
!=	左側不等於右側
<>	左側不等於右側 與!=一致
BETWEEN	左側在右側的集合中 key BETWEEN @[@1,@2]
TRUEPREDICATE	老是返回YES的謂詞
FALSEPREDICATE	老是返回NO的謂詞
AND	邏輯與
&&	邏輯與 與AND一致
OR	邏輯或
||	邏輯或 與OR一致
NOT	邏輯非
!	邏輯非 與NOT一致
BEGINWITH	左側以右側字符串開頭
ENDWITH	左側以右側字符串結尾
CONTAINS	左側集合包含右側元素
LIKE	左側等於右側 而且 *和?等通配符可使用
MATCHES	正則匹配
ANY	對於數組集合類，驗證其中任一元素
SOME	同ANY一致
ALL	對於數組集合類，驗證其中全部元素
NONE	做用等同於NOT (ANY)
IN	左側在右側集合中
SELF	被驗證的對象自己