2011年6月3日金曜日

iOSでXMLを読み込む(Libxml2-DOM)

iOSでXMLをパースするには標準で、
  • NSXMLParser
  • Libxml2
を使う方法があるようです。外部ライブラリもある様ですが、そのへんは未調査です。

それぞれ一長一短で、NSXMLParserはSAXタイプのパーサです。Libxml2はSAXとDOMタイプの両方を提供しています。
個人的にSAXはフラグを多用するので好きじゃないのとSAXタイプの解析方法は色々と参考に出来るサイトが多々存在したので、Libxml2/DOMでの解析を試してみました。

Xcodeの開発環境にLibxml2を引き込む

標準で使えると書きましたが、標準でライブラリは存在するが、標準でライブラリは引きこまれていません。個別に引き込む設定を行う必要があります。
Libxml2ライブラリの引き込み方は以下の方法が一番簡単でした。

プロジェクトを選択して「Build Phases」の設定画面を出します。「Link Binary With Libraries」を選択します。
後は図にあるとおり操作します。
＃実はこのやり方、後から気付きました。この後に書いてある「Add Files・・・」の方法よりもこっちの方が分かりやすいのではないかと思うのです。


この操作で問題なく出来ましたが、Xodeの「File」-「Add Files・・・」のメニューからも追加出来ました。この際は、以下ディレクトリのライブラリを指定しました。
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.3.sdk/usr/lib/

次にヘッダの引き込みパスを追加します。
下の図に示すとおり、「Build Settings」の「Search Paths」にある「Header Search Paths」に以下のパスを追加します。
/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator4.3.sdk/usr/include/libxml2


これで準備は完了。

解析対象のXML

サンプルとして以下のようなXMLをパースしてみます。

  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <root>
  3.     <entryList>
  4.         <entry id="1">information1</entry>
  5.         <entry id="2">information2</entry>
  6.         <entry id="3">information3</entry>
  7.         <entry id="4">information4</entry>
  8.         <entry id="5">information5</entry>
  9.     </entryList>
  10. </root>

実装

全体的な流れとしては、

1)XMLファイルの読み込みパース(xmlDocのオブジェクトの生成)
2)Contextオブジェクトの生成
3)XPath表現により該当ノード情報の取得

となります。

注意点としては、libxmlはC言語である事です。libxmlのライブラリ呼び出し部分は全てC言語で記述する必要がありますし、データ型もC言語の型になっているので、Objective-cというかiOS SDKのクラスとやりとりするには変換が必要です。ですが、やりとりする情報は文字列で、NSStringにはC言語のポインタからオブジェクト型へ、逆にオブジェクト型からC言語のポインタへの変換メソッドが提供されているので、苦労はありません。

1)XMLファイルの読み込みパース(xmlDocのオブジェクトの生成)

*XMLをパースして、必要なデータ修得するクラスを作成したので、そのクラスを例に書きます。以下、そのクラスのヘッダ。

  1. #import <Foundation/Foundation.h>
  2. #include <libxml/parser.h>
  3. #include <libxml/xpath.h>
  4.  
  5. @interface XmlParser : NSObject {
  6.     NSString* filename;
  7.     xmlDocPtr document;
  8. }
  9.  
  10. - (id) initWithFileName: (NSString*)name;
  11. - (NSDictionary*) getElementsByXPath: (NSString*)xpath;
  12. - (BOOL) parse;
  13. - (void) dealloc;
  14.  
  15. @property (retain, nonatomic) NSString* filename;
  16.  
  17. @end

XMLファイルの読み込みとパース
  1. - (BOOL) parse {
  2.     if (self.filename == nil) {
  3.         return NO;
  4.     }
  5.     //XMLをパース
  6.     //self.filenameはNSString型ですが、C言語のchar*型に変換する必要がります。
  7.     document = xmlParseFile([self.filename cStringUsingEncoding:NSUTF8StringEncoding]);
  8.     if (document == nil) {
  9.         return NO;
  10.     }
  11.     return YES;
  12. }

