Core Data浅谈系列之六 ： 验证用户输入

在做Web开发时，需要谨记的一条原则是“绝不要相信用户的任何输入”（参见《 Essential PHP Security 》）。

与网页上的表单提交类似，做客户端开发时也应该考虑用户输入，比如可以为UITextField设置代理处理用户实时输入的内容，也可以读取完用户输入再做检查，或者是NSManagedObject的 验证功能。

比如，我们可以在Player的实现里提供验证函数： 

#define PLAYER_ERROR_DOMAIN @"PLAYER_ERROR_DOMAIN"

enum _playerErrorCode {
    PLAYER_INVALID_AGE_CODE = 0,
    PLAYER_INVALID_NAME_CODE,
    PLAYER_INVALID_CODE
};
typedef enum _playerErrorCode PlayerErrorCode;

@implementation Player

@dynamic age;
@dynamic name;
@dynamic team;

- (BOOL)validateName:(id *)ioValue error:(NSError **)outError
{
    NSString *playerName = *ioValue;
    playerName = [playerName stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
    if (!playerName || [playerName length] == 0) {
        if (outError) {
            NSString *errorStr = @"Player's name should not be empty.";
            NSDictionary *userInfoDict = @{ NSLocalizedDescriptionKey : errorStr };
            NSError *error = [[NSError alloc] initWithDomain:PLAYER_ERROR_DOMAIN
                                                        code:PLAYER_INVALID_NAME_CODE
                                                    userInfo:userInfoDict];
            *outError = error;
        }
        return NO;
    }

    return YES;
}

@end

当context在执行save动作时，这些属性验证函数会得到调用，如果验证函数返回NO，则save动作会失败：

2013-01-17 22:36:42.393 cdNBA[673:c07] Error Error Domain=PLAYER_ERROR_DOMAIN Code=1 "Player's name should not be empty." UserInfo=0x827e380 {NSLocalizedDescription=Player's name should not be empty.}, Player's name should not be empty.

当然，我们绝对不会希望异常发生在这个位置，让程序直接挂掉 —— 这里只是一个Demo。

因为只有在保存context时才会调用验证函数，为了不让程序挂在这里，我们可以提前进行验证： 

    NSString *name = self.nameTextField.text;
    NSError *error = NULL;
    [playerObject validateValue:&name forKey:@"name" error:&error];
    if (error) {
        NSLog(@"%@\n", [error localizedDescription]);
    }

除了name，我们还可能验证age或者其它属性，同样地可以写相应的属性验证函数。但是，有些属性的验证是需要结合在一起作为判断条件的。这种情况下，我们可以利用属性间的结合验证：

- (BOOL)validateForInsert:(NSError **)outError
{
    BOOL valid = [super validateForInsert:outError];
    
    NSString *playerName = self.name;
    if (!playerName || [playerName length] == 0) {
        if (outError) {
            NSString *errorStr = @"Player's name should not be empty.";
            NSDictionary *userInfoDict = @{ NSLocalizedDescriptionKey : errorStr };
            NSError *error = [[NSError alloc] initWithDomain:PLAYER_ERROR_DOMAIN
                                                        code:PLAYER_INVALID_NAME_CODE
                                                    userInfo:userInfoDict];
            *outError = [self errorFromOriginalError:error error:nil];
        }
        valid = NO;
    }
    
    NSInteger playerAge = [self.age integerValue];
    if (!self.age || (playerAge < 16 || playerAge > 50)) {
        if (outError) {
            NSString *errorStr = @"Player's age should be in [16, 50].";
            NSDictionary *userInfoDict = @{ NSLocalizedDescriptionKey : errorStr };
            NSError *error = [[NSError alloc] initWithDomain:PLAYER_ERROR_DOMAIN
                                                        code:PLAYER_INVALID_AGE_CODE
                                                    userInfo:userInfoDict];
            *outError = [self errorFromOriginalError:*outError error:error];
        }
        valid = NO;
    }
    
    return valid;
}

// Modified from https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CoreData/Articles/cdValidation.html
//
- (NSError *)errorFromOriginalError:(NSError *)originalError error:(NSError *)secondError
{
    NSMutableDictionary *userInfo = [NSMutableDictionarydictionary];
    
    NSMutableArray *errors = [NSMutableArrayarray];
    if (secondError) {
        [errors addObject:secondError];
    }
    
    if ([originalError code] == NSValidationMultipleErrorsError) {
        [userInfo addEntriesFromDictionary:[originalError userInfo]];
        [errors addObjectsFromArray:[userInfo objectForKey:NSDetailedErrorsKey]];
    } else {
        [errors addObject:originalError];
    }
    
    [userInfo setObject:errors forKey:NSDetailedErrorsKey];
    
    return [NSErrorerrorWithDomain:NSCocoaErrorDomain
                               code:NSValidationMultipleErrorsError
                           userInfo:userInfo];
}

由于存在多种属性的验证，所以提供了错误信息的连接函数，这有点类似php中我们经常会写的字符串连接点符号：

error = "Invalid username or password.";
error .= "Invalid token.";

NSManagedObject提供了三个函数用户在插入、修改、删除之前进行验证，分别是上面的validateForInsert，以及validateForUpdate和validateForDelete。

这次如果name和age都为空，则会输出如下错误信息： 

2013-01-17 23:42:03.979 cdNBA[1064:c07] Error Error Domain=NSCocoaErrorDomain Code=1560 "The operation couldn’t be completed. (Cocoa error 1560.)" UserInfo=0x111394b0 {NSDetailedErrors=(
    "Error Domain=PLAYER_ERROR_DOMAIN Code=0 \"Player's age should be in [16, 50].\" UserInfo=0x1112fbf0 {NSLocalizedDescription=Player's age should be in [16, 50].}",
    "Error Domain=PLAYER_ERROR_DOMAIN Code=1 \"Player's name should not be empty.\" UserInfo=0x11139430 {NSLocalizedDescription=Player's name should not be empty.}"
)}, The operation couldn’t be completed. (Cocoa error 1560.)

上面只是简单地对name和age进行是否为空的判定，实际操作还需要判断其它条件。比如还可以判断该球员是否已经存在，或者是之前提到的球队同名问题。

假设我们输入了合法的数据，创建了一名球员的信息，结果返回到上一级视图发现没有得到展现。对于这种情况，我们可以先很黄很暴力地在viewWillAppear里面重新reload下table，或者通过 观察者模式监听相应的消息进行刷新。这里即将讨论的方法是使用NSFetchedResultsController这个类。

Brief Talk About Core Data Series, Part 6 : Input Validation 

Jason Lee @ Hangzhou

Blog : http://blog.csdn.net/jasonblog

Weibo : http://weibo.com/jasonmblog