C# 操作 INI配置文件

介紹

.ini 文件是Initialization File的縮寫，即初始化文件， 是windows的系統配置文件所採用的存儲格式，
統管windows的各項配置，一般用戶就用windows提供的各項圖形化管理界面就可實現相同的配置了。

.Net框架下的類庫是基於託管代碼的，而API函數是基於非託管代碼的，
運行庫的控制下執行的代碼稱作託管代碼。相反，在運行庫之外運行的代碼稱作非託管代碼。
.NET 的公共類庫 沒有直接操作Ini文件的類，
所以我們使用 System.Runtime.InteropServices 下的 [DllImport(“kernel32.dll”)]
將我們要用的 kernel32.dll 引入。

第一部分： Api

using System.Runtime.InteropServices;
using System.Text;

namespace XHelper.IniFile
{
    public class IniApi
    {
        /// <summary>
        /// 讀取 (int 類型)
        /// </summary>
        /// <param name="section"></param>
        /// <param name="key"></param>
        /// <param name="noText"></param>
        /// <param name="filePath"></param>
        /// <returns></returns>
        [DllImport("kernel32.dll")]
        protected static extern int GetPrivateProfileInt(string section, string key, int noText, string filePath);

        /// <summary>
        /// 讀取 (string 類型)
        /// </summary>
        /// <param name="section">欲在其中查找條目的小節名稱。這個字串不區分大小寫。如設爲null，就在returnString緩衝區內裝載這個ini文件所有小節的列表</param>
        /// <param name="key">欲獲取的項名或條目名。這個字串不區分大小寫。如設爲null，就在returnString緩衝區內裝載指定小節所有項的列表</param>
        /// <param name="noText">指定的條目沒有找到時返回的默認值。可設爲空（""）</param>
        /// <param name="returnString">指定一個字串緩衝區，長度至少爲Size</param>
        /// <param name="size">指定裝載到returnString緩衝區的最大字符數量</param>
        /// <param name="filePath">初始化文件的名字。如沒有指定一個完整路徑名，windows就在Windows目錄中查找文件</param>
        /// 注意：如lpKeyName參數爲null，那麼returnString緩衝區會載入指定小節所有設置項的一個列表。
        /// 每個項都用一個NULL字符分隔，最後一個項用兩個NULL字符中止。也請參考GetPrivateProfileInt函數的註解
        /// <returns></returns>
        [DllImport("kernel32")]
        protected static extern long GetPrivateProfileString(string section, string key, string noText, StringBuilder returnString, int size, string filePath);

        /// <summary>
        /// 讀取 (byte[] 類型)
        /// </summary>
        /// <param name="section"></param>
        /// <param name="key"></param>
        /// <param name="vDefault"></param>
        /// <param name="returnBytes"></param>
        /// <param name="size"></param>
        /// <param name="filePath"></param>
        /// <returns></returns>
        [DllImport("kernel32")]
        protected static extern uint GetPrivateProfileString(string section, string key, string noText, byte[] returnBytes, int size, string filePath);

        /// <summary>
        /// 寫入
        /// </summary>
        /// <param name="section">要在其中寫入新字串的小節名稱。這個字串不區分大小寫</param>
        /// <param name="key">要設置的項名或條目名。這個字串不區分大小寫。用null可刪除這個小節的所有設置項</param>
        /// <param name="lpString">指定爲這個項寫入的字串值。用null表示刪除這個項現有的字串</param>
        /// <param name="filePath">初始化文件的名字。如果沒有指定完整路徑名，則windows會在windows目錄查找文件。如果文件沒有找到，則函數會創建它</param>
        /// <returns></returns>
        [DllImport("kernel32")]
        protected static extern long WritePrivateProfileString(string section, string key, string val, string filePath);
    }
}

第二部分：ini 操作幫助類

using System;
using System.Collections.Generic;
using System.IO;
using System.Text;

namespace XHelper.IniFile
{
    /// <summary>
    /// ini文件類
    /// </summary>
    public class IniFileHelper : IniApi
    {
        /// <summary>
        /// 文件路徑
        /// </summary>
        public string FilePath { get; set; }

        /// <summary>
        /// 構造函數
        /// </summary>
        /// <param name="filePath">Ini文件路徑</param>
        public IniFileHelper(string filePath)
        {
            this.FilePath = filePath;
        }

        #region 讀

        /// <summary>
        /// 讀Int數值
        /// </summary>
        /// <param name="sectionName">節</param>
        /// <param name="keyName">鍵</param>
        /// <param name="noVal">默認值</param>
        /// <returns></returns>
        public int ReadInt(string sectionName, string keyName, int noVal = 0)
        {
            return GetPrivateProfileInt(sectionName, keyName, noVal, this.FilePath);
        }

        /// <summary>
        /// 讀取String值
        /// </summary>
        /// <param name="sectionName"></param>
        /// <param name="keyName"></param>
        /// <param name="noText">如果沒有查到則返回該值</param>
        /// <returns></returns>
        public string ReadString(string sectionName, string keyName, string noText = "")
        {
            return ReadString(sectionName, keyName, noText, FilePath);
        }