もし、URLからXMLを取得し、そのメモリからXMLを読み込ますには以下のようなイメージになると思います。
  1. NSURL *url = [NSURL URLWithString:@"http://hogehoge/hoge.xml"];
  2. NSString *xml = [NSString stringWithContentsOfURL:
  3.                                 url encoding:NSUTF8StringEncoding error:nil];
  4.  
  5. document = xmlParseMemory([xml UTF8String],
  6.                           [xml lengthOfBytesUsingEncoding:NSUTF8StringEncoding]);

2)Contextオブジェクトの生成

このへんはお決まりなのだと思います。

  1. - (NSDictionary*) getElementsByXPath:(NSString *)xpath {
  2.     if (document == nil) {
  3.         NSLog(@"document is nil.");
  4.         return nil;
  5.     }
  6.     if (xpath == nil || [xpath length] == 0) {
  7.         NSLog(@"xpath is nil or size zero.");
  8.         return nil;
  9.     }
  10.     
  11.     xmlXPathContextPtr context;
  12.     xmlXPathObjectPtr result;
  13.     
  14.     //新しいcontextを作成
  15.     context = xmlXPathNewContext(document);
  16.     if (context == nil) {
  17.         NSLog(@"xmlxpathnewContext error.");
  18.         return nil;
  19.     }
  20.  
  21. // 以下省略
  22. // 以下省略
  23. // 以下省略

3)XPath表現により該当ノード情報の取得

XPathという表現を使い、欲しいノードを指定します。XPathに関して詳細は、ここを参照。
今回解析するXMLの場合XPathとして"/root/entryList/entry"を指定します。
サンプルでは- (NSDictionary*) getElementsByXPath:(NSString *)xpath メソッドの引数としてXPathが受け渡されてくるイメージです。

  1. //2)からのつづき
  2. //2)からのつづき
  3. //2)からのつづき
  4.  
  5.     //XPathをCスタイルのポインタへ変換
  6.     xmlChar *_xpath = (xmlChar*)[xpath cStringUsingEncoding:NSUTF8StringEncoding];
  7.     //XMLを解析し、該当XPathに該当するデータを取得
  8.     result = xmlXPathEvalExpression(_xpath, context);
  9.  
  10.     //contextの解放
  11.     xmlXPathFreeContext(context);
  12.  
  13.     if (result != nil) {
  14.         NSMutableArray *keyArray = [[NSMutableArray alloc] init];
  15.         NSMutableArray *valueArray = [[NSMutableArray alloc] init];
  16.         
  17.         //解析結果からnodesetを取得
  18.         xmlNodeSetPtr nodeset = result->nodesetval;
  19.  
  20.         //nodeset->nodeNrにはXPathに該当する全ノードの個数が格納されている
  21.         for (int i=0; inodeNr; i++) {
  22.             //nodeset->nodeTabの配列にノードの情報が格納されている。
  23.             //型はxmlNodePtr型です。以下の処理で、XPathで指定した子ノードである
  24.             //entryタグで囲まれたテキストノードの内容が取得できます。
  25.             xmlChar *element = xmlNodeListGetString(
  26.                                      document, nodeset->nodeTab[i]->xmlChildrenNode, 1);
  27.             //以下の処理でentryタグのアトリビュートの取得をします。
  28.             xmlChar *attr = xmlGetProp(nodeset->nodeTab[i], (const xmlChar*)"id");
  30.             //log
  31.             NSLog(@"element : %s", element);
  32.             NSLog(@"id      : %s", attr);
  33.             
  34.             //データ返却用に解析結果を配列に格納
  35.             NSString *_key = [[NSString alloc] initWithUTF8String:(const char*)attr];
  36.             NSString *_value = [[NSString alloc] initWithUTF8String:(const char*)element];
  37.             [keyArray addObject: _key];
  38.             [valueArray addObject: _value];
  40.             //free xml char
  41.             if (element) {
  42.                 xmlFree(element);
  43.             }
  44.             if (attr) {
  45.                 xmlFree(attr);
  46.             }
  48.             [_key release];
  49.             [_value release];
  50.         }
  51.         //結果データの解放
  52.         xmlXPathFreeObject(result);
  53.         
  54.         NSDictionary *dictionary = 
  55.                     [NSDictionary dictionaryWithObjects:valueArray forKeys:keyArray];
  56.         [valueArray release];
  57.         [keyArray release];
  58.         
  59.         return dictionary;
  60.     }
  61.     return nil;
  62. }
  64. - (void) dealloc {
  65.     //documentの解放
  66.     if (document != nil) {
  67.         xmlFreeDoc(document);
  68.     }
  69.     //パーサの解放
  70.     xmlCleanupParser();
  71.     
  72.     [filename release];
  73.     [super dealloc];
  74. }

