C#实现读写ini文件，非调用系统方法

项目里用了很多ini配置文件，并且读写非常频繁。

之前一直用的是调用系统的方法

        private readonly string _inipath;
        [DllImport("kernel32", CharSet = CharSet.Auto)]
        private static extern long WritePrivateProfileString(string section, string key, string val, string filePath);

        [DllImport("kernel32", CharSet = CharSet.Auto)]
        private static extern int GetPrivateProfileString(string section, string key, string def, StringBuilder retVal, int size, string filePath);

但最近要改进项目支持维语，发现ini的读写就有问题了

首先是系统的方法不认识维语的文件名

后来花了大把的力气，把文件名改成英文的，结果发现，不能正常读取和写入

无耐只能放弃使用系统的读取方法，在博客园里找到  @幸福★星  https://www.cnblogs.com/xingfustar/archive/2007/09/13/891950.html

这篇博文，就拿来用了，在这里感谢一下@幸福★星

放上去后简单测试发现，效率很低，因为项目里的配置文件多且每个文件的配置项也很多，频繁读取和保存导致系统很卡

就在这个代码上做了一下优化，见正面的代码：

 /*----------------------------------------------------------------
     * http://XingFuStar.cnblogs.com
     *---------------------------------------------------------------*/
  /*----------------------------------------------------------------
     * 
     * 为保证代码的正确性，对INI文件做如下要求：
     * 1、以"；"开头代表注释，注释要另起一行，不要使用非"；"开头的注释
     * 2、如果使用了非"；"开头的注释，该行中不要包括“＝”
     * 3、如果使用了非"；"开头的注释，对INI进行设置生，该行会被删除
     * 
     *---------------------------------------------------------------*/
        public class IniConfig
        {
            private string iniPath = "";
            private bool isConfig;
            private Dictionary<string, List<Property>> propertyList;

            /// <summary>
            /// 构造函数：装载配置文件
            /// </summary>
            /// <param name="iniPath">配置文件的路径</param>
            public IniConfig(string iniPath)
            {
                this.IniPath = iniPath;
            }

            public string IniPath
            {
                set
                {
                    iniPath = value;
                    isConfig = OnIniPataChanged();
                }
            }


            /// <summary>
            /// 读取Ini中的配置
            /// </summary>
            /// <param name="section">节点</param>
            /// <param name="key">键</param>
            /// <returns>读取值</returns>
            public string ReadValue(string section, string key)
            {
                string value = "";
                bool isRead = false;
                try
                {
                    if (propertyList != null && propertyList.ContainsKey(section))
                    {
                        Property item = propertyList[section].FirstOrDefault(p => p.Key == key);
                        if (item != null) return item.Value;
                    }
                }
                catch (Exception ex)
                {
                    Debug.Print(ex.Message);
                }
                return value;
            }

            /// <summary>
            /// 向INI中写入配置
            /// </summary>
            /// <param name="section">节点</param>
            /// <param name="key">键</param>
            /// <param name="value">要写入的新键值</param>
            /// <returns>写入是否成功</returns>
            public void WriteValue(string section, string key, string value)
            {
                bool isWrite = false;
                try
                {
                    if (isConfig)
                    {
                        InitSection(section);
                        Property item = propertyList[section].FirstOrDefault(p => p.Key == key);
                        if (item != null)
                        {
                            item.Value = value;
                        }
                        else
                        {
                            item = new Property(key,value,""); 
                            propertyList[section].Add(item);
                        }
                        StartSaveIni();
                        

                    }
                }
                catch (Exception ex)
                {
                    Debug.Print(ex.Message);
                }
               // return isWrite;
            }

            private long _savingThreads = 0;//是否在执行写入中
            private void StartSaveIni()
            {
                Action action = () =>
                {
                    if (Interlocked.Read(ref _savingThreads) > 1) return;
                    Interlocked.Increment(ref _savingThreads);
                    System.Threading.Thread.Sleep((int)_savingThreads * 500);
                    SaveIni();
                    Interlocked.Decrement(ref _savingThreads);
                };
                action.BeginInvoke(null, null);
            }



            /// <summary>
            /// 移除键值对
            /// </summary>
            /// <param name="section"></param>
            /// <param name="key"></param>
            public void RemoveItem(string section, string key)
            {
                WriteValue(section, key, null);
            }

            /// <summary>
            /// 验证文件是否存在
            /// </summary>
            /// <returns>布尔值</returns>
            public bool IsExistIniFile()
            {
                return File.Exists(iniPath);
            }

            #region 私有方法
            private bool OnIniPataChanged()
            {
                bool isLoad = false;
                try
                {
                    if (File.Exists(iniPath))
                    {
                        isLoad = LoadIni();
                    }
                }
                catch (Exception ex)
                {
                    Debug.Print(ex.Message);
                }
                return isLoad;
            }

            /// <summary>
            /// 从文件中加载INI配置信息到列表
            /// </summary>
            /// <returns>加载是否成功</returns>
            private bool LoadIni()
            {
                bool isLoad = false;
                try
                {
                    propertyList = new Dictionary<string, List<Property>>();
                    using (StreamReader stream = new StreamReader(iniPath, System.Text.Encoding.Unicode))
                    {
                        string section = "";
                        while (stream.Peek() != -1)
                        {
                            string str = stream.ReadLine().Trim();
                            //判断该行是否有数据
                            if (str.Length > 0)
                            {
                                //以“;”开头的行为注释行（硬性规定）
                                if (str.Substring(0, 1) != ";")
                                {
                                    //以“[“开头的行为Section行（硬性规定）
                                    if (str.Substring(0, 1) == "[")
                                    {
                                        //记录当前Section
                                        section = str.Substring(1, str.IndexOf("]") - 1);
                                        InitSection(section);
                                    }
                                    //有“=”的为数据行（硬性规定）
                                    if (str.IndexOf("=") > 0 && !String.IsNullOrEmpty(section))
                                    {
                                        string[] temp = str.Split('=');
                                        //将该数据行的属性添加到列表
                                        InitSection(section);
                                        propertyList[section].Add(new Property(temp[0].Trim(), temp[1].Trim(), ""));
                                    }
                                }
                                else if (!String.IsNullOrEmpty(section))
                                {
                                    //将注释行的属性添加到列表
                                    InitSection(section);
                                    propertyList[section].Add(new Property("", "", str));
                                }
                            }
                            else if (!String.IsNullOrEmpty(section))
                            {
                                InitSection(section);
                                //为保证格式与加载前相同，因些将空行也加入了列表
                                propertyList[section].Add(new Property("", "", ""));
                            }
                        }
                        stream.Close();
                    }
                    isLoad = true;
                }
                catch (Exception ex)
                {
                    Debug.Print(ex.Message);
                }
                return isLoad;
            }

            private void InitSection(string section)
            {
                if(propertyList == null)propertyList = new Dictionary<string, List<Property>>();
                if(!propertyList.ContainsKey(section))
                    propertyList.Add(section,new List<Property>());
            }

            /// <summary>
            /// 将列表中的配置信息保存到INI文件
            /// </summary>
            /// <returns>保存是否成功</returns>
            private bool  SaveIni()
            {
                bool isSave = false;
                try
                {
                    using (StreamWriter stream = new StreamWriter(iniPath, false, System.Text.Encoding.Unicode))
                    {
                        foreach (var section in propertyList)
                        {
                            stream.WriteLine("[" + section.Key + "]");

                            List<Property> items = section.Value;
                            foreach (var item in items)
                            {
                                if(item.NeedDelete)continue;
                                //写入注释
                                if (item.Description != "")
                                {
                                    stream.WriteLine(item.Description);
                                }
                                //写入键和键值
                                if (item.Key != "")
                                {
                                    stream.WriteLine(item.Key + " = " + item.Value);
                                }
                                //写入空行
                                if (item.Key == "" && item.Description == "" && item.Value == "")
                                {
                                    stream.WriteLine("");
                                }
                            }
                        }
                        stream.Close();
                    }
                   
                   
                    isSave = true;
                }
                catch (Exception ex)
                {
                    Debug.Print(ex.Message);
                }
                return isSave;
            }

            /// <summary>
            /// 内部类：Ini属性
            /// </summary>
            private class Property
            {
                /// <summary>
                /// 构造函数
                /// </summary>
                /// <param name="key"></param>
                /// <param name="value"></param>
                /// <param name="description"></param>
                public Property(string key, string value, string description)
                {
                    this.Key = key;
                    this.Value = value;
                    this.Description = description;
                }
                string key = "";
                /// <summary>
                /// 键
                /// </summary>
                public string Key
                {
                    get { return key; }
                    set { key = value; }
                }
                string value = "";
                /// <summary>
                /// 键值
                /// </summary>
                public string Value
                {
                    get { return this.value; }
                    set { this.value = value; }
                }
                string description = "";
                /// <summary>
                /// 注释
                /// </summary>
                public string Description
                {
                    get { return description; }
                    set { description = value; }
                }

                public bool NeedDelete { get; set; }

            
            }
            #endregion
        }

改进的地方有以下几点：

1.查询由ArrayList+循环改成用Dictionary + List 然后用Linq查询配置项

2.保存加了异步和延时保存

可能存在的问题：

1.因为保加了延时，不知道会不会出现丢失的可能

2.为了支持维语ini文件改成了unicode编码，对于系统默认的ANSI编码支持没有测试过

总结项目中使用ini的配置不能搞的太复杂，太复杂的不能放在ini里做，还是要想别的办法。