Key-Value Coding中的集合运算符(Collection Operators)

Key-Value Coding是iOS中NSObject的子类都拥有的一项机制,它提供了非直接访问对象属性的统一方法。平常我们一般只会用到setValueForKey:或是valueForKey:这些方法,但其实KVC针对集合类型,提供了一些有用的运算符,称之为Collection Operators。通过在keyPath中加入这些运算符,我们可以只用一行代码,完成计算平均值,求和,得出最大值,最小值等针对集合的计算。

如何在keyPath字符串中加入运算符

格式如下图所示:


keypath_format.png
  1. 运算符名字之前要加"@"。
  2. 在运算符左边的部分,称为left key path,指向一个集合类型的属性。如果直接针对集合对象调用valueForKeyPath:函数,那么left key path可以省略。
  3. 在运算符右边的部分,称为right key path,指向的是集合中对象的某个属性。除了count运算符没有right key path外,其它的都必须指定。

示例代码用的类和数据

示例代码用如下的类和数据,演示运算符的使用。一个Person类的对象拥有一个BankAccount类的对象,而一个银行账号中会有多笔交易,每一笔交易,都是一个Transaction类的对象。交易的属性有:交易对方,交易金额,交易日期。

@class BankAccount;

@interface Person : NSObject

@property (nonatomic, retain) NSString *name;
@property (nonatomic, retain) BankAccount *account;

@end
@class Transaction;

@interface BankAccount : NSObject

@property (nonatomic, retain) NSNumber* currentBalance;
@property (nonatomic, copy) NSArray< Transaction* >* transactions;

@end
@interface Transaction : NSObject

@property (nonatomic, strong) NSString* payee;   // To whom
@property (nonatomic, strong) NSNumber* amount;  // How much
@property (nonatomic, strong) NSDate* date;      // When

@end

假设银行账号中有如下交易记录:


Key-Value Coding中的集合运算符(Collection Operators)_第1张图片
transactions.png

实例演示

以下的代码中,变量tom都指向一个Person类的实例。

@avg

如果我们想计算所有交易的平均金额,可以用如下代码:

NSNumber *transactionAverage = [tom valueForKeyPath: @"[email protected]"];

结果为456.54.

@count

此运算符会返回集合中元素的数量。

NSNumber *numberOfTransactions = [tom valueForKeyPath: @"account.transactions.@count"];

结果为13。

@max

如果我们想知道最近的一笔交易的日期,可以通过计算所有交易的日期的最大值,来得到这个日期。

NSDate *latestDate = [tom valueForKeyPath:@"[email protected]"];

结果为Jul 15, 2016。
在查找的过程中,框架会调用对象的compare:方法。

@min

此运算符可以得到某个属性的最小值。比如要查找最早的一笔交易的日期,可以通过计算所有交易的日期的最小值,来得到这个日期。

NSDate *oldestDate = [tom valueForKeyPath:@"[email protected]"];

结果为Dec 1, 2015。

@sum

如果想计算所有交易的总的交易金额,可以用如下代码:

NSNumber *amountSum = [tom valueForKeyPath:@"[email protected]"];

结果为5935.

@distinctUnionOfObjects

此运算符会返回一个集合,集合中的元素不重复。例如,要得到所有的交易对方且去重,可以用如下代码:

NSArray *distinctPayees = [tom valueForKeyPath:@"[email protected]"];

结果数组中包含如下字符串:Car Loan, General Cable, Animal Hospital, Green Power, Mortgage。

@unionOfObjects

和@distinctUnionOfObjects类似,只不过结果不去重。上面的代码如果改用该运算符:

NSArray *payees = [tom valueForKeyPath:@"[email protected]"];

结果数组中包含如下字符串:Green Power, Green Power, Green Power, Car Loan, Car Loan, Car Loan, General Cable, General Cable, General Cable, Mortgage, Mortgage, Mortgage, Animal Hospital.

@distinctUnionOfArrays

使用此运算符有一个前提,就是集合中的元素,也是集合类型。
我们先用如下测试数据,来建立一个二维数组。


Key-Value Coding中的集合运算符(Collection Operators)_第2张图片
moreTransactions.png
    NSMutableArray *moreTransactions = [NSMutableArray array];
    for (NSUInteger i = 0; i < sizeof(moreRecords) / sizeof(TransactionRecord); i++) {
        Transaction *t = [Transaction new];
        t.payee = @(moreRecords[i].payee);
        t.amount = @(moreRecords[i].amount);
        t.date = [formatter dateFromString: @(moreRecords[i].date)];
        [moreTransactions addObject: t];
    }
    
    NSArray *arrayOfArrays = @[tom.account.transactions, moreTransactions];

如果想得到所有的不重复的交易对方,可以用如下代码:

NSArray *collectedDistinctPayees = [arrayOfArrays valueForKeyPath:@"@distinctUnionOfArrays.payee"];

结果:Hobby Shop, Mortgage, Animal Hospital, Second Mortgage, Car Loan, General Cable - Cottage, General Cable, Green Power

@unionOfArrays

和@distinctUnionOfArrays类似,只不过没有做去重。上面的代码中如果改用此运算符,会返回所有的交易的对方的名字。

NSArray *collectedPayees = [arrayOfArrays valueForKeyPath:@"@unionOfArrays.payee"];

@distinctUnionOfSets

该运算符和@distinctUnionOfArrays的行为类似,不同点:

  1. 返回的是NSSet
  2. 作用在NSSet类型的集合上
  3. NSSet中的元素也是NSSet

总结

这些运算符在上面举例的场合还是挺有用的,在这些场合,如果不用集合运算符,那么就要自己去写代码实现,导致代码量比较多。

你可能感兴趣的:(Key-Value Coding中的集合运算符(Collection Operators))