c#操作Xml（六）

前言

    最近工作比较忙，都没空写Blog，一拖就拖了一个月。废话就不说了，回顾一下上集，讲到了如何用Linq写一个超大的Xml，而不至于内存溢出，但是用Linq始终有一个限制，那就是必须要安装.net Framework 3.5，如果部署环境上没有安装3.5的，那如何是好啊？

设置目标

    不妨把目标设置得与前一篇相同，也是把某目录下的所有文件和目录输出到一个xml里面去，这里就不再重复了。

分析

    来分析一下，首先没有3.5框架，就不要指望XStreamingElement了，然后，排除DOM和其他的In-Memory方式，这些方式无法写一个超大xml并且内存不溢出。

    先来看看msdn上的关于Xml的处理，不难看到一篇关于XmlWriter的文章。对了，XmlWriter就是今天的主角，不过，XmlWriter是个抽象类，如何获得实例哪？ms是推荐使用XmlWriter.Create方法。msdn里面的原话是：

    虽然 Microsoft .NET Framework 包括 XmlTextWriter 类（该类是 XmlWriter 类的具体实现），但是在 2.0 版中的推荐做法是使用 Create 方法创建 XmlWriter 实例。

尝试

    最基础的就不说了，直接看msdn，直接来看看怎么用XmlWriter吧，先来个最简单的：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    writer.WriteElementString("root", "test");
    writer.WriteEndDocument();
}

    来看看输出结果吧：

<?xml version="1.0" encoding="gb2312"?><root>test</root>

    这个Xml中包含一个root节点，内容为test，是不是很简单，来个稍微复杂点的：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    writer.WriteStartElement("root");
    writer.WriteString("test");
    writer.WriteEndElement();
    writer.WriteEndDocument();
}

    看起来复杂了一些，不过运行的结果却是完全一样的。不过，如果细心的话，还可以看到另一个方法，WriteFullEndElement，这个方法与WriteEndElement有什么区别哪？不妨直接做个试验：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    writer.WriteStartElement("root");
    writer.WriteString("test");
    writer.WriteFullEndElement();
    writer.WriteEndDocument();
}

    运行的结果，与使用WriteEndElement没有区别，两者真的没有区别吗？

    其实还是有一些小区别的，做下面一个试验，当去掉Element中间的内容时，也就是：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    writer.WriteStartElement("root");
    writer.WriteEndElement();
    writer.WriteEndDocument();
}

    这样的输出结果是：

<?xml version="1.0" encoding="gb2312"?><root />

    而当使用WriteFullEndElement时，即：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    writer.WriteStartElement("root");
    writer.WriteFullEndElement();
    writer.WriteEndDocument();
}

    则数据结果变为：

<?xml version="1.0" encoding="gb2312"?><root></root>

    也就是WriteEndElement会自动将没有内容的节点用Xml节点的缩写方式，而WriteFullEndElement则强制使用Xml节点的完整写法。

    当然，如果Start和End没有配对的话，在WriteEndDocument时，会自动帮你关闭，例如：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    writer.WriteStartElement("root");
    writer.WriteEndDocument();
}

    一样可以写出：

<?xml version="1.0" encoding="gb2312"?><root />

    当然，这个容错机制还是尽量不要依赖。

实现

    回到我们的目标，需求是写出目录和文件。为了完成这个目标，需要这样一个方法：

static void GetFolderContent(XmlWriter writer, DirectoryInfo di)
{
    writer.WriteStartElement("folder");
    writer.WriteAttributeString("name", di.Name);
    foreach (var subDir in di.GetDirectories())
    {
        GetFolderContent(writer, subDir);
    }
    foreach (var fi in di.GetFiles())
    {
        writer.WriteStartElement("file");
        writer.WriteAttributeString("name", fi.Name);
        writer.WriteEndElement();
    }
    writer.WriteFullEndElement();
}

    当然还需要一个入口：

using (var writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartDocument();
    var di = new DirectoryInfo(@"..");
    GetFolderContent(writer, di);
    writer.WriteEndDocument();
}

    来看看输出的结果：

