还有什么不能做？——细谈在C#中读写Excel系列文章之三

　　在第二篇文章中我已经向大家详细介绍了Excel 2007以后版本的文件的OpenXML结构。所谓的OpenXML结构从本质上来讲其实就是一个ZIP压缩包，所有基于OpenXML数据结构的文件都一样。这样文件的结构是开放的，你不需要借助于任何第三方的组件就可以读取文件中的数据，或者修改文件的内容。而且所有资源文件诸如图片和多媒体文件都是被编译成一个固定的格式存放在压缩包中，而不是传统形式上的流。另外，以压缩包的形式存储数据也使得文件所占用的空间更小。

　　这些都是它的优点。其实，微软在.NET中已经提供了相应的类库来帮助我们操作OpenXML文件，就像我在第二篇文章中向大家介绍的一样，微软把OpenXML压缩包称之为一个Package，在Package中的文件称作Parts，不同的Parts有自己的Content Type。Content Type可以描述任何内容，如application XML，user XML，images，sounds，videos，或者其它二进制内容。各个Part之间通过一个被称之为relationship的part连接起来，这个part其实也是一种特殊的XML文件，后缀为".rels"，在Package中可以找到它。下图说明了一个Package中各个Part之间的关系，

　　虽然.NET中提供的Package类可以帮助我们非常方便地解析Excel包，但是也有许多的局限性，有的时候你不得不使用一些方法来自己读取包中的内容，或者尝试去修改包中的数据。

　　1. 将Package作为一个标准的zip文件进行解压。

　　2. 找到Package中你想要读取的parts。有许多的方法可以帮助你找到这些parts，你可以解析relationship，也可以直接通过path来定位到某一个文件，不过不太确定path在将来是否会有变化。或者还可以通过part的content type来找到它。

　　3. 读取part中的内容。如果parts是以XML的形式存放的，通过标准的XML类库就可以非常方便地读取到数据。如果是其它形式，如图片、声音或视频文件则也可以通过相应的方法来获取到内容。

　　另一方面，你也可以创建一个基于OpenXML的文件（如采用非COM组件的形式创建一个Excel文件），

　　1. 创建或复制所有必须的parts。通过标准XML类库来创建这些基于XML数据格式的parts，或者从其它package中复制这些parts，或者采用任何其它你所熟悉的方法。

　　2. 创建relationships部分。也就是创建一个后缀为".rels"的特殊XML文件。

　　3. 将整个package压缩成一个zip包，然后将文件的后缀修改成需要的类型（如docx，xlsx，或者pptx等）。只要package中的结构符合要求，修改之后的文件可以直接被打开。当然，该过程可以在完全没有安装office的机器上完成（例如服务器），然后分发给需要的地方使用。

　　所有这一切包括packages，parts，content types，以及relationships都被称之为OpenXML文档，微软将这个叫做Open Packaging Conventions。

　　有关Excel OpenXML的内部结构以及一些比较重要的节点含义在前一篇文章中已经做了一些介绍，除了直接使用.NET类库中的Package类之外，我们当然也可以使用其它的第三方类库或者自己编写代码读取包中的内容，这里有一个.NET的开源类库专门用来操作zip压缩文件。

http://www.icsharpcode.net/OpenSource/SharpZipLib/

　　提供一个程序集下载吧，源代码大家去上面这个网址下载。ICSharpCode.ShareZipLib.zip

　　借用该类库中的ExtractZip()和CreateZip()方法可以帮助我们读取或修改（创建）Excel文件。当然这个类库中的某些代码是使用较早的.NET版本中的语法和对象来编写的，诸如ArratList、Hashtable等，它可能不适合在Silverlight工程中使用（支持Silverlight的.NET Framework与普通的.NET Framework有许多区别并且变化比较频繁），接下来的文章中我会向大家介绍如何在Silverlight工程中使用它。但现在并不妨碍我们在其它类型的工程中使用。

　　来看一看实际的例子。这里有一个类提供了一些方法用来读取和修改Excel文件中的数据：

using System.Collections.Generic;
using System.Data;
using System.Globalization;
using System.IO;
using System.Text;
using System.Xml;
using ICSharpCode.SharpZipLib.Zip;

