100. NSScanner类条件判断利器详解

简介

NSScanner是一个类，用于在字符串中扫描指定的字符，尤其是把它们翻译/转换为数字和别的字符串。可以在创建NSScaner时指定它的string属性，然后scanner会按照你的要求从头到尾地扫描这个字符串的每个字符。

NSScanner官方文档

NSScanner类是一个类簇的抽象父类,该类簇为一个从NSString对象扫描值的对象提供了程序接口。
NSScanner对象把NSString 对象的的字符解释和转化成 number和string 类型的值。在创建NSScanner对象的时候为它分配字符(string )，当你从NSScanner对象获取内容的时候，它会从头到尾遍历字符串(string)。
由于类簇的属性， scanner对象并不是 NSScanner类的实例，而是它一个私有子类的实例。尽管scanner对象的类是私有的，但是它的接口是公开的（抽象父类已经声明）。 NSScanner 的原始方法是string和Configuring a Scanner方法下面列举的所有的方法。
在 NSScanner 对象扫描字符串的时候，你可以通过设置属性charactersToBeSkipped忽略某些字符。在扫描字符串之前，那些位于忽略字符集中的字符将会被跳过。默认的忽略字符是空格和回车字符。
可以通过[[scanner string] substringFromIndex:[scanner scanLocation]]获取未扫描的字符串。

Scanner创建

NSScanner是一个类族， NSScanner是其中公开的一类。通常，可以用scannerWithString:或localizedScannerWithString:方法初始化一个scanner。

+ (instancetype)scannerWithString:(NSString *)aString
+ (id)localizedScannerWithString:(NSString *)aString
- (instancetype)initWithString:(NSString *)aString

• scannerWithString，返回值是 扫描过aString字符串的NSScanner 对象，该方法通过调用initWithString设置扫描字符串;
• localizedScannerWithString,返回值是 通过用户默认的 locale方式扫描字符串的NSScanner 对象，该方法也是通过调用initWithString设置扫描字符串;
• initWithString，返回值是NSScanner 对象，该对象通过扫描aString完成初始化

属性详解

@property(readonly, copy) NSString *string
@property NSUInteger scanLocation
@property BOOL caseSensitive
@property(copy) NSCharacterSet *charactersToBeSkipped
@property(retain) id locale

• scanLocation,下次扫描开始的位置，如果该值超出了string的区域，将会引起NSRangeException,该属性在发生错误后重新扫描时非常有用。
• caseSensitive，是否区分字符串中大小写的标志。默认为NO，注意：该设置不会应用到被跳过的字符集。
• charactersToBeSkipped,在扫描时被跳过的字符集，默认是空白格和回车键。被跳过的字符集优先于扫描的字符集：例如一个scanner被跳过的字符集为空格，通过scanInt:去查找字符串中的整型数时，首先做的不是扫描，而是跳过空格，直到找到十进制数据或者其他的字符。在字符被扫描的时候，跳过功能就失效了。如果你扫描的字符和跳过的字符是一样的，结果将是未知的。被跳过的字符是一个唯一值，scanner不会将忽略大小写的功能应用于它，也不会用这些字符做一些组合，如果在扫描字符换的时候你想忽略全部的元音字符，就要这么做（比如：将字符集设置成“AEIOUaeiou”};
• locale,scanner 的locale对它从字符串中区分数值产生影响，它通过locale的十进制分隔符区分浮点型数据的整数和小数部分。一个没有locale的scanner用非定域值。新的scanner若没有设置locale，使用默认locale。

方法详解

- (BOOL)scanCharactersFromSet:(NSCharacterSet *)scanSet   intoString:(NSString * _Nullable *)stringValue;
- (BOOL)scanUpToCharactersFromSet:(NSCharacterSet *)stopSet    intoString:(NSString * _Nullable *)stringValue;
- (BOOL)scanString:(NSString *)string  intoString:(NSString * _Nullable *)stringValue;
- (BOOL)scanUpToString:(NSString *)stopString   intoString:(NSString * _Nullable *)stringValue;
- (BOOL)scanDecimal:(NSDecimal *)decimalValue;
- (BOOL)scanDouble:(double *)doubleValue;
- (BOOL)scanFloat:(float *)floatValue;
- (BOOL)scanHexDouble:(double *)result;
- (BOOL)scanHexFloat:(float *)result;
- (BOOL)scanHexInt:(unsigned int *)intValue;
- (BOOL)scanHexLongLong:(unsigned long long *)result;
- (BOOL)scanInt:(int *)intValue;
- (BOOL)scanInteger:(NSInteger *)value;
- (BOOL)scanUnsignedLongLong:(unsigned long long *)unsignedLongLongValue;
@property(getter=isAtEnd, readonly) BOOL atEnd;

