Steven Blogs

在.NET中读写INI文件 ——兼谈正则表达式的应用

sam1111（原作） 关键字:正则表达式

INI文件是Windows平台上的一种较常用的软件配置文件格式，Windows应用程序常常使用它来保存一些配置信息。它一般是由数个包含key-value对的Section组成，每个key-value对保存着一些软件配置信息。例如最典型的NT系列的启动配置文件boot.ini：

[boot loader]
timeout=30
default=multi(0)disk(0)rdisk(0)partition(2)\WINDOWS
[operating systems]
multi(0)disk(0)rdisk(0)partition(2)\WINDOWS="Microsoft Windows XP Professional" /fastdetect
multi(0)disk(0)rdisk(0)partition(1)\WINDOWS="Microsoft Windows XP Professional" /fastdetect

在这个文件中，方括号中的字符串是Section的名字，两个方括号之间的内容为一个Section。Section的内容是一些key-value对，每个key-value对占据一行，例如timeout=30就是一对key-value对，timeout是key，对应的value是30。Windows平台专门提供了一组API可以方便地操作INI文件，例如GetPrivateProfileSection()、GetPrivateProfileInt()等。

随着Windows系列操作系统的不断发展，INI文件的作用逐渐被注册表、XML格式的config文件等所取代，很少再用于系统配置，但我们仍可以在应用程序中使用它。在.NET平台上推荐使用的软件配置文件格式是基于XML的config文件，因此在.NET Framework中并没有提供对INI文件读写的特殊支持，使得我们有时在需要读写INI文件时不是很方便。本文将探讨如何使INI文件的读写在.NET平台上变得更加容易。当然，我们可以直接引入上述的API，但本文将不使用API，而是完全基于.NET Framework。

创建INI文件读写类

要在.NET平台上处理INI文件，很自然的想法就是创建一个专门的class来负责INI文件的读写工作，这个class暴露适当的接口供外部调用。一般的INI文件的尺寸很小，因此最简单的做法就是以文本的方式将整个文件读入一个string变量中。类定义如下：

public class FileIni
{
    private string fileContents = null;

    public FileIni(string fileName)
    {
        if (File.Exists(fileName))
        {
            StreamReader r = File.OpenText(fileName);
            fileContents = r.ReadToEnd();
            r.Close();
        }
    }
}

接下来我们要提供一些方法来操作这个字符串，比如从中返回所有的Section Name、取得特定的key所对应的value等。我们可以使用字符串查找之类的方法来完成这些工作，但是.NET Framework为我们提供了更好的方法，那就是正则表达式。

正则表达式

所谓正则表达式是一种被设计用来优化字符串操作的语言。它使用一组元字符（Metacharacters）来实现强劲的字符串操作能力。这组元字符最早来自于对DOS文件系统中?和的扩展。在DOS文件系统中，?和分别被用来代替单个字符和字符群组，它们可以被认为是最早的元字符。正则表达式在它们的基础上不断扩充，形成了一套元字符集，能够表达非常复杂的字符串。

举例来说，网上注册时常常需要用户输入一个有效的Email地址。当用户输入一个字符串后，我们如何验证这个Email地址是否合法呢？使用下面这个正则表达式可以轻易地实现目的：

@"^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$"

关于这个正则比表达式的含义，在此不做过多解释，有兴趣的朋友可以参考相关的正则表达式资料。这个正则表达式虽不能保证用户输入的Email地址100%的真实有效，但至少可以保证用户输入的Email地址看上去是合法有效的。

.NET Framework中提供了一些使用正则表达式的类，这些类位于System.Text.RegularExpressions名字空间下。

使用正则表达式实现FileIni类的功能

现在我们可以使用正则表达式来实现FileIni类的相应功能了。为了返回INI文件中所有Section的名字，我们可以使用一个只读属性SectionNames来返回一个Section Name的字符串数组。

public string[] SectionNames
{
    get
    {
        // Using regular expression to get all section names.
        string regexPattern = @"\[(?<SectionName>\w*)\]";
        Regex r = new Regex(regexPattern);  // Match "[anywords]"
        MatchCollection matches = r.Matches(fileContents);
        // Writing all section names to a string array.
        string[] results = new string[matches.Count];
        for (int i = 0; i < matches.Count; i++)
        {
            results[i] = matches[i].Result("${SectionName}");
        }

        return results;
    }
}

在上面的代码中，我们使用一个正则表达式：@"\[(?<SectionName>\w*)\]"，对源字符串进行一次匹配就取出了所有的Section Name。

为了取得特定Section下的特定的key的value，我们先要取得此Section下的所有内容，然后再从中取出特定key的value。

public string GetSectionString(string sectionName)
{
    string regexPattern = @"(\[" + sectionName + @"\]"
        + @"(?<SectionString>.*)\[)";
    Regex r = new Regex(regexPattern, RegexOptions.Singleline);
    if (r.IsMatch(fileContents))
    {
        return r.Match(fileContents).Result("${SectionString}");
    }

    return string.Empty;
}

GetSectionString()根据特定的sectionName取得此Section的全部内容。假设sectionName为字符串boot loader，此时的正则表达式为@"(\[boot loader\](?<SetionString>.*)\[]"。得到Section下的所有内容后，我们再从其中得到我们想要的value值。

public string GetKeyString(string sectionName, string keyName)
{
    string sectionString = this.GetSectionString(sectionName);
    string regexPattern = @"(" + keyName + @"=(?<value>.*)\r\n)";
    Regex r = new Regex(regexPattern);
    if (r.IsMatch(fileContents))
    {
        return r.Match(fileContents).Result("${value}");
    }

    return string.Empty;
}

在此基础上，可以得到更多的诸如GetKeyInt()之类的方法。至于写方法，利用Regex的Replace()方法也是很容易实现的，在此就不做过多的叙述了。

总结

本文着重演示了正则表达式在读写INI文件时的应用。所实现的INI文件读写类FileIni扩展性稍显不足，例如，这个类只能处理通用格式的INI文件，对于格式稍有变化的INI文件，此类中的正则表达式就需要修改了。总之，正则表达式是处理字符串的强大工具，掌握了它

对我们更高效地处理字符串是绝对有好处的。

对该文的评论 人气：3040

sam1111 (2003-9-20 22:00:29)

上面的正则表达式是经过测试的。但是，由于我是直接写来处理一种固定格式的INI文件，因此通用性不是很强。可能需要根据你的INI文件的格式做适当的修改。

boy9732 (2003-9-18 17:50:39)

正则表达式好东东..一定得学会

diaopeng (2003-9-18 11:48:49)

这上面写的正则表达式有没有测试过的？？？为什么我用了没有结果的？？？谁能解释一下？？？

Zane (2003-9-17 11:04:41)

^_^，终于知道 正则表达式 的妙用，谢谢！

Contributors: FHL