作者: 魔法软糖
日期: 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 = 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 = 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文件的构造、读取和写入。
实际上通过扩展可以实现更强大的数据格式。