        /// <summary>
        /// 讀取String值
        /// </summary>
        /// <param name="sectionName"></param>
        /// <param name="keyName"></param>
        /// <param name="filePath">文件路徑</param>
        /// <param name="noText">如果沒有查到則返回該值</param>
        /// <returns></returns>
        public static string ReadString(string sectionName, string keyName, string filePath, string noText = "")
        {
            if (File.Exists(filePath))
            {
                StringBuilder sBuilder = new StringBuilder(1024);
                GetPrivateProfileString(sectionName, keyName, noText, sBuilder, 1024, filePath);
                return sBuilder.ToString();
            }
            else
            {
                return String.Empty;
            }
        }

        /// <summary>
        /// 讀取所有Section
        /// </summary>
        /// <returns></returns>
        public List<string> ReadAllSectionNames()
        {
            return ReadAllSectionNames(this.FilePath);
        }

        /// <summary>
        /// 讀取 文件的所有 SectionName
        /// </summary>
        /// <param name="filePath">文件路徑</param>
        /// <returns>字符串集合</returns>
        public static List<string> ReadAllSectionNames(string filePath)
        {
            List<string> result = new List<string>();
            Byte[] bytes = new Byte[65536];
            uint len = GetPrivateProfileString(null, null, null, bytes, bytes.Length, filePath);
            int j = 0;
            for (int i = 0; i < len; i++)
                if (bytes[i] == 0)
                {
                    result.Add(Encoding.Default.GetString(bytes, j, i - j));
                    j = i + 1;
                }
            return result;
        }

        /// <summary>
        /// 讀取 SectionName 下 所有的keys
        /// </summary>
        /// <param name="sectionName"></param>
        /// <returns></returns>
        public List<string> ReadKeys(String sectionName)
        {
            return ReadKeys(sectionName, FilePath);
        }

        /// <summary>
        /// 讀取 SectionName 下 所有的keys
        /// </summary>
        /// <param name="sectionName"></param>
        /// <param name="filePath"></param>
        /// <returns></returns>
        public static List<string> ReadKeys(string sectionName, string filePath)
        {
            List<string> result = new List<string>();
            Byte[] bytes = new Byte[65536];
            uint len = GetPrivateProfileString(sectionName, null, null, bytes, bytes.Length, filePath);
            int j = 0;
            for (int i = 0; i < len; i++)
                if (bytes[i] == 0)
                {
                    result.Add(Encoding.Default.GetString(bytes, j, i - j));
                    j = i + 1;
                }
            return result;
        }

        /// <summary>
        /// 獲取所有的 section和 key
        /// </summary>
        /// <returns></returns>
        public Dictionary<string, Dictionary<string, string>> ReadAllSectionAndKeys()
        {
            return ReadAllSectionAndKeys(FilePath);
        }

        /// <summary>
        /// 獲取所有的 section和 key
        /// </summary>
        /// <param name="filePath"></param>
        /// <returns></returns>
        public static Dictionary<string, Dictionary<string, string>> ReadAllSectionAndKeys(string filePath)
        {
            var resDictionary = new Dictionary<string, Dictionary<string, string>>();

            List<string> allSectionList = ReadAllSectionNames(filePath);

            foreach (var item in allSectionList)
            {
                List<string> allKeyList = ReadKeys(item, filePath);
                Dictionary<string, string> dataDictionary = new Dictionary<string, string>();
                foreach (var child in allKeyList)
                {
                    string sVal = ReadString(item, child, filePath);
                    dataDictionary.Add(child, sVal);
                }

                resDictionary.Add(item, dataDictionary);
            }

            return resDictionary;
        }

        #endregion 讀

        #region 寫

        /// <summary>
        /// 新增/修改  (如果存在則修改,否則添加,沒有文件會創建)
        /// </summary>
        /// <param name="sectionName"></param>
        /// <param name="keyName"></param>
        /// <param name="sVal"></param>
        /// <returns></returns>
        public bool WriteString(string sectionName, string keyName, string sVal)
        {
            return WriteString(sectionName, keyName, sVal, FilePath);
        }

        /// <summary>
        ///  新增/修改  (如果存在則修改,否則添加,沒有文件會創建)
        /// </summary>
        /// <param name="sectionName"></param>
        /// <param name="keyName"></param>
        /// <param name="sVal"></param>
        /// <param name="filePath">文件地址</param>
        /// <returns></returns>
        public static bool WriteString(string sectionName, string keyName, string sVal, string filePath)
        {
            long res = WritePrivateProfileString(sectionName, keyName, sVal, filePath);
            if (res == 0)
            {
                return false;
            }
            else
            {
                return true;
            }
        }

        #endregion 寫

        #region 刪除Section

