iOS IM开发准备工作（一）XML解析

　　关于XML解析的blog有很多，我本来不想写的；不过我发现有一些细节他们都没有说，我这里就多说一些细节。

　　我们在哪些地方用XML：现在json用的这么多，使用XML通讯的已经不多了。我遇到的场景是，我们的服务器有很多个，需要用户去选择。那么我们就需要定期维护一个服务器列表，这个服务器列表的配置文件我需要每次下载。自然我就需要解析这一个文件。

　　XML解析有两种模式SAX和DOM。我用的是系统的 NSXMLParser 它是SAX解析。

　　我写了一个工具类，先贴一下代码，下面会有一些说明

.h

#import <Foundation/Foundation.h>

typedef NS_ENUM(NSInteger,xmlModelName){// 这里我对我的XML文件做了区别 因为要解析表情和服务器列表两种
    xmlModelNameFace,
    xmlModelNameServer,
};
@interface XMLParser : NSObject<NSXMLParserDelegate>
// 这个是回调的Block
@property(nonatomic,copy)void (^returnParseArray)(NSArray * returnArray);
@property(nonatomic,readonly)xmlModelName currentModelName;

- (instancetype)initWithFilePath:(NSString *)path fileType:(NSString *)fileType modelName:(xmlModelName)modelName;

- (void)startWithFilePath:(NSString *)path fileType:(NSString *)fileType;
@end

.m

#import "XMLParser.h"
#import "FaceModel.h"
#import "ToolClient.h"
#import "ServerModel.h"
@implementation XMLParser{
    NSMutableArray * faceArray;
    NSMutableArray * serverArray;
}

@synthesize currentModelName;
- (instancetype)initWithFilePath:(NSString *)path fileType:(NSString *)fileType modelName:(xmlModelName)modelName{
    self = [super init];
    if(self){
        currentModelName = modelName;
    }
    return self;
}

- (void)startWithFilePath:(NSString *)path fileType:(NSString *)fileType {
    [self parseWithPath:path type:fileType];
}
//
- (void)parseWithPath:(NSString *)filePath type:(NSString *)fileType{
    if (currentModelName == xmlModelNameFace) {
        faceArray = [[NSMutableArray alloc]init];
    }else if(currentModelName == xmlModelNameServer){
        serverArray = [[NSMutableArray alloc]init];
    }
    NSData *xmlData = [[NSData alloc] initWithContentsOfFile:filePath];
    if(xmlData && xmlData.length > 10){
        NSXMLParser *parser = [[NSXMLParser alloc] initWithData:xmlData];
        [parser setShouldProcessNamespaces:NO];
        [parser setShouldReportNamespacePrefixes:NO];
        [parser setShouldResolveExternalEntities:NO];
        [parser setDelegate:self];
        BOOL success = [parser parse];
        if(success) {
            [self parseSuccess];
        }else {
            [ToolClient activityShowMessage:@"XML解析失败" inView:[UIApplication sharedApplication].windows[0]];
        }
    }else {
        [ToolClient activityShowMessage:@"XML解析失败" inView:[UIApplication sharedApplication].windows[0]];
    }
}
// 成功后的回调
- (void)parseSuccess {
    if(self.returnParseArray){
        if (currentModelName == xmlModelNameFace) {
            self.returnParseArray(faceArray);
        }else if(currentModelName == xmlModelNameServer){
            self.returnParseArray(serverArray);
        }
    }
}
#pragma mark - NSXMLParserDelegate

- (void)parser:(NSXMLParser *)parser didStartElement:(NSString *)elementName
  namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qualifiedName
    attributes:(NSDictionary *)attributeDict {
    //    NSLog(@"Name:%@",elementName);
    
    if([elementName isEqualToString:@"face"] && currentModelName == xmlModelNameFace) {
        FaceModel * faceModel = [[FaceModel alloc]init];
        faceModel.kID = [attributeDict[@"id"]intValue];
        faceModel.kName = attributeDict[@"name"];
        faceModel.kImage = attributeDict[@"file"];
        [faceArray  addObject:faceModel];
        faceModel = nil;
    }else if([elementName isEqualToString:@"Server"] && currentModelName == xmlModelNameServer){
        ServerModel * sModel = [[ServerModel alloc]init];
        sModel.serverName = attributeDict[@"name"];
        sModel.serverIP = attributeDict[@"ChatServerIP"];
        sModel.chatPort = attributeDict[@"chatPort"];
        sModel.fileServerIP = attributeDict[@"fileServerIP"];
        sModel.filePort = attributeDict[@"filePort"];
        [serverArray addObject:sModel];
        sModel = nil;
    }
}
- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string  {
    //    NSLog(@"value:%@",string);
}
- (void)parserDidEndDocument:(NSXMLParser *)parser {
    //86     //    NSLog(@"%@",faceArray);
    
}
- (void)parser:(NSXMLParser *)parser didEndElement:(NSString *)elementName namespaceURI:(NSString *)namespaceURI qualifiedName:(NSString *)qName{
    //    NSLog(@"elementName:%@",elementName);
    //    NSLog(@"qualifiedName:%@",qName);
    //
    //    NSLog(@"NSXMLParserDone");
    //    NSLog(@"%@",faceArray);
    //    NSLog(@"%i",(int)faceArray.count);
    
}
@end

现在我来说一下XML解析的设置里面那3个设置为NO的参数是什么作用

 [parser setShouldProcessNamespaces:NO]; 2 [parser setShouldReportNamespacePrefixes:NO]; 3 [parser setShouldResolveExternalEntities:NO]; 

　　第一个 setShouldProcessNamespaces 这个属性设置为YES的话，这两个方法会有值输出：parser:didStartElement:namespaceURI:qualifiedName:attributes: 和 parser:didEndElement:namespaceURI:qualifiedName: 这两个在解析过程中都是都是可以看到里面的节点或字段的名字的。我觉得调试的时候可以用一下。

　　第二个 setShouldReportNamespacePrefixes 这个属性设置为YES的话，这两个方法会有值输出：parser:didStartMappingPrefix:toURI: 和 parser:didEndMappingPrefix: 这个我觉得完全没有必要用它

　　第三个 setShouldResolveExternalEntities 这个属性设置为YES的话，这个方法会有值输出：parser:foundExternalEntityDeclarationWithName:publicID:systemID: 其中publicID 和systemID 都是XML文档的特有的标识。官方文档对这个两个的变量都是这么说的：

You may access this property once a parsing operation has begun or after an error occurs.

也就是当XML解析已经开始或者出现错误的时候，再去看它。也就是说如果你的XML写的够好 你就忽略它吧。

　　上面的代码是工具类，下面这段会告诉你这段代码怎么用：

// 解析文件 
- (void)parseFile:(NSString *)filepath{
    NSLog(@"filepath%@",filepath);// 文件的路径
    if(data.length>10){// 简单的长度检测
        __weak SelectServerViewController * ws = self;// 弱引用
        // do parse
        XMLParser * xp = [[XMLParser alloc]initWithFilePath:filepath fileType:@"xml" modelName:xmlModelNameServer];
        // 先设置回调
        xp.returnParseArray = ^(NSArray * array){
            // 回调的结果 去给tableView 展示
            [ws gotDataArray:array];
        };
        // 再开始解析
        [xp startWithFilePath:filepath fileType:@"xml"];
    }
   
}

- (void)gotDataArray:(NSArray *)array {
    if(array){
//        NSLog(@"array:%@",array);
        dataArray = [array mutableCopy];
        [myTableView reloadData];
    }
}

XML解析我就写这么多了，给一个建议 解析的时候用一个Model来存储数据，后续的使用会很方便。