J2ME 環境での XML パーサ

この報告について

この報告は J2ME 環境、特に携帯電話の Java アプリケーション実行環境において、XML パーサを使用する際の注意点や問題点について調査したものである。ここで使う XML パーサは通常のバイナリ化されていない XML データを扱うものとする。また、読み込んだ XML データの処理や XML データの生成・出力などについては扱わない。

J2ME 環境の概要

J2ME (Java2 platform, Micro Edition) は組み込み機器、PDA、携帯電話などのような環境に特化した Java 環境の仕様である。日本では携帯電話キャリア各社が J2ME 環境を内蔵した端末を採用したことで、特に携帯電話向けアプリケーションの主要なプラットフォームとして注目されている。以下、各社の携帯電話の J2ME 環境の仕様や制限などについて、XML パーサを動作させる際に注意が必要な点を見ていく。

J2ME と言っても API の互換性や実行環境の制限などの点で各社異なるのが実情である(参照: [iapp], [japp], [ezplus])。その概要を表1にまとめた。これらのうち API の違いについては XML パーサに直接関係しない。どれも CLDC (Connected, Limited Device Configuration) に準拠しており、XML パーサの機能は CLDC の API だけで実装できる。重要なのは、アプリケーション(JARファイル)のサイズとHTTP通信による一回の転送量の制限である。

アプリケーションが XML を利用する場合最低必要となるのが XML パーサだが、JAR ファイルが数10KB程度に制限される携帯電話の環境では使用できるパーサは限られてくる。

また、携帯電話の環境では HTTP 通信の転送量は 10KB 程度にまで制限されている。もっと制限が緩い場合でも現状では通信速度と課金を考慮してそのぐらいのサイズのデータを主に扱うことになるであろう。一般の XML パーサはもっと大きなサイズのデータでテストされているため、一般に高性能と言われているパーサが有利になるとは限らない。

メディアタイプの制限については注意が必要である。メディアタイプの制限はキャリアのゲートウェイが HTML や画像など特定のメディアタイプのコンテンツしか通さないことから生じる制限である。この制限を避けるためには、サーバー側でコンテンツに本来のメディアタイプ(SVG なら image/svg+xml など)ではないメディアタイプ(例えば application/java-archive)を設定するという、一種の偽装を行う必要がある。携帯電話側のアプリケーションでは HTTP レスポンスのメディアタイプを意識することはほとんどないので問題ないが、同じサーバーが一般の PC にも同じデータを配信している場合には、PC 側のブラウザでデータが表示できなくなる(ダウンロードになってしまう)という問題が発生しうる。

また接続先の制限についても知っておきたい。XML データに DTD や外部実体、XML Schema 文書などへの参照がある場合、接続先制限によって読み込めなくなることがある。現在のところ J2ME で使えるパーサでそれらの外部リソースへの参照を行えるものはほとんどないので実際には問題にならないかもしれないが、将来に向けて留意すべき点ではある。

軽量XMLパーサ

Java で動く XML パーサは数多いが、携帯電話の J2ME 環境で動くものは少ない。J2ME のAPIの制限からビルドできない、コードサイズが大きすぎる、メモリ使用量が大きい、などの問題で動作しない場合が多い。

そのような問題がないか、比較的簡単な作業でクリアできるものを表2に挙げた。コードサイズについてはパーサが動作する最小の構成で JAR ファイルのサイズが 20KB 程度以下になるものを選んだ。ビルドについては主観的ではあるが、ビルド時のエラーが 100 個以上出るものについてはその内容を検討し修正困難と判断したものを除外した。エラーが 100 個以内のものについては動作可能な状態になるまでソースコードを修正してテストした。

とりあえず動作はしても、実際に性能的・機能的な点で実用に耐えるかどうかという問題はあるが、この点については次章以降で検討する。また、ビルド時に必要な修正作業については「付録B.パーサの修正方法」を参照されたい。

なお、ここに挙げたものはいずれもソースコードを含め無料で入手できる。ただし再配布についてはライセンス上制限される場合がある。Min は独自のライセンス、それ以外はオープンソースライセンスであるが、BSD スタイルのライセンスでも内容が微妙に異なるものがある。詳しくは各パーサの付属文書等を参照されたい。