        /// <summary>
        /// 刪除指定的 節
        /// </summary>
        /// <param name="sectionName"></param>
        public void DeleteSection(string sectionName)
        {
            WritePrivateProfileString(sectionName, null, null, this.FilePath);
        }

        /// <summary>
        /// 刪除全部 節
        /// </summary>
        public void DeleteAllSection()
        {
            WritePrivateProfileString(null, null, null, this.FilePath);
        }

        #endregion 刪除Section
    }
}

第三部分：ini Dictionary 幫助類

using System;
using System.Collections.Generic;
using System.Configuration;
using XHelper.IniFile;

namespace XHelper.IniDictionary
{
    public class IniDictionaryHelper
    {
        #region 靜態默認節點 (config 中 配置)

        private static string _defaultIniFilePath = ConfigurationManager.AppSettings["DefaultIniFilePath"];
        private static string _defaultSectionName = ConfigurationManager.AppSettings["DefaultSectionName"];
        private static Dictionary<string, string> _defaultDictionary = new Dictionary<string, string>();

        /// <summary>
        /// 靜態構造
        /// </summary>
        static IniDictionaryHelper()
        {
            //獲取所有的 section和 key
            var defaultDataDictionary = IniFileHelper.ReadAllSectionAndKeys(_defaultIniFilePath);

            if (defaultDataDictionary.ContainsKey(_defaultSectionName))
            {
                //取出默認Section
                _defaultDictionary = defaultDataDictionary[_defaultSectionName];
            }
            else
            {
                throw new Exception("沒有找到默認Section");
            }
        }

        /// <summary>
        /// 獲取key的值
        /// </summary>
        /// <param name="keyName"></param>
        /// <returns></returns>
        public static string Get(string keyName)
        {
            if (_defaultDictionary.ContainsKey(keyName))
            {
                return _defaultDictionary[keyName];
            }

            return string.Empty;
        }

        #endregion 靜態默認節點 (config 中 配置)

        #region 自定義讀取

        /// <summary>
        /// 容器
        /// </summary>
        private Dictionary<string, Dictionary<string, string>> _dataDictionary = new Dictionary<string, Dictionary<string, string>>();

        public IniDictionaryHelper(string filePath)
        {
            // 獲取所有的 section和 key
            this._dataDictionary = IniFileHelper.ReadAllSectionAndKeys(filePath);
        }

        /// <summary>
        /// 獲取key的值
        /// </summary>
        /// <param name="sectionName"></param>
        /// <param name="keyName"></param>
        /// <returns></returns>
        public string Get(string sectionName, string keyName)
        {
            if (_dataDictionary.ContainsKey(sectionName))
            {
                var item = _dataDictionary[sectionName];
                if (item.ContainsKey(keyName))
                {
                    return item[keyName];
                }
            }

            return string.Empty;
        }

        #endregion 自定義讀取
    }
}

第四部分： config 中配置地址與SectionName

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <startup>
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2" />
  </startup>
  <appSettings>
    <add key="DefaultIniFilePath" value="E:\Work\VSRepos\IniTest\ConsoleApp2\bin\Debug\ttt.ini" />
    <add key="DefaultSectionName" value="Settings" />
  </appSettings>
</configuration>

第五部分： 調用

using System;
using System.Configuration;
using XHelper.IniDictionary;

namespace ConsoleApp2
{
    internal class Program
    {
        private static void Main(string[] args)
        {
            //1. 讀取默認的配置
            var defaultRead = IniDictionaryHelper.Get("UiThreadCount");

            //2. 自定義讀取
            IniDictionaryHelper iniDictionary = new IniDictionaryHelper(ConfigurationManager.AppSettings["DefaultIniFilePath"]);

            var read = iniDictionary.Get("fpstips", "Tip");

            Console.ReadLine();
        }
    }
}

第五部分：ini 示例文件

[Settings]
CarSwoosh=0
ThreadCount=0
VolumeBack=0
VolumeEffect=0
UiThreadCount=1
LastPortIndex=0

[Loader]
UpLineRed=255
UpLineGreen=255
UpLineBlue=255
RatioRed=255
RatioGreen=255
RatioBlue=0
DownLineRed=255
DownLineGreen=255
DownLineBlue=0

[fpstips]
TipFps =15
Tip =如果您覺得遊戲運行效率過低, 嘗試調低分辨率(按F8)、切換到全屏遊戲(按F7)、關閉動態模糊(在遊戲設置中關閉)或者關閉一些其他應用程序, 都可以提高遊戲運行速度。


[app]
cmd=QQSpeed_loader.exe
arg=
Product=QQSpeed
home=http://www.qq.com
tqos=ied-tqos-min.qq.com
WindowClass=GameApp

[options]
packonstart=0

[LoverDanceCfg]
LoverDanceLowFrameLevelRate=40
LoverDanceLowFrameNeedCount=100
[vipflagchange]
ChangeTips=                  
TipShowFlag=0

[wonderlandFetionSet]
recieveFetionOnFace=1