網路上關於 NSPredicate 的講解多偏粗略,想真正掌握還是得回頭讀官方文件。以下依文件結構整理重點,並補上實務上的注意事項。
NSPredicate 用來定義邏輯條件約束,可用於「取得(fetch)」與「記憶體中的過濾」兩種場景。你可以用謂詞描述條件,去篩選持久性儲存或記憶體中的物件。
雖然直接從 NSComparisonPredicate、NSCompoundPredicate、NSExpression 建立謂詞是常見做法,但實務上更常透過 NSPredicate 的類別方法,用「格式字串」來建立。
簡單比較:
grade == "7"
firstName like "Shaffiq"
不區分大小寫與音調的比對:
name contains[cd] "itroen"
這裡的 [cd] 修飾符中,c 代表 case-insensitive(忽略大小寫),d 代表 diacritic-insensitive(忽略重音)。相關修飾符還有 [c]、[d]。
邏輯運算:
(firstName like "Mark") OR (lastName like "Adderley")
區間謂詞(OS X v10.5 以後):
date between {$YESTERDAY, $TOMORROW}
group.name like "work*"
ALL children.age > 12
ANY children.age > 12
ALL / ANY / NONE 這類聚合運算子,讓你能對關聯集合下條件,這是 Core Data 情境下非常實用的語法。
@sum.items.price < 1000
常見的還有 @avg、@max、@min、@count。完整語法請參閱蘋果的《Predicate Programming Guide》。
你可以先建立帶變數的謂詞,等執行期再替換成實際值。在 OS X v10.4 時代這是兩步驟:先呼叫 predicateWithSubstitutionVariables:,再對回傳結果呼叫 evaluateWithObject:。v10.5 以後合併為 evaluateWithObject:substitutionVariables:。
建立謂詞:
+ predicateWithFormat:
+ predicateWithFormat:argumentArray:
+ predicateWithFormat:arguments:
- predicateWithSubstitutionVariables:
+ predicateWithValue:
+ predicateWithBlock:
評估謂詞:
- evaluateWithObject:
- evaluateWithObject:substitutionVariables:
取得字串形式:
- predicateFormat
+ (NSPredicate *)predicateWithBlock:(BOOL (^)(id evaluatedObject, NSDictionary *bindings))block;
block 接收兩個參數:evaluatedObject 是被評估的物件;bindings 是變數替換字典,必須包含接收者中所有變數的鍵值對。block 內若判斷為真回傳 YES,否則 NO。
特殊考量:OS X v10.6 起,Core Data 在記憶體與原子儲存中支援這個方法,但基於 SQLite 的儲存不支援。iOS 4.0 以後可用,宣告於 NSPredicate.h。
+ (NSPredicate *)predicateWithFormat:(NSString *)format, ...;
以格式字串與後續參數建立新謂詞。iOS 3.0 以後可用。文件列出的範例專案有 ThreadedCoreData、ToolbarSearch、WeatherMap。
把陣列中的值依陣列順序代入格式字串再解析。
+ (NSPredicate *)predicateWithValue:(BOOL)value
建立一個「永真」或「永假」的謂詞。實務上常用來做條件開關,例如搜尋條件為空時傳入 YES 讓全部通過。
- (BOOL)evaluateWithObject:(id)object;
- (BOOL)evaluateWithObject:(id)object substitutionVariables:(NSDictionary *)variables;
第二個方法的結果,等同於「先呼叫 predicateWithSubstitutionVariables: 再對結果呼叫 evaluateWithObject:」的兩步驟組合,但針對「反覆用不同變數評估同一個謂詞」的場景做了效能優化。
這個方法回傳接收者的格式字串,但文件明確指出:回傳的結果不保證與建立時傳入的格式字串完全相同。也就是說,你不能用它還原出「一模一樣的原始字串」,也不能拿它當持久化依據。
若真的需要持久化,正確做法是建立 archive——NSPredicate 已採用 NSCoding 協議,可以直接用 NSKeyedArchiver 序列化。
- (NSPredicate *)predicateWithSubstitutionVariables:(NSDictionary *)variables
回傳一個把變數替換後的副本。接收者本身不會被改動,所以你可以拿同一個原始謂詞做任意多次不同的替換,這是設計上很貼心的一點。
格式字串雖然簡潔,但有兩點要小心:一是所有字串常數都要用雙引號包起來,忘記加會直接拋出解析例外;二是拼錯 key path 時編譯器不會報錯,錯誤會延後到執行期才爆發。若條件複雜,改用 NSExpression 或直接在程式碼中比較,反而更容易除錯。