参考までに、xmlNode型の定義を以下に、tree.hに定義されていました。
  1. typedef struct _xmlNode xmlNode;
  2.  typedef xmlNode *xmlNodePtr;
  3.  struct _xmlNode {
  4.  void           *_private; /* application data */
  5.     xmlElementType   type; /* type number, must be second ! */
  6.     const xmlChar   *name;      /* the name of the node, or the entity */
  7.     struct _xmlNode *children; /* parent->childs link */
  8.     struct _xmlNode *last; /* last child link */
  9.     struct _xmlNode *parent; /* child->parent link */
  10.     struct _xmlNode *next; /* next sibling link  */
  11.     struct _xmlNode *prev; /* previous sibling link  */
  12.     struct _xmlDoc  *doc; /* the containing document */
  13.     
  14.     /* End of common part */
  15.     xmlNs           *ns;        /* pointer to the associated namespace */
  16.     xmlChar         *content;   /* the content */
  17.     struct _xmlAttr *properties;/* properties list */
  18.     xmlNs           *nsDef;     /* namespace definitions on this node */
  19.     void            *psvi; /* for type/PSVI informations */
  20.     unsigned short   line; /* line number */
  21.     unsigned short   extra; /* extra data for XPath/XSLT */
  22. };
  23.  
  24.     typedef enum {
  25.         XML_ELEMENT_NODE=  1,
  26.         XML_ATTRIBUTE_NODE=  2,
  27.         XML_TEXT_NODE=  3,
  28.         XML_CDATA_SECTION_NODE= 4,
  29.         XML_ENTITY_REF_NODE= 5,
  30.         XML_ENTITY_NODE=  6,
  31.         XML_PI_NODE=  7,
  32.         XML_COMMENT_NODE=  8,
  33.         XML_DOCUMENT_NODE=  9,
  34.         XML_DOCUMENT_TYPE_NODE= 10,
  35.         XML_DOCUMENT_FRAG_NODE= 11,
  36.         XML_NOTATION_NODE=  12,
  37.         XML_HTML_DOCUMENT_NODE= 13,
  38.         XML_DTD_NODE=  14,
  39.         XML_ELEMENT_DECL=  15,
  40.         XML_ATTRIBUTE_DECL=  16,
  41.         XML_ENTITY_DECL=  17,
  42.         XML_NAMESPACE_DECL=  18,
  43.         XML_XINCLUDE_START=  19,
  44.         XML_XINCLUDE_END=  20
  45. #ifdef LIBXML_DOCB_ENABLED
  46.         ,XML_DOCB_DOCUMENT_NODE= 21
  47. #endif
  48.     } xmlElementType;

上記のxmlNode構造体定義から分かるように、基本的にはxmlNode型の構造体が取得出来てしまえは、後はその親、子ノードの取得が可能なので、好きなようにノードを移動してデータ取得が出来ます。

例えば、
xmlChar *element = xmlNodeListGetString(
document, nodeset->nodeTab[i]->xmlChildrenNode, 1);

というコードは、以下とほぼ同等です。TEXTノードのテキストを取得します。

  1. xmlChar *element = nil;
  2.  if (nodeset->nodeTab[i]->children->type == XML_TEXT_NODE) {
  3.     element = nodeset->nodeTab[i]->children->content;
  4. }

また、アトリビュート値を取得している次のコードは、

xmlChar *attr = xmlGetProp(nodeset->nodeTab[i], (const xmlChar*)"id");