API については次章で説明する。API のうちパーサ独自のものについては「各種パーサの特徴」のパーサ毎の説明を参照されたい。

APIと互換性

ベンチマーク

テスト対象のパーサについて携帯電話実機の J2ME 環境で簡単なベンチマークテストを実施した。テスト内容は 10KB 程度の XML データをパースし、要素と属性と文字の数をカウントするというものである。

テストの手順は以下の通りである。

• ベンチマークアプリケーションを起動
• テストデータに対して6回のテストを実施しそれぞれの処理時間を測定。
• 2回目以降の5回の測定値の平均をパース時間とする。
• 初回の測定値からパース時間を引いた値を起動時間とする。
• カウントが正しい値になっているか確認する。

テストデータはベンチマークアプリケーションの JAR ファイル内のリソースからあらかじめ適切なエンコーディングを設定して作成した InputStreamReader を介して読み込んだ。ただし TinyXML については Reader からパースができないので InputStream から読み込んだ。

テストデータは三種類用意した。その内容を表6にまとめた。

表中の「マークアップ密度」は XML データの中でタグが占める割合を表す大まかな指標である。パーサの性能評価の場合、 1 - 文字内容のサイズ / ファイルサイズ で表される。一般にマークアップ密度の高いデータ程パーサに負荷がかかる。

なお、Minimal XML 準拠の Min に対しては Min に付属する minimizer というツール(を非ASCII文字の出力に対応させたもの)でテストファイルを Minimal XML に変換したものを使用した。

ベンチマークアプリケーションは CLDC/MIDP に準拠したもので、J-Phone の Java アプリとして動作するものである(ezplus での動作は未確認)。各パーサのクラスはパースに必要な最小限の構成でパッケージングした。詳細はベンチマークアプリケーションのソースコード[src]を参照されたい。

Java アプリ対応携帯電話である東芝 J-T51 上で実施したテスト結果は表7の通りである。各パーサのコードサイズ(パーサ実装のJARファイル換算のサイズ)も合わせて示した。

各パーサの特徴と評価

まとめ

今回の調査で J2ME 環境で XML パーサは使い物になるという見通しが立ったと考える。一般的な Shift_JIS の文書で 10KB を約 3 秒でパースできる(kXML2)ということはパース速度は約 28000 byte/sec であり、携帯電話の通信速度とほぼ同程度である。コードサイズについてはいわゆる第2世代の Java アプリケーションサービスではさほど障害にならない。ドコモの 503i については残念ながら厳しいが、NanoXML/Lite なら使える可能性がある。

今回テストしたパーサの中でベストチョイスを挙げるなら kXML2 がそれであろう。携帯電話の環境を考えた場合もっともバランスのとれたスペックを備えている。

アプリケーションのコードサイズが厳しい場合は、条件が許すなら NanoXML/Lite も有力な候補になるであろう。逆にコードサイズに余裕があるならパース速度優先で MXP1 を選択するのも良いだろう。ただし起動時間の長さには注意する必要がある。TinyXML は多機能なのにコードサイズが小さいという点で興味深いが、携帯電話の環境では多機能の部分があまり生きないし、完成度や将来性にも疑問があるので、自力でソースコードをメンテナンスできる人以外にはお奨めできない。

携帯電話で動作する XML パーサという厳しい要求に対して、意外にも多様な選択肢が存在することは喜ばしいことである。XML はモバイルアプリケーションにおいても有効なソリューションになるであろう。

A.参考文献

[iapp]

NTTドコモ i-appli 技術資料
http://www.nttdocomo.co.jp/mc-user/i/java/

[japp]

J-Phone Java アプリ 技術資料
http://www.dp.j-phone.com/java/index.html

[ezplus]

AU ezplus 技術資料
http://www.au.kddi.com/ezfactory/tec/spec/ezplus.html

[cxml]

ContactXML
http://www.contactxml.org/

[src]

この報告に関連したソースコード等
http://www.horobi.com/xml/mobile/res/

B.パーサの修正方法