<?xml version="1.0" encoding="gb2312"?><folder name="bin"><folder name="Debug"><file name="ConsoleApplication6.exe" /><file name="ConsoleApplication6.exe.config" /><file name="ConsoleApplication6.pdb" /><file name="ConsoleApplication6.vshost.exe" /><file name="ConsoleApplication6.vshost.exe.config" /><file name="ConsoleApplication6.vshost.exe.manifest" /></folder><folder name="Release"><file name="ConsoleApplication6.exe" /><file name="ConsoleApplication6.exe.config" /><filename="ConsoleApplication6.pdb" /><file name="ConsoleApplication6.vshost.exe" /><file name="ConsoleApplication6.vshost.exe.config" /><file name="ConsoleApplication6.vshost.exe.manifest" /></folder></folder>

    Oh，no!一坨xml，根本没法看！这是因为XmlWriter默认配置是产生一个最小的xml，而不是一个可读的xml。

    接下来，把目标修改为生成一个可读的xml。我们需要做的修改就是加一个Setting，也就是：

using (var writer = XmlWriter.Create(Console.Out, new XmlWriterSettings
    {
        Indent = true
    }))
{
    writer.WriteStartDocument();
    var di = new DirectoryInfo(@"..");
    GetFolderContent(writer, di);
    writer.WriteEndDocument();
}

    简单吧，再来看看输出：

<?xml version="1.0" encoding="gb2312"?>
<folder name="bin">
  <folder name="Debug">
    <file name="ConsoleApplication6.exe" />
    <file name="ConsoleApplication6.exe.config" />
    <file name="ConsoleApplication6.pdb" />
    <file name="ConsoleApplication6.vshost.exe" />
    <file name="ConsoleApplication6.vshost.exe.config" />
    <file name="ConsoleApplication6.vshost.exe.manifest" />
  </folder>
  <folder name="Release">
    <file name="ConsoleApplication6.exe" />
    <file name="ConsoleApplication6.exe.config" />
    <file name="ConsoleApplication6.pdb" />
    <file name="ConsoleApplication6.vshost.exe" />
    <file name="ConsoleApplication6.vshost.exe.config" />
    <file name="ConsoleApplication6.vshost.exe.manifest" />
  </folder>
</folder>

    这下看起来舒服了吧。好，让我们试验一下输出c:\的吧，也就是：

using (var writer = XmlWriter.Create(Console.Out,
    new XmlWriterSettings
    {
        Indent = true
    }))
{
    writer.WriteStartDocument();
    var di = new DirectoryInfo(@"c:\.");
    GetFolderContent(writer, di);
    writer.WriteEndDocument();
}

    是不是看到文件/目录一排一排的出来，当然在短暂的停留时，可以看到节点写到一半的情况，在使用XStreamingElement也一样有这样的情况，当然XStreamingElement要解决这个问题比较麻烦，不过，XmlWriter则可以很简单的解决这个问题，只需要对GetFolderContent方法做一个小修改就可以了：

static void GetFolderContent(XmlWriter writer, DirectoryInfo di)
{
    writer.WriteStartElement("folder");
    writer.WriteAttributeString("name", di.Name);
    foreach (var subDir in di.GetDirectories())
    {
        GetFolderContent(writer, subDir);
    }
    foreach (var fi in di.GetFiles())
    {
        writer.WriteStartElement("file");
        writer.WriteAttributeString("name", fi.Name);
        writer.WriteEndElement();
    }
    writer.WriteFullEndElement();
    writer.Flush();
}

    就加了个Flush的调用，再看看输出效果，当然如果太快的话，也可以用Ctrl+C去中断程序执行，也可以发现基本上每次输出都是到一个Folder的完结的地方。

总结和下集预告

    写到这里，有没有感受到XmlWriter的强大？缺点就是不像Linq to Xml这样的简洁，不过优点就是能够满足那些有很强的控制欲望的人。

    哦，对了，本来说这集还要讲XmlReader，这集怎么没看到出场呀？一个没注意，就写了这么多关于XmlWriter的，哎，XmlReader就只能等待下集露面了。

PS:下集可能还要等待一段时间，项目忙呀。。。