namespace XlsxReadWrite
{
    internal static class XlsxRW
    {
        public static void DeleteDirectoryContents(string directory)
        {
            var info = new DirectoryInfo(directory);

            foreach (var file in info.GetFiles())
            {
                file.Delete();
            }

            foreach (var dir in info.GetDirectories())
            {
                dir.Delete(true);
            }
        }

        public static void UnzipFile(string zipFileName, string targetDirectory)
        {
            new FastZip().ExtractZip(zipFileName, targetDirectory, null);
        }

        public static void ZipDirectory(string sourceDirectory, string zipFileName)
        {
            new FastZip().CreateZip(zipFileName, sourceDirectory, true, null);
        }

        public static IList<string> ReadStringTable(Stream input)
        {
            var stringTable = new List<string>();

            using (var reader = XmlReader.Create(input))
            {
                for (reader.MoveToContent(); reader.Read(); )
                {
                    if (reader.NodeType == XmlNodeType.Element && reader.Name == "t")
                    {
                        stringTable.Add(reader.ReadElementString());
                    }
                }
            }

            return stringTable;
        }

        public static void ReadWorksheet(Stream input, IList<string> stringTable, DataTable data)
        {
            using (var reader = XmlReader.Create(input))
            {
                DataRow row = null;
                int columnIndex = 0;
                string type;
                int value;

                for (reader.MoveToContent(); reader.Read(); )
                    if (reader.NodeType == XmlNodeType.Element)
                        switch (reader.Name)
                        {
                            case "row":
                                row = data.NewRow();
                                data.Rows.Add(row);

                                columnIndex = 0;

                                break;

                            case "c":
                                type = reader.GetAttribute("t");
                                reader.Read();
                                value = int.Parse(reader.ReadElementString(), CultureInfo.InvariantCulture);

                                if (type == "s")
                                    row[columnIndex] = stringTable[value];
                                else
                                    row[columnIndex] = value;

                                columnIndex++;

                                break;
                        }
            }
        }

        public static IList<string> CreateStringTables(DataTable data, out IDictionary<string, int> lookupTable)
        {
            var stringTable = new List<string>();
            lookupTable = new Dictionary<string, int>();

            foreach (DataRow row in data.Rows)
                foreach (DataColumn column in data.Columns)
                    if (column.DataType == typeof(string))
                    {
                        var value = (string)row[column];

                        if (!lookupTable.ContainsKey(value))
                        {
                            lookupTable.Add(value, stringTable.Count);
                            stringTable.Add(value);
                        }
                    }

            return stringTable;
        }

        public static void WriteStringTable(Stream output, IList<string> stringTable)
        {
            using (var writer = XmlWriter.Create(output))
            {
                writer.WriteStartDocument(true);

                writer.WriteStartElement("sst", "http://schemas.openxmlformats.org/spreadsheetml/2006/main");
                writer.WriteAttributeString("count", stringTable.Count.ToString(CultureInfo.InvariantCulture));
                writer.WriteAttributeString("uniqueCount", stringTable.Count.ToString(CultureInfo.InvariantCulture));

                foreach (var str in stringTable)
                {
                    writer.WriteStartElement("si");
                    writer.WriteElementString("t", str);
                    writer.WriteEndElement();
                }

                writer.WriteEndElement();
            }
        }

        public static string RowColumnToPosition(int row, int column)
        {
            return ColumnIndexToName(column) + RowIndexToName(row);
        }

        public static string ColumnIndexToName(int columnIndex)
        {
            var second = (char)(((int)'A') + columnIndex % 26);

            columnIndex /= 26;

            if (columnIndex == 0)
                return second.ToString();
            else
                return ((char)(((int)'A') - 1 + columnIndex)).ToString() + second.ToString();
        }

        public static string RowIndexToName(int rowIndex)
        {
            return (rowIndex + 1).ToString(CultureInfo.InvariantCulture);
        }