• scanCharactersFromSet:intoString:扫描字符串中和NSCharacterSet字符集中匹配的字符，是按字符单个匹配的，例如，NSCharacterSet字符集为@”test123Dmo”，scanner字符串为 @” 123test12Demotest”，那么字符串中所有的字符都在字符集中，所以指针指向的地址存储的内容为”123test12Demotest”
• scanUpToCharactersFromSet:intoString：扫描字符串直到遇到NSCharacterSet字符集的字符时停止，指针指向的地址存储的内容为遇到跳过字符集字符之前的内容
• scanString:intoString:从当前的扫描位置开始扫描，判断扫描字符串是否从当前位置能扫描到和传入字符串相同的一串字符，如果能扫描到就返回YES,指针指向的地址存储的就是这段字符串的内容。例如scanner的string内容为123abc678,传入的字符串内容为abc，如果当前的扫描位置为0，那么扫描不到，但是如果将扫描位置设置成3，就可以扫描到了。
• scanUpToString:intoString:从当前的扫描位置开始扫描，扫描到和传入的字符串相同字符串时，停止，指针指向的地址存储的是遇到传入字符串之前的内容。例如scanner的string内容为123abc678,传入的字符串内容为abc，存储的内容为123
• scanDecimal:扫描NSDecimal类型的值，有关NSDecimal类型的值更多的信息可以查看：NSDecimalNumber
• scanDouble :扫描双精度浮点型字符，溢出和非溢出都被认为合法的浮点型数据。在溢出的情况下scanner将会跳过所有的数字，所以新的扫描位置将会在整个浮点型数据的后面。double指针指向的地址存储的数据为扫描出的值，包括溢出时的HUGE_VAL或者 –HUGE_VAL，即未溢出时的0.0。
• scanFloat：扫描单精度浮点型字符，具体内容同scanDouble
• scanHexDouble: 扫描双精度的十六进制类型，溢出和非溢出都被认为合法的浮点型数据。在溢出的情况下scanner将会跳过所有的数字，所以新的扫描位置将会在整个浮点型数据的后面。double指针指向的地址存储的数据为扫描出的值，包括溢出时的HUGE_VAL或者 –HUGE_VAL，即未溢出时的0.0。数据接收时对应的格式为 %a 或%A ，双精度十六进制字符前面一定要加 0x或者 0X。
• scanHexInt 扫描十六进制无符整型，unsigned int指针指向的地址值为 扫描到的值，包含溢出时的UINT_MAX。
• scanHexLongLong 同scanHexDouble
• scanInt 扫描整型，溢出也被认为是有效的整型，int 指针指向的地址的值为扫描到的值，包含溢出时的INT_MAX或INT_MIN。
• scanInteger 同scanInt
• scanLongLong 扫描LongLong 型，溢出也被认为是有效的整型，LongLong指针指向的地址的值为扫描到的值，包含溢出时的LLONG_MAX 或 LLONG_MIN。

Scanner使用

NSScanner这个类，用于在字符串中扫描指定的字符。可以在创建NSScanner时指定它的string属性，然后scanner会按照要求从头到尾地扫描这个字符串中的每个字符。扫描动作会使扫描仪从头到尾在字符串中移动，直到扫描完整个字符串或扫描到指定的内容。
扫描停止后，扫描仪的位置并不会被置为字符串开始的位置。下一次的扫描操作将会从上一次扫描停止的位置开始。scanLocation来指定扫描开始的位置, charactersToBeSkipped是来指定不需要扫描的字符的.

    NSString *bananas = @"123.321abc137d efg/hij kl";
    NSString *separatorString = @"fg";
    BOOL result;

    NSScanner *aScanner = [NSScanner scannerWithString:bananas];

    //扫描字符串
    //扫描到指定字符串时停止，返回结果为指定字符串之前的字符串
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);
    NSString *container;
    result = [aScanner scanUpToString:separatorString intoString:&container];
    NSLog(@"扫描成功：%@", result?@"YES":@"NO");
    NSLog(@"扫描的返回结果：%@", container);
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);

    //扫描整数
    //将会接着上一次扫描结束的位置继续扫描
    NSLog(@"-------------------------------------1");
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);
    NSInteger anInteger;
    result = [aScanner scanInteger:&anInteger];
    NSLog(@"扫描成功：%@", result?@"YES":@"NO");
    NSLog(@"扫描的返回结果：%ld", anInteger);
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);

    //扫描整数
    //将扫描仪的位置置为首位置
    //扫描仪默认会接着上一次扫描结束的位置开始扫描，而不是重新从首位置开始
    //当扫描到一个不是整数的字符时将会停止扫描（如果开始扫描的位置不为整数，则会直接停止扫描）
    NSLog(@"-------------------------------------2");
    aScanner.scanLocation = 0;      //将扫描仪的位置置为首位置
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);
    NSInteger anInteger2;
    result = [aScanner scanInteger:&anInteger2];
    NSLog(@"扫描成功：%@", result?@"YES":@"NO");
    NSLog(@"扫描的返回结果：%ld", anInteger2);
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);

    //扫描浮点数
    //当扫描到一个不是整数的字符时将会停止扫描（如果开始扫描的位置不为整数，则会直接停止扫描）
    NSLog(@"-------------------------------------3");
    aScanner.scanLocation = 0;      //将扫描仪的位置置为首位置
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);
    float aFloat;
    result = [aScanner scanFloat:&aFloat];
    NSLog(@"扫描成功：%@", result?@"YES":@"NO");
    NSLog(@"扫描的返回结果：%f", aFloat);
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);

    NSLog(@"-------------------------------------4");
    NSLog(@"所扫描的字符串：%@", aScanner.string);
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);
    NSLog(@"是否扫描到末尾：%@", aScanner.isAtEnd?@"YES":@"NO");


    NSLog(@"-------------------------------------5");
    aScanner.scanLocation = 0;      //将扫描仪的位置置为首位置
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);
    NSString *str;
    NSCharacterSet *characterSet = [NSCharacterSet characterSetWithCharactersInString:@"/"];
    result = [aScanner scanUpToCharactersFromSet:characterSet intoString:&str];
    NSLog(@"扫描成功：%@", result?@"YES":@"NO");
    NSLog(@"扫描的返回结果：%@", str);
    NSLog(@"扫描仪所在的位置：%lu", aScanner.scanLocation);