今回のテストでは J2ME でビルドするため、およびサイズを縮小するために、パーサのソースコードを修正した。以下に修正方法の概要を示す。

SAX1 API

• org.xml.sax パッケージから以下のクラスを残してそれ以外は削除(MinML1 では修正済)。
  AttributeList, DTDHandler, DocumentHandler, EntityResolver, ErrorHandler, InputSource, Locator, Parser, SAXException, SAXParseException
  但し Min では HandlerBase を残しておく。
• org.xml.sax.helpers パッケージは全部削除(MinML1 では修正済)。場合によっては AttributeListImpl が必要かもしれないが、今回テストしたパーサでは不要だった。
• J2ME には Locale がないので Parser#setLocale() を削除。

アプリケーション側では ParserFactory を使わずに Parser 実装を直接 new する。

SAX2 API

• org.xml.sax パッケージから以下のクラスを残してそれ以外は削除(MinML2 では修正済)。
  Attributes, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, InputSource, Locator, SAXException, SAXNotRecognizedException, SAXNotSupportedException, SAXParseException, XMLReader
• org.xml.sax.helpers パッケージは全部削除(MinML2 では修正済)。場合によっては AttributesImpl, NamespaceSupport が必要かもしれないが、今回テストしたパーサでは不要だった。

アプリケーション側では XMLReaderFactory を使わずに XMLReader 実装を直接 new する。

XML Pull API

• org.xmlpull.v1 パッケージの XmlPullParserFactory, XmlSerializer を削除。

アプリケーション側では XmlPullParserFactory を使わずに XMLPullParser 実装を直接 new する。

MXP1

• String#intern() をしないようにする。これは名前空間 URL の比較に使っているので、名前空間の使用で問題があるかもしれないが、今回のテストでは確認していない。

kXML2

• org.kxml2.kdom パッケージを削除(パースには不要)。
• org.kxml2.wap パッケージを削除(パースには不要)。
• org.kxml2.io パッケージの KXmlSerializer を削除。

MinML1

• uk.org.xml.sax.Parser#setLocale() を削除。

NanoXML2/Lite

• J2ME には StringReader, CharArrayReader がないので String や char[] からパースするためのメソッドを nanoxml.XMLElement から削除。
• J2ME には double 型がないので、double 値を get/set するメソッドを nanoxml.XMLElement から削除。
• J2ME には Object#clone() がない。clone() を使っている nanoxml.XMLElement#getChildren() を削除。パースには影響はない。ノードへのアクセスには enumerateChildren() を使う。

TinyXML

• gd.xml.tiny パッケージを削除。これは tree based なパーサ用なので event based なパーサを使う場合は不要。
• J2ME では java.lang.Character から isLetter(), isLetterOrDigit() が削除されている。これらのメソッドを実装した MyCharacter クラスを作り、gd.xml.XMLParser 内の Character を MyCharacter に置き換える。
• 空白文字を捨てるバグを修正するために XMLParser.java の 825 行目
  

    readWhite();

  を、

    if(inEpilog || inProlog) readWhite();

  に置き換える。
• gd.xml.XMLReader で String#intern() を使っている部分を使わないように修正する。

Min

• J2ME には CharConversionException はないので com.docuverse.min.UTF-8 ではこれのかわりに IOException を throw する。Parser.java の該当する catch 節は削除。
• com.docuverse.min.Parser#parse(String, boolean) を削除。
• com.docuverse.min.Parser#parse(String) を parse(InputSorce) を呼ぶように修正。
• com.docuverse.min.Parser#parse(InputSource, boolean) で入力がファイルの時に IOException を throw するように修正。
• com.docuverse.min.Parser から Locale 関係のコードを削除。
• com.docuverse.min パッケージから SAXParserFactoryImpl, SAXParserImple を削除。
• com.docuverse.min.util パッケージを削除。
• Minimizer で SJIS 文書を出力したい場合は非 ASCII 文字を文字参照にしないように、Minimizer.java の 221 行目の

    text.append("&#");
    text.append(c);
    text.append(";");

  を、

    text.append(ch[i]);

  に置き換える。