        public static void WriteWorksheet(Stream output, DataTable data, IDictionary<string, int> lookupTable)
        {
            using (XmlTextWriter writer = new XmlTextWriter(output, Encoding.UTF8))
            {
                writer.WriteStartDocument(true);

                writer.WriteStartElement("worksheet");
                writer.WriteAttributeString("xmlns", "http://schemas.openxmlformats.org/spreadsheetml/2006/main");
                writer.WriteAttributeString("xmlns:r", "http://schemas.openxmlformats.org/officeDocument/2006/relationships");

                writer.WriteStartElement("dimension");
                var lastCell = RowColumnToPosition(data.Rows.Count - 1, data.Columns.Count - 1);
                writer.WriteAttributeString("ref", "A1:" + lastCell);
                writer.WriteEndElement();

                writer.WriteStartElement("sheetViews");
                writer.WriteStartElement("sheetView");
                writer.WriteAttributeString("tabSelected", "1");
                writer.WriteAttributeString("workbookViewId", "0");
                writer.WriteEndElement();
                writer.WriteEndElement();

                writer.WriteStartElement("sheetFormatPr");
                writer.WriteAttributeString("defaultRowHeight", "15");
                writer.WriteEndElement();

                writer.WriteStartElement("sheetData");
                WriteWorksheetData(writer, data, lookupTable);
                writer.WriteEndElement();

                writer.WriteStartElement("pageMargins");
                writer.WriteAttributeString("left", "0.7");
                writer.WriteAttributeString("right", "0.7");
                writer.WriteAttributeString("top", "0.75");
                writer.WriteAttributeString("bottom", "0.75");
                writer.WriteAttributeString("header", "0.3");
                writer.WriteAttributeString("footer", "0.3");
                writer.WriteEndElement();

                writer.WriteEndElement();
            }
        }

        public static void WriteWorksheetData(XmlTextWriter writer, DataTable data, IDictionary<string, int> lookupTable)
        {
            var rowsCount = data.Rows.Count;
            var columnsCount = data.Columns.Count;
            string relPos;

            for (int row = 0; row < rowsCount; row++)
            {
                writer.WriteStartElement("row");
                relPos = RowIndexToName(row);
                writer.WriteAttributeString("r", relPos);
                writer.WriteAttributeString("spans", "1:" + columnsCount.ToString(CultureInfo.InvariantCulture));

                for (int column = 0; column < columnsCount; column++)
                {
                    object value = data.Rows[row][column];

                    writer.WriteStartElement("c");
                    relPos = RowColumnToPosition(row, column);
                    writer.WriteAttributeString("r", relPos);

                    var str = value as string;
                    if (str != null)
                    {
                        writer.WriteAttributeString("t", "s");
                        value = lookupTable[str];
                    }

                    writer.WriteElementString("v", value.ToString());

                    writer.WriteEndElement();
                }

                writer.WriteEndElement();
            }
        }
    }
}

　　1. DeleteDirectoryContents()方法用来清空临时目录的内容，该临时目录被用来存放解压Excel之后的文件。

　　2. UnzipFile()方法直接使用了开源类库中的ExtractZip()方法，将Excel文件解压到临时目录。

　　3. ZipDirectory()方法使用开源类库中的CreateZip()方法将临时目录中的内容重新打包成zip压缩文件。

　　4. ReadStringTable()方法用来读取xl/sharedStrings.xml文件中节点t的内容。其实应该是直接读取si节点的内容，应为并不是所有的si节点都有t子节点。

　　考虑一个情况：在Excel的单元格中，选中一部分内容，如内容中的某一个数字或某一个单词，然后对它单独设置样式。通过这种方法你可以将Excel单元格中的某一部分内容设置为粗体、上标，还可以在单元格内进行换行等。如下图：

　　在Excel单元格内设置的样式被存放到sharedStrings.xml文件中后会变成如下这种形式：

<si>
    <r>
      <t xml:space="preserve">  Short-term investments (including securities loaned 
    of </t>
    </r>
    <r>
      <rPr>
        <b/>
        <sz val="8"/>
        <color rgb="FF404040"/>
        <rFont val="Verdana"/>
        <family val="2"/>
      </rPr>
      <t>$9,999</t>
    </r>
    <r>
      <rPr>
        <sz val="8"/>
        <color rgb="FF404040"/>
        <rFont val="Verdana"/>
        <family val="2"/>
      </rPr>
      <t xml:space="preserve"> and $8,888)</t>
    </r>
  </si>