打印结果:

例1:扫描数字

    NSString * numStr = @"a 1 b 2 c 3 d 4 e 5 f 6 o";
    NSScanner * scanner = [NSScanner scannerWithString:numStr];
    NSCharacterSet * numSet = [NSCharacterSet decimalDigitCharacterSet];
    while ( NO == [scanner isAtEnd]) {
        if ([scanner scanUpToCharactersFromSet:numSet intoString:NULL]) {
            int num;
            if ([scanner scanInt:&num]) {
                NSLog(@"num=%d, %ld",num, scanner.scanLocation);
            }
        }

打印结果:

例2:过滤数字

    NSString * numStr = @"a 1 b 2 c 3 d 4 e 5 f 6 o";
    NSScanner * scanner = [NSScanner scannerWithString:numStr];
    //默认情况下，扫描器会跳过所有空格符和换行符。但这里我们希望跳过数字
        NSCharacterSet * numSet = [NSCharacterSet decimalDigitCharacterSet];
    scanner.charactersToBeSkipped = numSet;
    while ( NO == [scanner isAtEnd]) {
        if ([scanner scanUpToCharactersFromSet:numSet intoString:NULL]) {
            int num;
            if ([scanner scanInt:&num]) {
                NSLog(@"num=%d, %ld",num, scanner.scanLocation);
            }else{
                NSLog(@"无结果");
            }
        }
    }}

打印结果:

例3

假设你有如下字符串：
Product: Acme Potato Peeler; Cost: 0.98 73?Product: Chef Pierre Pasta Fork; Cost: 0.75 19?Product: Chef Pierre Colander; Cost: 1.27 2?
以下代码演示了读取产品名称和价格的操作（价格简单地读作一个float），跳过“Product:”和“Cost:”子串，以及分号。注意，因为scanner默认忽略空白字符和换行符，循环中没有指定对它们的处理（尤其对于读取末尾的整数而言，并不需要处理额外的空白字符）。

    NSString *string = @"Product: Acme Potato Peeler; Cost: 0.98 73\nProduct: Chef Pierre Pasta Fork; Cost: 0.75 19\nProduct: Chef Pierre Colander; Cost: 1.27 2\n    \n";

    NSCharacterSet *semicolonSet;
    NSScanner *theScanner;

    NSString *PRODUCT = @"Product:";
    NSString *COST = @"Cost:";

    NSString *productName;
    float productCost;
    NSInteger productSold;

    semicolonSet = [NSCharacterSet characterSetWithCharactersInString:@";"];
    theScanner = [NSScanner scannerWithString:string];
    while ([theScanner isAtEnd] == NO)
    {
        if ([theScanner scanString:PRODUCT intoString:NULL] &&[theScanner scanUpToCharactersFromSet:semicolonSet intoString:&productName] &&
            [theScanner scanString:@";" intoString:NULL] &&

            [theScanner scanString:COST intoString:NULL] &&
            [theScanner scanFloat:&productCost] &&
            [theScanner scanInteger:&productSold])
        {  
            NSLog(@"Sales of %@: $%1.2f", productName, productCost * productSold);  
        }  
    }

打印结果:

参考文章:
[译] iOS：NSScanner,一个陌生的条件判断利器!
NSScanner类的基本用法
iOS开发 - NSScanner的用法