作者: 魔法軟糖
日期: 2020-02-27
引言
*************************************
.ini 檔案是Initialization File的縮寫，即組態檔 ，是windows的系統組態檔所采用的存盤格式，
它具有方便易用的特點，和注冊表的鍵值有著類似的功能，各類應用程式也經常使用INI保存各種配置和選項，
在簡單只需要讀取的場合，呼叫WINDOWS API就行，但在復雜的需要可視化編輯時，就需要建立自己的處理類了，
如何實作自己的INI類
首先我們需要了解
◇ INI的格式
◇ 典型INI檔案
;專案注釋
[.ShellClassInfo]
InfoTip=有圖示的檔案夾
;圖示資源
IconResource="C:\Windows\system32\SHELL32.dll",4
#檔案夾視圖
[ViewState]
Mode=
Vid=
FolderType=General
#尾部注釋
一個典型INI檔案由節、注釋和節下面的項組成，而項為鍵=值的形式，
INI檔案的注釋符號有兩種，規范為;分號，實際有些地方用#井號，
◇ 保留注釋
為了在修改INI檔案時不丟失任何資訊，所以需要保存INI檔案中所有有效元素、包括注釋甚至是無效行，
為了實作這個目的，將所有注釋和無效行都歸屬于它之后的有效元素，
以上面的desktop.ini為例，
- 第一行 ;專案注釋歸屬于[.ShellClassInfo]節
- 第四行;圖示資源歸屬于IconResource=項
- #檔案夾視圖歸屬于[ViewState]節
- 最后的#尾部注釋歸屬于整個INI檔案的EndText
◇ INIItem類
表示INI檔案中節點下面的項，它擁有三個屬性：名稱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 =https://www.cnblogs.com/createwell/p/ vValue; 14 Comment = vComment; 15 } 16 /// <summary> 17 /// 項名稱，例如 Color = 202,104,0 中的 Color 18 /// </summary> 19 public string Name { get; set; } 20 /// <summary> 21 /// 值內容，例如 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檔案中的一個節點，它擁有項串列List{Of INIItem}、名稱Name和注釋Comment，
1 /// <summary> 2 /// 表示INI檔案的一個節點，它擁有一個專案串列，還擁有名稱和注釋 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 /// 節點名稱，例如 [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 /// 向本節點添加新項， 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的文本形式，〈<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檔案的全部內,擁有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>注釋的標準符號</summary> 13 public static string U注釋 = ";"; 14 /// <summary>注釋的標準符號2</summary> 15 public static string U注釋2 = "#"; 16 /// <summary>節左括號的標準符號</summary> 17 public static string U左括號 = "["; 18 /// <summary>節右括號的標準符號</summary> 19 public static string U右括號 = "]"; 20 /// <summary>連接項和值的標準符號</summary> 21 public static string U等號 = "="; 22 /// <summary>讀取或寫入時忽略無意義的備注行(不包括注釋)，</summary> 23 public static bool 忽略備注 = false; 24 /// <summary>讀取的上個檔案的有效行數(不包括注釋)，</summary> 25 public static int 上次讀取的有效行數 = 0; 26 #endregion 27 28 /// <summary> 29 /// 所有節點 30 /// <para>每個節點含有項、值和注釋，當項名稱為空字串時，整條陳述句視為注釋</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檔案添加新節點， 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檔案轉化為文本格式，會生成整個檔案， 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檔案
讀取通常比寫入復雜，軟糖的代碼也是逐行檢查，多次除錯才完成，
流程如下：
- 首先定義一些區域變數來記錄當前分析的節、項、已經累積的備注、是否為有效行，
- 逐行讀取，首先判斷是否開頭為;或#，如果是，添加到備注，加回車符，設為有效行，
- 判斷開頭是否為[，如果是則作為節來讀取，進一步分析，如果[A]這種形式，設定當前節，設為有效行，如果[B缺少反括號，進行下一步流程，尚無法判斷是[B=K這種項還是純粹無意義的無效行，
- 判斷是否含有=，如果是則作為項來讀取
- 如果未標記為有效行，通通加入備注，
- 如果讀完全文，備注不為空，則加入到INI.EndText中作為結尾注釋，
代碼
#region "讀取檔案" /// <summary> /// 從指定路徑和字符編碼的檔案中讀取檔案內容，以此生成本檔案， /// </summary> /// <param name="路徑">完整的路徑字串</param> /// <param name="encoding">編碼格式：默認自動識別，（對于無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 回傳結果 = 讀取檔案(new StringReader(SR.ReadToEnd())); SR.Close(); return 回傳結果; } } catch (Exception) { return false; } } /// <summary> /// 從 <see cref="StringReader"/> 中讀取檔案內容，以此生成本檔案， /// </summary> /// <param name="MyStringReader">StringReader，可以由string或StreamReader.ReadToEnd()來生成，</param> /// <returns>〈bool〉回傳是否讀取成功，</returns> public bool 讀取檔案(StringReader MyStringReader) { /// <summary>正在分析的節</summary> ININode 當前節 = null; /// <summary>正在分析的項</summary> INIItem 當前項 = null; /// <summary>正在分析的節名</summary> string 當前節名 = null; /// <summary>正在分析的項名</summary> string 當前項名 = null; /// <summary>累計讀取的屬性行的計數</summary> int 計數 = 0; /// <summary>該行是合法有效的行，還是無法識別的行，(無法識別作為備注處理)</summary> bool 有效行 = false; /// <summary>該行去掉空格和Tab符的文本長度</summary> int 有效文本長度; /// <summary>每個物體前的注釋</summary> string 備注 = ""; // * 回圈讀取每行內容 * while (true) { string 行文本 = MyStringReader.ReadLine(); if (行文本 == null) { if (備注.Length > 0) { EndText = 備注; } 上次讀取的有效行數 = 計數; 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節首[ if (行[0] == U左括號[0]) { int 右括號位置 = 行.IndexOf(U右括號[0], 2); if (右括號位置 > 1) { 當前節名 = 行.Substring(1, 右括號位置 - 1); 當前節 = New(當前節名, 備注); 備注 = ""; 計數 += 1; 有效行 = true; } } //項定義====含有等號的行 // -> 獲取賦值符號位置 int 賦值符位置 = 行.IndexOf(U等號, 2); if (賦值符位置 > 1) { // -> 獲得名稱和值，并新建項 當前項名 = 行.Substring(0, 賦值符位置).Trim(' ', '\t'); string 值 = 行.Substring(賦值符位置 + 1, 行.Length - 賦值符位置 - 1).Trim(' ', '\t'); if (當前節 != null) { 當前項 = 當前節.New(當前項名, 值, 備注); 備注 = ""; 計數 += 1; 有效行 = true; } } } // * 無效行作為備注處理 * if (有效行 == false) { if (忽略備注 == false) { if (行文本.Length == 0) { 備注 += "\r\n"; } else { 備注 += 行文本 + "\r\n"; } } } } } return true; } #endregion
◇ 編碼問題
1 /// <summary> 2 /// 通過檔案的頭部開始的兩個位元組來區分一個檔案屬于哪種編碼， 3 /// 如果檔案長度不足2位元組，則回傳null 4 /// 當FF FE時，是Unicode； 5 /// 當FE FF時，是BigEndianUnicode； 6 /// 當EF BB時，是UTF-8； 7 /// 當它不為這些時，則是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檔案內容顯示到ListView來展現效果，
給每個節點添加一個Group組，將節點本身和下轄的項都放進組，
當滑鼠選中某項時，判斷該item的Key和Group即可知道它屬于哪個節點，名稱是什么，
1 public class INIListView { 2 public ListView 視圖; 3 public Color 節顏色 = Color.FromArgb(0, 153, 153); 4 public Color 節底色 = Color.FromArgb(255, 255, 255); 5 public void 系結控制元件(ListView ListView) { 6 視圖 = ListView; 7 初始化(); 8 } 9 public void 載入資料(INI ini) { 10 初始化組(ini); 11 初始化資料(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 初始化資料(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 = 節顏色; 44 nodeitem.BackColor = 節底色; 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 =https://www.cnblogs.com/createwell/p/ 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(資料視圖)和OpenFileDialog(openINIFileDialog)、和Button(按鈕_讀取檔案)
1 public partial class 編輯表單 : Form { 2 INIListView INIListView = new INIListView(); 3 INI 當前檔案; 4 5 6 public 編輯表單() { 7 InitializeComponent(); 8 } 9 10 private void 編輯表單_Load(object sender, EventArgs e) { 11 Width = 1280; 12 Height = 720; 13 初始化資料視圖(); 14 openINIFileDialog.InitialDirectory = Environment.CurrentDirectory; 15 } 16 private void 初始化資料視圖() { 17 INIListView.系結控制元件(資料視圖); 18 } 19 20 private void 按鈕_讀取檔案_Click(object sender, EventArgs e) { 21 var result = openINIFileDialog.ShowDialog(); 22 if (result == DialogResult.OK) { 23 當前檔案 = new INI(); 24 var 讀取結果 = 當前檔案.讀取檔案(openINIFileDialog.FileName); 25 INIListView.載入資料(當前檔案); 26 } 27 28 29 } 30 31 private void 視圖_1_Click(object sender, EventArgs e) { 32 資料視圖.View = View.Details; 33 } 34 35 private void 視圖_2_Click(object sender, EventArgs e) { 36 資料視圖.View = View.Tile; 37 } 38 39 private void 視圖_3_Click(object sender, EventArgs e) { 40 資料視圖.View = View.List; 41 } 42 43 private void 視圖_4_Click(object sender, EventArgs e) { 44 資料視圖.View = View.SmallIcon; 45 } 46 47 private void 視圖_5_Click(object sender, EventArgs e) { 48 資料視圖.View = View.LargeIcon; 49 } 50 }
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
結語：本文實作了INI檔案的構造、讀取和寫入，
實際上通過擴展可以實作更強大的資料格式，
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/67556.html
標籤：其他