実体参照宣言を利用して分割した XML を XmlDocument に読み込み XmlSerializer でデシリアライズするには

例えば次のような命題を考える。

あるバッチ処理を行う C# プログラムを作成する。バッチ処理の成否をメールで通知する必要がある。通知先のメールアドレスを、下記のような XML ファイルに記述して設定とすることにした。

fig.1 sendMail.xml

<?xml version="1.0" ?>
<sendMail>
<success>
<sendto name="Taro" address="taro@xxx.com"/>
</success>
<fail>
<sendto name="Taro" address="taro@xxx.com"/>
<sendto name="Jiro" address="jiro@xxx.com"/>
</fail>
</sendMail

バッチ処理が成功したら Taro さんに、失敗したら Taro さんと Jiro さんにメールが送られる、という寸法である。

ところで、Taro さんは、success ノードにも fail ノードにも繰り返し現れる。冗長である。Taro さんのメールアドレスが実は taro@xxx.jp であることが後で発覚した場合どうするか（実は、エディタで置換してしまえば済むのだけれど、これはあくまでシンプルな例ということで）。

そんな場合は、@IT の記事「実体参照宣言を利用して、XML文書を分割管理する」が役に立つ。この記事に従って、上記 XML を次のように分割できる。

fig.2 taro.xml

<?xml version="1.0" ?>
<sendto name="Taro" address="taro@xxx.com"/>

fig.3 jiro.xml

<?xml version="1.0" ?>
<sendto name="Jiro" address="jiro@xxx.com"/>

fig.4 sendMail.xml

<?xml version="1.0" ?>
<!DOCTYPE sendMail [
<!ENTITY taro SYSTEM "taro.xml">
<!ENTITY jiro SYSTEM "jiro.xml">
]>
<sendMail>
<success>
&taro;
</success>
<fail>
&taro;
&jiro;
</fail>
</sendMail>

これで Taro さんのメールアドレスを修正する必要に迫られても、taro.xml だけを修正すれば済む。

早速、このように改訂した sendMail.xml を、System.Xml.XmlDocument クラスの Load(string path) メソッドを使って読み込んでみた。

XPath を指定して、doc.SelectSingleNode("/sendMail/success/sendto") などとトラバースするぶんにはきちんと期待した値が返ってきた。つまり、XML を分割する/しないで挙動に変化がないわけだ。これは期待したとおりの正しい動作だ。

ところが、こうして読み込んだ XmlDocument オブジェクトを使って XmlSerializer を使ってデシリアライズすると、どうも、実体参照 &taro; と &jiro; が解決されないままのようにデシリアライズされてしまうのだ。

もう少し具体的に書くとこんな感じ。

// * SendMail というクラスを別途作成してるものとして見てください。
XmlSerializer serializer = new XmlSerializer(typeof(SendMail));
SendMail sendMail = serializer.Deserialize(new XmlNodeReader(doc)) as SendMail;
sendMail.Success.SendTo.Length ==> なんと 0 !

これは困った。XmlDocument の SelectNodes や SelectSingleNode は期待どおりの動作をしているので、構文誤りやスペルミスではないはずだ。
他にも、改訂後の sendMail.xml を IE で開いたところは正しく期待したとおりに、fig.1 のように表示される。

これは困ったなぁ、と思案しつつ、Visual Studio 2005 上で sendMail.xml を開き、データグリッドビューで正しく期待したとおりに表示されるか試したところ、なんと、ある種のエラーメッセージが表示された。なにやら、XmlReader を使えば実体参照宣言をちゃんと解釈して読めるよ（このデータグリッドビューは XmlReader 使ってないので、実体参照宣言を解釈できず表示しませんよ）ということらしい。

"XmlReader" というのがヒントになった。

そこで次のようにコードを書き換えてみた。

XmlDocument doc = new XmlDocument();
XmlReaderSettings settings = new XmlReaderSettings();
settings.ProhibitDtd = false;// ※既定ではDTDは処理しないので、処理するようフラグ指定してXmlReaderを用意
using (XmlReader reader = XmlReader.Create(path, settings))
{
  doc.Load(reader);
}
// このあと XmlSerializer でデシリアライズ実行

見事成功。

このように、XmlDocumnt.Load メソッドで、ファイルパスを渡すバージョンではなく、XmlReader を渡すバージョンを使って、XmlReader 経由で読み込めば、実体参照宣言を利用して分割した XML でも、XmlSerializer によるデシリアライズが行えることがわかった。