以下とほぼ同等です。プロパティのノードを取得して、属性名が"id"となっている値を取得しています。

  1. xmlChar *attr = nil;
  2. if (!xmlStrcmp(nodeset->nodeTab[i]->properties->name, (const xmlChar*)"id")) {
  3.     attr = nodeset->nodeTab[i]->properties->children->content;
  4. }

ちなみに、呼び出し元のコードは以下のようになりますが、XMLファイルを配置した絶対パスを取得するのにはまりました。
NSHomeDirectory()でアプリケーションのホームディレクトリディレクトリを取得してパスを求めることで解決しました。 ←間違い。こっち(Resource Bundle)を参照。
まあ、本当はXMLファイルをローカルに置いて使うような場面よりは、WEB上のXMLファイルを参照する場面の方が多いと思いますが。

  1. //アプリケーションのホームディレクトリからファイルパスを求める。
  2.     NSString * xmlFilePath = [NSHomeDirectory() stringByAppendingPathComponent:@"XmlParseTest.app/test.xml"];
  3.  
  4.     //ファイルを指定して初期化
  5.     XmlParser* _parser = [[XmlParser alloc] initWithFileName: xmlFilePath];
  6.  
  7.     //パース実行とその結果判定
  8.     if ([_parser parse] == NO) {
  9.         //parse error.
  10.         NSLog(@"parse error");
  11.     }
  12.     
  13.     //XPathを指定して結果を取得
  14.     myData = [_parser getElementsByXPath:@"/root/entryList/entry"];
  15.     
  16.     [_parser release];

まとめ
本当に一部ですみませんが、登場してきた関数をまとめますと、

xmlDocPtr xmlParseFile(const char * filename)
ファイルを読み込んでパースを行う
filename：ファイル名。マニュアルにはZIP圧縮ファイルでも大丈夫と記載がある(未検証)
戻り値：xmlDocPtr型。パースしたドキュメントのポインタが返却される。失敗した場合はNULLが返却される。
備考：パースに成功した場合は、XML操作後にxmlFreeDocを呼び出してメモリを解放する必要があります。
xmlDocPtr xmlParseMemory (const char * buffer, int size)
メモリからXMLを読み込んでパースします。
buffer：バッファへの先頭ポインタ。
size：データサイズ。
戻り値：xmlDocPtr型。パースしたドキュメントのポインタが返却される。失敗した場合はNULLが返却される。
備考：パースに成功した場合は、XML操作後にxmlFreeDocを呼び出してメモリを解放する必要があります。
void xmlFreeDoc (xmlDtdPtr cur)
ドキュメントを解放します。
cur：ドキュメントへのポインタ。
戻り値：なし。
備考
void xmlCleanupParser (void)
パースで使用したライブラリで使用しているメモリをクリーンします。
void：なし。
戻り値：なし。
備考
xmlXPathContextPtr xmlXPathNewContext (xmlDocPtr doc)
新しいXPathContextを作成します。
doc：documentへのポインタ。
戻り値：XPathContext構造体へのポインタ。
備考：戻り値のcontextは使用後に解放する必要があります。xmlXPathFreeContext参照。
xmlXPathObjectPtr xmlXPathEvalExpression (const xmlChar * str, xmlXPathContextPtr ctxt)
XPath表現を評価します。
str：XPath。
xmlXPathContextPtr：XPathContext構造体へのポインタ。
戻り値：xmlXPathObjectPtr型のオブジェクト。
備考：戻り値のobjectは使用後に解放する必要があります。xmlXPathFreeObject参照。
void xmlXPathFreeContext (xmlXPathContextPtr ctxt)
作成したcontextを解放します。。
ctxt：contextへのポインタ。
戻り値：なし。
備考
void xmlXPathFreeObject (xmlXPathObjectPtr obj)
作成したobjectを解放します。。
obj：オブジェクト(XPathの評価結果)へのポインタ。
戻り値：なし。
備考

XMLの関数は思った以上に多く存在します。以下の参考URLを参考にしてみると良いでしょう(英語)

参考URL http://xmlsoft.org/
投稿者 takuran 時刻: 3:03
ラベル:

0 件のコメント :

コメントを投稿

登録: コメントの投稿 ( Atom )