【iOS】NSPredicate 谓词的使用

参考
iOS-谓词的使用详解
NSPredicate 谓词

NSPredicate

A definition of logical conditions used to constrain a search either for a fetch or for in-memory filtering.
一种逻辑条件的定义，可以根据定义的模糊查询条件，对内存对象进行过滤搜索。

1.比较运算符

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSNumber *number = @123;
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF = 123"];
        NSLog(@"%@", [predicate evaluateWithObject:number] ? @"YES" : @"NO");
    }
    return 0;
}

// RESULT : YES

=、==：判断两个表达式是否相等
<=：判断右边表达式的值是否小于或等于右边表达式的值
>=：判断左边表达式的值是否大于右边表达式的值
<：判断左边表达式的值是否小于右边表达式的值
> ：判断左边表达式的值是否大于右边表达式的值
!=：判断两个表达式是否不相等

BETWEEN {下限，上限}：必须大于或等于下限，并小于或等于上限

 		NSNumber *number = @123;
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF BETWEEN {100, 123} "];
        NSLog(@"%@", [predicate evaluateWithObject:number] ? @"YES" : @"NO");

// RESULT : YES

2.逻辑运算符

        NSArray *array = @[@1, @2, @3, @4, @5];
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF > 2 && SELF < 5"];
        NSArray *filterArray = [array filteredArrayUsingPredicate:predicate];
        NSLog(@"%@", filterArray);

// RESULT : (
    3,
    4
)

AND、&&：逻辑与，要求两个表达式的值都为YES时，结果才为YES
OR、||：逻辑或，要求其中一个表达式为YES时，结果就是YES
NOT、 !：逻辑非，对原有的表达式取反

3.字符串比较运算符

        NSString *string = @"abcd";
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@" %@ BEGINSWITH 'a'", string];
        NSLog(@"%@", [predicate evaluateWithObject:string] ? @"YES" : @"NO");

// RESULT : YES

ENDSWITH ：检查某个字符串是否以指定的字符串结尾
CONTAINS ：检查某个字符串是否包含指定的字符串

LIKE ：检查某个字符串是否匹配指定的字符串模板。其之后可以跟?代表一个字符和*代表任意多个字符两个通配符。比如"name LIKE '*ac*'"，这表示name的值中包含ac则返回YES；"name LIKE '?ac*'"，表示name的第2、3个字符为ac时返回YES。

MATCHES：检查某个字符串是否匹配指定的正则表达式。虽然正则表达式的执行效率并不高，但其功能是最强大的，也是我们最常用的。

注： 字符串比较都是区分大小写和重音符号的。如：café和cafe是不一样的，Cafe和cafe也是不一样的。如果希望字符串比较运算不区分大小写和重音符号，请在这些运算符后使用[c]，[d]选项。其中[c]是不区分大小写，[d]是不区分重音符号，其写在字符串比较运算符之后，比如："name LIKE[cd] 'cafe'"，那么不论name是cafe、Cafe还是café上面的表达式都会返回YES。

4.集合运算符

ANY、SOME ：集合中任意一个元素满足条件，就返回YES。

ALL ：集合中所有元素都满足条件，才返回YES。

NONE ：集合中没有任何元素满足条件就返回YES。如:NONE person.age<18，表示person集合中所有元素的age>=18时，才返回YES。

IN：等价于SQL语句中的IN运算符，只有当左边表达式或值出现在右边的集合中才会返回YES。

        NSArray *array1 = @[@"a", @"ab", @"abc" ,@"abcd"];
        NSArray *array2 = @[@"ab", @"abc" ];
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF IN %@", array1];
        NSLog(@"%@", [array2 filteredArrayUsingPredicate:predicate]);

// RESULT : (
    ab,
    abc
)

5.直接量

在谓词表达式中可以使用如下直接量 :

FALSE、NO：代表逻辑假
TRUE、YES：代表逻辑真
NULL、NIL：代表空值

SELF ：代表正在被判断的对象自身

"string"或'string'：代表字符串
数组：和c中的写法相同，如：{'one', 'two', 'three'}。
数值：包括整数、小数和科学计数法表示的形式
十六进制数：0x开头的数字
八进制：0o开头的数字
二进制：0b开头的数字

实例

简单的使用

//  1.判断姓名是否是以s开头的，上面已经用过BEGINSWITH方法，这里用LIKE
NSPredicate *pred1 = [NSPredicate predicateWithFormat:@"name LIKE 's*'"];
NSLog(@"sunnyzl:%d, jack:%d", [pred1 evaluateWithObject:sunnyzl], [pred1 evaluateWithObject:jack]);
//  输出为：sunnyzl:1, jack:0

//  2.判断年龄是否大于25
NSPredicate *pred2 = [NSPredicate predicateWithFormat:@"age > 25"];
NSLog(@"sunnyzl的年龄是否大于25：%d, jack的年龄是否大于25：%d", [pred2 evaluateWithObject:sunnyzl], [pred2 evaluateWithObject:jack]);
//  输出为：sunnyzl的年龄是否大于25：1, jack的年龄是否大于25：0

