.NET平台开源项目速览(5)深入使用与扩展SharpConfig组件

　　上个月在文章：这些.NET开源项目你知道吗？让.NET开源来得更加猛烈些吧  和 .NET平台开源项目速览(1)SharpConfig配置文件读写组件 中都提到了SharpConfig组件，简单轻量级，速度快，而且还有比较深入的使用介绍。在文章发布后，也有网友提到一些问题，当时我也没仔细去分析，在这次我亲自使用的过程中，就对几个问题进行了比较深入的研究，同时对不满足自己的地方，也进行了扩展。所以今天就把对SharpConfig的源码进行一个简单的分析，同时也根据需求对自己的一个特殊情况进行扩展。自己动手丰衣足食。。。

.NET开源目录：【目录】本博客其他.NET开源项目文章目录

 本文原文地址：.NET平台开源项目速览(5)深入使用与扩展SharpConfig组件

1.SharpConfig源码分析

　　SharpConfig源码并不大，核心代码其实也很简单，就是文件读写，解析。在深入使用和扩展SharpConfig之前，有必要了解一下它的基本结构。所以先来介绍SharpConfig源码中核心的3大类。

 　　Configuration是核心类，我们在前面的文章中只是简单的介绍了一下如何加载配置文件，查看源代码，可以发现加载和保存的方法都是匹配的，都可以从文件或者数据流中加载或者保存。

     由于每一个配置文件都包含若干个Section节，所以也可以使用索引来获取这些节，然后操作节下面的设置项。总的来说思路是很简单的。　　

　　Configuration在解析过程中，每碰到一个Section，就添加到列表中。而Section的区分就是靠Name，所以，我们在配置文件中注意不要把Section的名称搞混淆了。Section源码中没有特别需要注意的地方，主要是这里检测和移除节点的方法，如下面代码：

/// <summary>检测节中是否存在某个特定名称的设置 </summary>
/// <param name="settingName">设置项的名称</param>
/// <returns>True if the setting is contained in the section; false otherwise.</returns>
public bool Contains(string settingName)
{
    return GetSetting(settingName) != null;
}

/// <summary>从本节中移除某个名称的设置</summary>
public void Remove(string settingName)
{
    if (string.IsNullOrEmpty(settingName))
        throw new ArgumentNullException("settingName");

    var setting = GetSetting(settingName);

    if (setting == null)
    {
        throw new ArgumentException("The specified setting does not exist in the section.");
    }
    mSettings.Remove(setting);
}

　　每一个Section下面可以有多个Setting设置。下面看看Setting类的情况。 Setting主要是获取和设置值的方法，如代码：　

var someInteger = section["SomeInteger"].GetValue<Boolean>();
float someFloat = section["SomeFloat"].GetValue<float>();

　　　　什么只是简单的对SharpConfig 的结构做一个分析，下面我们将针对问题进行跟深入的分析和修改。

2.SharpConfig使用问题与扩展

2.1 读取乱码的问题

　　第一次发现这个问题并不是我，是网友在看完我的文章介绍后使用，发现读取出来是乱码，不能解析。然后反馈给我。其实问题很简单，只是我也没有注意，其实读取的时候也多个方法可以选择， 默认使用的是null编码设置，系统自动检测，但这非常不保险。最好还是自己把文件的编码写进去。例如：

Configuration config = Configuration.LoadFromFile("example.ini", Encoding.GetEncoding("gb2312"));

这样修改后，如果配置文件中有中文，一般是没问题的。非常重要的一点，如果你读取的时候用了固定编码，修改配置值需要保存的时候，也一定要加上编码，否则会导致其他的配置都发生乱码的情况。如下面的代码：

config.Save("example.ini", Encoding.GetEncoding("gb2312"));

　　编码的问题，我们可以看一下源码中的情况：

/// <summary>从配置文件直接加载，自动检测编码类型，以及使用默认的设置</summary>
/// <param name="filename">本地配置文件名称</param>
public static Configuration LoadFromFile(string filename)
{
    return LoadFromFile(filename, null);
}

/// <summary>从配置文件直接加载</summary>
/// <param name="filename">本地配置文件名称</param>
/// <param name="encoding">文件的编码类型，如果为Null,则自动检测</param>
public static Configuration LoadFromFile(string filename, Encoding encoding)
{
    if (!File.Exists(filename))
        throw new FileNotFoundException("Configuration file not found.", filename);

    Configuration cfg = null;

    if (encoding == null)
        cfg = LoadFromText(File.ReadAllText(filename));
    else
        cfg = LoadFromText(File.ReadAllText(filename, encoding));

    return cfg;
}

2.2 需要赋空值的情况

　　碰到这个问题，可能有些变态吧。其实并不是一个问题，如果需要是String，建议直接写一个固定的值，在后台读取的时候进行判断，因为SharpConfig处理的时候，会剔除前后的空白字符。所以这种情况你直接给空字符串是不可取 的，给一个 null，然后后台判断是否==null，然后进行对应操作；如果是数值类型，也可以特定的设置一个值，比如为0，转换 的时候 判断是否为0，否则作为空处理。

2.3 #注释符与字符串冲突的问题

　　在SharpConfig中，其实有一个可以定义注释符的地方。

/// <summary>获取或者设置 注释标识字符</summary>
public static char[] ValidCommentChars
{
    get { return mValidCommentChars; }
    set
    {
        if (value == null) throw new ArgumentNullException("value");
        if (value.Length == 0)
        {
            throw new ArgumentException("The comment chars array must not be empty.","value");
        }
        mValidCommentChars = value;
    }
}