　　这个时候节点si中的内容就不是单纯的子节点t了。因此，如何解析XML文件需要根据实际情况去考虑，这主要取决于你在Excel文件中存储的内容。

　　5. ReadWorksheet()方法会按照指定的工作表XML文件（如"xl/worksheets/sheet1.xml"）在sharedStrings.xml文件中查找数据，并将结果存放到一个DataTable中。

　　6. CreateStringTables()和WriteStringsTable()方法用来创建一个sharedStrings.xml文件。

　　7. WriteWorksheet()方法用来创建一个工作表XML文件。

　　来看看如何调用：

private void ReadInput(object sender, RoutedEventArgs e)
{
    // Get the input file name from the text box.
    var fileName = this.inputTextBox.Text;

    // Delete contents of the temporary directory.
    XlsxRW.DeleteDirectoryContents(tempDir);

    // Unzip input XLSX file to the temporary directory.
    XlsxRW.UnzipFile(fileName, tempDir);

    IList<string> stringTable;
    // Open XML file with table of all unique strings used in the workbook..
    using (var stream = new FileStream(Path.Combine(tempDir, @"xl\sharedStrings.xml"),
        FileMode.Open, FileAccess.Read))
        // ..and call helper method that parses that XML and returns an array of strings.
        stringTable = XlsxRW.ReadStringTable(stream);

    // Open XML file with worksheet data..
    using (var stream = new FileStream(Path.Combine(tempDir, @"xl\worksheets\sheet1.xml"),
        FileMode.Open, FileAccess.Read))
        // ..and call helper method that parses that XML and fills DataTable with values.
        XlsxRW.ReadWorksheet(stream, stringTable, this.data);
}

private void WriteOutput(object sender, RoutedEventArgs e)
{
    // Get the output file name from the text box.
    string fileName = this.outputTextBox.Text;

    // Delete contents of the temporary directory.
    XlsxRW.DeleteDirectoryContents(tempDir);

    // Unzip template XLSX file to the temporary directory.
    XlsxRW.UnzipFile(templateFile, tempDir);

    // We will need two string tables; a lookup IDictionary<string, int> for fast searching 
    // an ordinary IList<string> where items are sorted by their index.
    IDictionary<string, int> lookupTable;

    // Call helper methods which creates both tables from input data.
    var stringTable = XlsxRW.CreateStringTables(this.data, out lookupTable);

    // Create XML file..
    using (var stream = new FileStream(Path.Combine(tempDir, @"xl\sharedStrings.xml"),
        FileMode.Create))
        // ..and fill it with unique strings used in the workbook
        XlsxRW.WriteStringTable(stream, stringTable);

    // Create XML file..
    using (var stream = new FileStream(Path.Combine(tempDir, @"xl\worksheets\sheet1.xml"),
        FileMode.Create))
        // ..and fill it with rows and columns of the DataTable.
        XlsxRW.WriteWorksheet(stream, this.data, lookupTable);

    // ZIP temporary directory to the XLSX file.
    XlsxRW.ZipDirectory(tempDir, fileName);

    // If checkbox is checked, show XLSX file in Microsoft Excel.
    if (this.openFileCheckBox.IsChecked == true)
        System.Diagnostics.Process.Start(fileName);
}

　　你所要做的只是对XML进行操作，仅此而以！

　　支持.NET操作zip压缩包的类库应该还有很多，任何一个都可以，因为Excel的OpenXML文件本身就是一个标准的zip压缩包。但是上面的方法还是有一个局限性，那就是需要临时目录来存放解压之后的文件，以及重新打包时所指定的源文件。对普通的Windows应用程序或asp.net应用程序而言这个并没有什么困难，只要权限允许，读写临时目录没有任何问题，但是在Silverlight中则有所不同，因为在Silverlight中读写客户端文件需要比较高的安全级别和认证，这就导致解压文件会有困难，一个简单的方法就是直接在文件的流中进行解压和修改，然后再将流打包成zip文件。下一篇文章中我会向大家介绍如何在Silverlight中使用，以及如何定义一个类来完成Excel文件中某些字符串样式的修改。