|
作者: 魔法軟糖 日期: 2020-02-27 引言 ************************************* .ini 文件是Initialization File的縮寫，即配置文件 。是windows的系統(tǒng)配置文件所采用的存儲格式。 它具有方便易用的特點，和注冊表的鍵值有著類似的功能，各類應(yīng)用程序也經(jīng)常使用INI保存各種配置和選項。 在簡單只需要讀取的場合，調(diào)用WINDOWS API就行，但在復(fù)雜的需要可視化編輯時，就需要建立自己的處理類了。
如何實現(xiàn)自己的INI類 首先我們需要了解 ◇ INI的格式
◇ 典型INI文件 ;項目注釋 一個典型INI文件由節(jié)、注釋和節(jié)下面的項組成，而項為鍵=值的形式。 INI文件的注釋符號有兩種，規(guī)范為;分號，實際有些地方用#井號。 ◇ 保留注釋 為了在修改INI文件時不丟失任何信息，所以需要保存INI文件中所有有效元素、包括注釋甚至是無效行。 為了實現(xiàn)這個目的，將所有注釋和無效行都?xì)w屬于它之后的有效元素。 以上面的desktop.ini為例，
◇ INIItem類 表示INI文件中節(jié)點下面的項，它擁有三個屬性：名稱Name、值Value和注釋Comment 1 /// <summary> 2 /// 擁有名稱、值和注釋 3 /// </summary> 4 public class INIItem { 5 /// <summary> 6 /// 實例化INIItem。指定名稱、值和注釋。 7 /// </summary> 8 /// <param name="vName"></param> 9 /// <param name="vValue"></param> 10 /// <param name="vComment"></param> 11 public INIItem(string vName, string vValue, string vComment = "") { 12 Name = vName; 13 Value = vValue; 14 Comment = vComment; 15 } 16 /// <summary> 17 /// 項名稱。例如 Color = 202,104,0 中的 Color 18 /// </summary> 19 public string Name { get; set; } 20 /// <summary> 21 /// 值內(nèi)容。例如 Color = 202,104,0 中的 202,104,0 22 /// </summary> 23 public string Value { get; set; } 24 /// <summary> 25 /// 位于前面的所有注釋行。一般以 ; 開頭 26 /// </summary> 27 public string Comment { get; set; } 28 /// <summary> 29 /// 返回 INIItem 的文本形式。〈<see cref="string"/>〉 30 /// <para>Name=Value</para> 31 /// </summary> 32 /// <returns>〈string〉返回 INIItem 的文本形式。</returns> 33 public override string ToString() { 34 return Name + INI.U等號 + Value; 35 } 36 } ◇ ININode類 表示INI文件中的一個節(jié)點，它擁有項列表List{Of INIItem}、名稱Name和注釋Comment。 1 /// <summary> 2 /// 表示INI文件的一個節(jié)點，它擁有一個項目列表，還擁有名稱和注釋 3 /// <para></para> 4 /// </summary> 5 public class ININode { 6 /// <summary> 7 /// 實例化ININode。指定初始的名稱和注釋。 8 /// </summary> 9 /// <param name="vName"></param> 10 /// <param name="vComment"></param> 11 public ININode(string vName, string vComment) { Name = vName; Comment = vComment; Items = new List<INIItem>(); } 12 /// <summary> 13 /// 節(jié)點名稱。例如 [Config] 14 /// </summary> 15 public string Name { get; set; } 16 /// <summary> 17 /// 位于前面的所有注釋行。一般以 ; 開頭 18 /// </summary> 19 public string Comment { get; set; } 20 /// <summary> 21 /// 含有的項列表 22 /// </summary> 23 public List<INIItem> Items { get; set; } 24 /// <summary> 25 /// 向本節(jié)點添加新項。 26 /// </summary> 27 /// <param name="vName"></param> 28 /// <param name="vValue"></param> 29 /// <param name="vComment"></param> 30 /// <returns></returns> 31 public INIItem New(string vName, string vValue, string vComment = "") { 32 var k = new INIItem(vName, vValue, vComment); 33 Items.Add(k); 34 return k; 35 } 36 /// <summary> 37 /// 返回 ININode的文本形式?！?/span><see cref="string"/>〉 38 /// <para>[Name]</para> 39 /// </summary> 40 /// <returns>〈string〉返回 ININode 的文本形式。</returns> 41 public override string ToString() { 42 return INI.U左括號 + Name + INI.U右括號; 43 } 44 } ◇ INI類 它表示整個INI文件的全部內(nèi),擁有List{Of ININode}、EndText、FileName、StartLine等屬性 1 /// <summary> 2 /// 表示INI文件。擁有讀取和寫入文件的方法。 3 /// <para>儲存在 <see cref="List{ININode}"/><<see cref="ININode"/>></para> 4 /// </summary> 5 public class INI { 6 /// <summary> 7 /// 實例化INI文件。 8 /// </summary> 9 public INI() { } 10 11 #region "↓全局常量" 12 /// <summary>注釋的標(biāo)準(zhǔn)符號</summary> 13 public static string U注釋 = ";"; 14 /// <summary>注釋的標(biāo)準(zhǔn)符號2</summary> 15 public static string U注釋2 = "#"; 16 /// <summary>節(jié)左括號的標(biāo)準(zhǔn)符號</summary> 17 public static string U左括號 = "["; 18 /// <summary>節(jié)右括號的標(biāo)準(zhǔn)符號</summary> 19 public static string U右括號 = "]"; 20 /// <summary>連接項和值的標(biāo)準(zhǔn)符號</summary> 21 public static string U等號 = "="; 22 /// <summary>讀取或?qū)懭霑r忽略無意義的備注行(不包括注釋)。</summary> 23 public static bool 忽略備注 = false; 24 /// <summary>讀取的上個文件的有效行數(shù)(不包括注釋)。</summary> 25 public static int 上次讀取的有效行數(shù) = 0; 26 #endregion 27 28 /// <summary> 29 /// 所有節(jié)點 30 /// <para>每個節(jié)點含有項、值和注釋，當(dāng)項名稱為空字符串時，整條語句視為注釋</para> 31 /// </summary> 32 public List<ININode> Nodes { get; set; } = new List<ININode>(); 33 /// <summary> 34 /// 附加在INI文件后無意義的文本 35 /// </summary> 36 public string EndText { get; set; } = ""; 37 /// <summary> 38 /// 附加在INI文件第一行的作者信息等文本 39 /// <para>其中的換行符將被替換為兩個空格</para> 40 /// </summary> 41 public string StartLine { get; set; } = ""; 42 /// <summary> 43 /// 讀取INI時獲得的FileName。 44 /// <para>寫入文檔時可以使用這個名字，也可以不使用這個名字。</para> 45 /// </summary> 46 public string FileName { get; set; } = ""; 47 /// <summary> 48 /// 向本INI文件添加新節(jié)點。 49 /// </summary> 50 /// <param name="vName"></param> 51 /// <param name="vComment"></param> 52 /// <returns></returns> 53 public ININode New(string vName, string vComment = "") { 54 var k = new ININode(vName, vComment); 55 Nodes.Add(k); 56 return k; 57 } 58 } 如何寫入INI文件
以下是寫入代碼 1 #region "寫入文件" 2 3 /// <summary>將文檔寫入指定路徑 4 /// </summary> 5 /// <param name="path">指定路徑</param> 6 public bool 寫入文檔(string path, Encoding encoding = null) { 7 try { 8 if (encoding == null) { encoding = Encoding.Default; } 9 using (StreamWriter SW = new StreamWriter(path)) { 10 SW.Write(ToString()); 11 } 12 } catch (Exception) { 13 return false; 14 } 15 return true; 16 } 17 /// <summary> 18 /// 將INI文檔轉(zhuǎn)化為文本格式，會生成整個文檔。 19 /// <para>注意：較大的文檔可能會耗費大量時間</para> 20 /// </summary> 21 /// <returns></returns> 22 public override string ToString() { 23 StringBuilder sb = new StringBuilder(); 24 if (StartLine.Length > 0) { sb.AppendLine(StartLine.Replace("\r\n", " ")); } 25 for (int i = 0; i < Nodes.Count; i++) { 26 var node = Nodes[i]; 27 if (忽略備注 == false) { sb.Append(node.Comment); } 28 sb.AppendLine(node.ToString()); 29 for (int j = 0; j < node.Items.Count; j++) { 30 var item = node.Items[j]; 31 if (忽略備注 == false) { sb.Append(item.Comment); } 32 sb.AppendLine(item.ToString()); 33 } 34 } 35 if (EndText.Length > 0) { sb.AppendLine(EndText); } 36 return sb.ToString(); 37 } 38 39 #endregion
如何讀取INI文件 讀取通常比寫入復(fù)雜。軟糖的代碼也是逐行檢查，多次調(diào)試才完成。 流程如下：
代碼 #region "讀取文件" /// <summary> /// 從指定路徑和字符編碼的文件中讀取文檔內(nèi)容，以此生成本文檔。 /// </summary> /// <param name="路徑">完整的路徑字符串</param> /// <param name="encoding">編碼格式：默認(rèn)自動識別。（對于無bom可能識別錯誤）</param> public bool 讀取文檔(string 路徑, Encoding encoding = null) { if (File.Exists(路徑) == false) { return false; } try { if (encoding == null) { encoding = TXT.GetFileEncodeType(路徑); } using (StreamReader SR = new StreamReader(路徑, encoding)) { bool 返回結(jié)果 = 讀取文檔(new StringReader(SR.ReadToEnd())); SR.Close(); return 返回結(jié)果; } } catch (Exception) { return false; } } /// <summary> /// 從 <see cref="StringReader"/> 中讀取文檔內(nèi)容，以此生成本文檔。 /// </summary> /// <param name="MyStringReader">StringReader，可以由string或StreamReader.ReadToEnd()來生成。</param> /// <returns>〈bool〉返回是否讀取成功。</returns> public bool 讀取文檔(StringReader MyStringReader) { /// <summary>正在分析的節(jié)</summary> ININode 當(dāng)前節(jié) = null; /// <summary>正在分析的項</summary> INIItem 當(dāng)前項 = null; /// <summary>正在分析的節(jié)名</summary> string 當(dāng)前節(jié)名 = null; /// <summary>正在分析的項名</summary> string 當(dāng)前項名 = null; /// <summary>累計讀取的屬性行的計數(shù)</summary> int 計數(shù) = 0; /// <summary>該行是合法有效的行，還是無法識別的行。(無法識別作為備注處理)</summary> bool 有效行 = false; /// <summary>該行去掉空格和Tab符的文本長度</summary> int 有效文本長度; /// <summary>每個實體前的注釋</summary> string 備注 = ""; // * 循環(huán)讀取每行內(nèi)容 * while (true) { string 行文本 = MyStringReader.ReadLine(); if (行文本 == null) { if (備注.Length > 0) { EndText = 備注; } 上次讀取的有效行數(shù) = 計數(shù); break; } else { string 行; 有效行 = false; // * 獲取 去掉空格和Tab符的文本 * 行 = 行文本.Trim(' ', '\t'); // * 獲取 去掉空格和Tab符的文本的長度 * 有效文本長度 = 行.Length; // * 檢測注釋符 * if (行文本.Contains(U注釋)) { int 注釋位置 = 行文本.IndexOf(U注釋); 行 = 行文本.Substring(0, 注釋位置); int 注釋開始位置 = 注釋位置 + U注釋.Length - 1; int 注釋長度 = 行文本.Length - 注釋開始位置; if (注釋長度 > 0) { if (備注.Length > 0) { 備注 += "\r\n"; } 備注 += 行文本.Substring(注釋開始位置, 注釋長度); } 有效行 = true; } if (行文本.Contains(U注釋2)) { int 注釋位置 = 行文本.IndexOf(U注釋2); 行 = 行文本.Substring(0, 注釋位置); int 注釋開始位置 = 注釋位置 + U注釋2.Length - 1; int 注釋長度 = 行文本.Length - 注釋開始位置; if (注釋長度 > 0) { if (備注.Length > 0) { 備注 += "\r\n"; } 備注 += 行文本.Substring(注釋開始位置, 注釋長度); } 有效行 = true; } // * 檢查開頭字符 * if (行.Length >= 2) { //[類型定義]====首字符：U節(jié)首[ if (行[0] == U左括號[0]) { int 右括號位置 = 行.IndexOf(U右括號[0], 2); if (右括號位置 > 1) { 當(dāng)前節(jié)名 = 行.Substring(1, 右括號位置 - 1); 當(dāng)前節(jié) = New(當(dāng)前節(jié)名, 備注); 備注 = ""; 計數(shù) += 1; 有效行 = true; } } //項定義====含有等號的行 // -> 獲取賦值符號位置 int 賦值符位置 = 行.IndexOf(U等號, 2); if (賦值符位置 > 1) { // -> 獲得名稱和值，并新建項 當(dāng)前項名 = 行.Substring(0, 賦值符位置).Trim(' ', '\t'); string 值 = 行.Substring(賦值符位置 + 1, 行.Length - 賦值符位置 - 1).Trim(' ', '\t'); if (當(dāng)前節(jié) != null) { 當(dāng)前項 = 當(dāng)前節(jié).New(當(dāng)前項名, 值, 備注); 備注 = ""; 計數(shù) += 1; 有效行 = true; } } } // * 無效行作為備注處理 * if (有效行 == false) { if (忽略備注 == false) { if (行文本.Length == 0) { 備注 += "\r\n"; } else { 備注 += 行文本 + "\r\n"; } } } } } return true; } #endregion ◇ 編碼問題
1 /// <summary> 2 /// 通過文件的頭部開始的兩個字節(jié)來區(qū)分一個文件屬于哪種編碼。 3 /// 如果文件長度不足2字節(jié)，則返回null 4 /// 當(dāng)FF FE時，是Unicode； 5 /// 當(dāng)FE FF時，是BigEndianUnicode； 6 /// 當(dāng)EF BB時，是UTF-8； 7 /// 當(dāng)它不為這些時，則是ANSI編碼。 8 /// </summary> 9 public static Encoding GetFileEncodeType(string filename) { 10 FileStream fs = new FileStream(filename, FileMode.Open, FileAccess.Read); 11 BinaryReader br = new BinaryReader(fs); 12 Byte[] buffer = br.ReadBytes(2); 13 if (buffer.Length < 2) { return null; } 14 if (buffer[0] >= 0xEF) { 15 if (buffer[0] == 0xEF && buffer[1] == 0xBB) { 16 return Encoding.UTF8; 17 } else if (buffer[0] == 0xFE && buffer[1] == 0xFF) { 18 return Encoding.BigEndianUnicode; 19 } else if (buffer[0] == 0xFF && buffer[1] == 0xFE) { 20 return Encoding.Unicode; 21 } else { 22 return Encoding.Default; 23 } 24 } else { 25 return Encoding.Default; 26 } 27 } 窗體讀取INI演示 ◇ 演示效果 ◇ INIListView類 用一個輔助類將INI文件內(nèi)容顯示到ListView來展現(xiàn)效果。 給每個節(jié)點添加一個Group組，將節(jié)點本身和下轄的項都放進(jìn)組。 當(dāng)鼠標(biāo)選中某項時，判斷該item的Key和Group即可知道它屬于哪個節(jié)點，名稱是什么。 1 public class INIListView { 2 public ListView 視圖; 3 public Color 節(jié)顏色 = Color.FromArgb(0, 153, 153); 4 public Color 節(jié)底色 = Color.FromArgb(255, 255, 255); 5 public void 綁定控件(ListView ListView) { 6 視圖 = ListView; 7 初始化(); 8 } 9 public void 載入數(shù)據(jù)(INI ini) { 10 初始化組(ini); 11 初始化數(shù)據(jù)(ini); 12 } 13 14 private void 初始化() { 15 視圖.View = View.Tile; 16 視圖.ShowGroups = true; 17 初始化列(); 18 } 19 20 private void 初始化列() { 21 視圖.Columns.Clear(); 22 視圖.Columns.Add("A", "名稱", 220); 23 視圖.Columns.Add("B", "值", 300); 24 視圖.Columns.Add("C", "注釋", 440); 25 } 26 private void 初始化組(INI ini) { 27 if (ini == null) { return; } 28 for (int i = 0; i < ini.Nodes.Count; i++) { 29 string nodeName = ini.Nodes[i].Name; 30 int cc = ini.Nodes[i].Items.Count; 31 string nodeTitle = string.Format("{0} ({1})", nodeName, cc); 32 視圖.Groups.Add(nodeName, nodeTitle); 33 } 34 } 35 36 private void 初始化數(shù)據(jù)(INI ini) { 37 視圖.Items.Clear(); 38 39 if (ini == null) { return; } 40 for (int i = 0; i < ini.Nodes.Count; i++) { 41 string nodeName = ini.Nodes[i].Name; 42 var nodeitem = 視圖.Items.Add(nodeName, "["+nodeName+"]",0); 43 nodeitem.ForeColor = 節(jié)顏色; 44 nodeitem.BackColor = 節(jié)底色; 45 46 nodeitem.Group = 視圖.Groups[nodeName]; 47 48 49 for (int j = 0; j < ini.Nodes[i].Items.Count; j++) { 50 var iniitem = ini.Nodes[i].Items[j]; 51 string name = iniitem.Name; 52 string value = iniitem.Value; 53 string comment = iniitem.Comment; 54 var item = 視圖.Items.Add(name, name); 55 item.Group = 視圖.Groups[nodeName]; 56 item.SubItems.Add(value); 57 item.SubItems.Add(comment); 58 } 59 } 60 } 61 62 }
窗體上拖一個ListView(數(shù)據(jù)視圖)和OpenFileDialog(openINIFileDialog)、和Button(按鈕_讀取文件) 1 public partial class 編輯窗體 : Form { 2 INIListView INIListView = new INIListView(); 3 INI 當(dāng)前文檔; 4 5 6 public 編輯窗體() { 7 InitializeComponent(); 8 } 9 10 private void 編輯窗體_Load(object sender, EventArgs e) { 11 Width = 1280; 12 Height = 720; 13 初始化數(shù)據(jù)視圖(); 14 openINIFileDialog.InitialDirectory = Environment.CurrentDirectory; 15 } 16 private void 初始化數(shù)據(jù)視圖() { 17 INIListView.綁定控件(數(shù)據(jù)視圖); 18 } 19 20 private void 按鈕_讀取文件_Click(object sender, EventArgs e) { 21 var result = openINIFileDialog.ShowDialog(); 22 if (result == DialogResult.OK) { 23 當(dāng)前文檔 = new INI(); 24 var 讀取結(jié)果 = 當(dāng)前文檔.讀取文檔(openINIFileDialog.FileName); 25 INIListView.載入數(shù)據(jù)(當(dāng)前文檔); 26 } 27 28 29 } 30 31 private void 視圖_1_Click(object sender, EventArgs e) { 32 數(shù)據(jù)視圖.View = View.Details; 33 } 34 35 private void 視圖_2_Click(object sender, EventArgs e) { 36 數(shù)據(jù)視圖.View = View.Tile; 37 } 38 39 private void 視圖_3_Click(object sender, EventArgs e) { 40 數(shù)據(jù)視圖.View = View.List; 41 } 42 43 private void 視圖_4_Click(object sender, EventArgs e) { 44 數(shù)據(jù)視圖.View = View.SmallIcon; 45 } 46 47 private void 視圖_5_Click(object sender, EventArgs e) { 48 數(shù)據(jù)視圖.View = View.LargeIcon; 49 } 50 }
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- 結(jié)語：本文實現(xiàn)了INI文件的構(gòu)造、讀取和寫入。 實際上通過擴(kuò)展可以實現(xiàn)更強大的數(shù)據(jù)格式。 |
|
|