搭配正则表达式使用

        NSString *regex = @"^[1][3-8]\\d{9}$";
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF MATCHES %@", regex];
        NSLog(@"%d", [predicate evaluateWithObject:@"13888888888"]);
        
// RESULT : 1

使用谓词过滤集合

此部分是我们需要掌握的重点，因为从这里我们就可以看到谓词的真正的强大之处

其实谓词本身就代表了一个逻辑条件，计算谓词之后返回的结果永远为BOOL类型的值。而谓词最常用的功能就是对集合进行过滤。当程序使用谓词对集合元素进行过滤时，程序会自动遍历其元素，并根据集合元素来计算谓词的值，当这个集合中的元素计算谓词并返回YES时，这个元素才会被保留下来。请注意程序会自动遍历其元素，它会将自动遍历过之后返回为YES的值重新组合成一个集合返回。

• NSArray提供了如下方法使用谓词来过滤集合
  -- (NSArray<ObjectType> *)filteredArrayUsingPredicate:(NSPredicate *)predicate;使用指定的谓词过滤NSArray集合，返回符合条件的元素组成的新集合

        NSArray *array = @[@"aaajson", @"bbbjson", @"cccson", @"ddddd"];
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF CONTAINS 'json'"];
        NSArray *newArray = [array filteredArrayUsingPredicate:predicate];
        NSLog(@"%@",newArray);

// RESULT:(
    aaajson,
    bbbjson
)

• NSMutableArray提供了如下方法使用谓词来过滤集合
  - (void)filterUsingPredicate:(NSPredicate *)predicate;使用指定的谓词过滤NSMutableArray，剔除集合中不符合条件的元素

        NSMutableArray *arrayM = [@[@10, @20, @30, @40, @50, @60, @70] mutableCopy];
        NSPredicate *predicate = [NSPredicate predicateWithFormat:@"SELF > 50"];
        [arrayM filterUsingPredicate:predicate];
        NSLog(@"%@", arrayM);
        
// RESULT:(
    60,
    70
)

• NSSet提供了如下方法使用谓词来过滤集合
  - (NSSet<ObjectType> *)filteredSetUsingPredicate:(NSPredicate *)predicate作用同NSArray中的方法

• NSMutableSet提供了如下方法使用谓词来过滤集合
  - (void)filterUsingPredicate:(NSPredicate *)predicate作用同NSMutableArray中的方法。

通过上面的描述可以看出，使用谓词过滤不可变集合和可变集合的区别是：过滤不可变集合时，会返回符合条件的集合元素组成的新集合；过滤可变集合时，没有返回值，会直接剔除不符合条件的集合元素

在谓词中使用占位符参数

首先如果我们想在谓词表达式中使用变量，那么我们需要了解下列两种占位符：

%K：用于动态传入属性名

%@：用于动态设置属性值

其实相当于变量名与变量值，除此之外，还可以在谓词表达式中使用动态改变的属性值，就像环境变量一样

NSPredicate *pred = [NSPredicate predicateWithFormat:@"SELF CONTAINS $VALUE"];

上述表达式中，$VALUE是一个可以动态变化的值，它其实最后是在字典中的一个key，所以可以根据你的需要写不同的值，但是必须有 $ 开头，随着程序改变$VALUE这个谓词表达式的比较条件就可以动态改变。

下面我们通过一个例子来看看这三个重要的占位符应该如何使用

NSArray *array = @[[PersonModel personWithName:@"Jack" age:20],
[PersonModel personWithName:@"Rose" age:22],
[PersonModel personWithName:@"Jackson" age:30],
[PersonModel personWithName:@"Johnson" age:35];
//  定义一个property来存放属性名，定义一个value来存放值
NSString *property = @"name";
NSString *value = @"Jack";
//  该谓词的作用是如果元素中property属性含有值value时就取出放入新的数组内，这里是name包含Jack
NSPredicate *pred = [NSPredicate predicateWithFormat:@"%K CONTAINS %@", property, value];
NSArray *newArray = [array filteredArrayUsingPredicate:pred];
NSLog(@"newArray:%@", newArray);

// RESULT:newArray:(
"[name = Jack, age = 20, sex = 0]",
"[name = Jackson, age = 30, sex = 0]"
)

//  创建谓词，属性名改为age，要求这个age包含$VALUE字符串
NSPredicate *predTemp = [NSPredicate predicateWithFormat:@"%K > $VALUE", @"age"];
// 指定$VALUE的值为 25
NSPredicate *pred1 = [predTemp predicateWithSubstitutionVariables:@{@"VALUE" : @25}];
NSArray *newArray1 = [array filteredArrayUsingPredicate:pred1];
NSLog(@"newArray1:%@", newArray1);

// RESULT:newArray1:(
"[name = Jackson, age = 30, sex = 0]",
"[name = Johnson, age = 35, sex = 0]"
)

//  修改 $VALUE的值为32
NSPredicate *pred2 = [predTemp predicateWithSubstitutionVariables:@{@"VALUE" : @32}];
NSArray *newArray2 = [array filteredArrayUsingPredicate:pred2];
NSLog(@"newArray2:%@", newArray2);

// RESULT: newArray2:(
"[name = Johnson, age = 35, sex = 0]"
)