　　在配置类的静态构造函数中，默认给了这几个字符作为标识符：

//静态构造函数，设置这些默认值，因此可以修改
static Configuration()
{
    mNumberFormat = CultureInfo.InvariantCulture.NumberFormat;
    mValidCommentChars = new[] { '#', ';', '\'' };
    mIgnoreInlineComments = false;
    mIgnorePreComments = false;
}

　　所以如果配置文件中值可能会出现#号的情况，那你就找一个不出现的 字符，来单独作为你的注释标记符，给这个静态属性赋值即可。

2.4 字符串需要换行的问题

　　这个问题也很有意思。如果是一行固定文本，你放在配置文件，会自动显示换行，但是读取的时候，人家是看做一行的。因为没有换行符结尾。而如果有几段字符，换行符分割开了，这个时候SharpConfig是肯定不支持的，我们可以看一下SharpConfig中核心的解析函数：

//根据字符串解析配置文件，核心的解析函数
private static Configuration Parse(string source)
{
    //重置临时字段
    mLineNumber = 0;

    Configuration config = new Configuration();
    Section currentSection = null;
    var preComments = new List<Comment>();
    
    using (var reader = new StringReader(source))
    {
        string line = null;

        // 读取一行，直到结尾（Read until EOF.）
        while ((line = reader.ReadLine()) != null)
        {
            mLineNumber++;
            //删除前后空白字符
            line = line.Trim();

            //这里扩展核心的换行支持，使用 3个 ... 开头，说明是上一个设置的换行
            //每一次行都读取下一行试一下，如果有...，就添加
            if(line.StartsWith("..."))
            {
                var text = "\r\n" + line.Substring(3);
                currentSection[currentSection.SettingCount - 1].Value += text;
                continue;
            }
            //如果是空行跳过
            if (string.IsNullOrEmpty(line)) continue;

            int commentIndex = 0;
            var comment = ParseComment(line, out commentIndex);

            if (!mIgnorePreComments && commentIndex == 0)
            {
                // 解析注释行，添加到 注释列表中去
                preComments.Add(comment);
                continue;
            }
            else if (!mIgnoreInlineComments && commentIndex > 0)
            {
                // 去掉这一行的注释
                line = line.Remove(commentIndex).Trim();
            }

            //如果开始字符是 [ ,说明是 节(Sections)
            if (line.StartsWith("["))
            {
                #region 节解析
                currentSection = ParseSection(line);

                if (!mIgnoreInlineComments)
                    currentSection.Comment = comment;

                if (config.Contains(currentSection.Name))
                {
                    throw new ParserException(string.Format(
                        "The section '{0}' was already declared in the configuration.",
                        currentSection.Name), mLineNumber);
                }

                if (!mIgnorePreComments && preComments.Count > 0)
                {
                    currentSection.mPreComments = new List<Comment>(preComments);
                    preComments.Clear();
                }

                config.mSections.Add(currentSection);
                #endregion
            }
            else  //否则就是键值设置行
            {
                //解析设置行
                Setting setting = ParseSetting(line);

                if (!mIgnoreInlineComments) setting.Comment = comment;

                if (currentSection == null) throw new ParserException(string.Format("The setting '{0}' has to be in a section.", setting.Name), mLineNumber);

                if (currentSection.Contains(setting.Name)) throw new ParserException(string.Format("The setting '{0}' was already declared in the section.", setting.Name), mLineNumber);

                if (!mIgnorePreComments && preComments.Count > 0)
                {
                    setting.mPreComments = new List<Comment>(preComments);
                    preComments.Clear();
                }
                currentSection.Add(setting);
            }

        }
    }
    return config;
}

　　上面我进行了注释的翻译，从流程可以看到，SharpConfig是依次读取每一行直接进行转换，看看满足什么特征，然后进行处理。如果直接换行，没有Name和=号对应，那会报错。所以我们自己动手，扩展一下，其实非常简单。

　　上述代码是我已经扩展好的，思路很简单，我们选得一个标记字符串，这里使用“...”作为值换行的标记，每一次读取新行的值后，我们先进行换行判断，如果包含"..."，就默认作为当前节最后一个Setting的附加值，手动加上换行符"\r\n"。所以核心的代码其实很简单，主要是你要搞清楚流程，要加在哪里：

//这里扩展核心的换行支持，使用 3个 ... 开头，说明是上一个设置的换行
//每一次行都读取下一行试一下，如果有...，就添加
if(line.StartsWith("..."))
{
    var text = "\r\n" + line.Substring(3);
    currentSection[currentSection.SettingCount - 1].Value += text;
    continue;
}

　　我们看一个例子，来测试一下换行值的情况，下面是配置文件：

控制台直接读取这个值的代码：

//按文件名称加载配置文件
Configuration config = Configuration.LoadFromFile("example.ini",
                        Encoding.GetEncoding("gb2312"));
Section section = config["General"];
string someString = section["SomeString"].Value;
Console.WriteLine("字符串SomeString值:{0}", someString);

结果如下，已经默认进行换行了：

3.资源

　　现在写博客频繁了，也有大量代码，所以开始使用github，这次就作为我的第一个开源项目代码吧，把我修改后的源码发在上面，大家去下载好了。

另外，我也对SharpConfig进行了翻译，可以便于大家更方便的使用，源码可以去github的地址下载，帮助文档也在里面哦。这里先截个图：

这个帮助文档也是使用：.NET平台开源项目速览(4).NET文档生成工具ADB及使用 文章中的ADB工具来生成的，非常好用。

文档和源码下载地址：https://github.com/asxinyu/Improved_SharpConfig