C#怎么读写自定义的Config文件

在C#开发中，配置文件（Config文件）是存储应用程序设置和参数的重要工具。虽然.NET框架提供了app.config和web.config等标准配置文件，但在某些情况下，开发者可能需要使用自定义的Config文件来存储特定的配置信息。本文将详细介绍如何在C#中读写自定义的Config文件。

1. 自定义Config文件的基本概念

自定义Config文件是指开发者根据项目需求自行定义的配置文件，通常以XML、JSON、INI等格式存储。与标准的app.config或web.config不同，自定义Config文件的结构和内容完全由开发者决定。

1.1 为什么需要自定义Config文件？

• 灵活性：自定义Config文件允许开发者根据项目需求自由定义配置项，而不受标准配置文件的限制。
• 可维护性：将配置信息集中在一个文件中，便于管理和维护。
• 安全性：某些敏感信息（如数据库连接字符串）可以存储在自定义Config文件中，并通过加密等方式保护。

1.2 常见的自定义Config文件格式

• XML：结构清晰，易于解析，适合存储复杂的配置信息。
• JSON：轻量级，易于阅读和编写，适合存储简单的配置信息。
• INI：简单易用，适合存储键值对形式的配置信息。

2. 使用XML格式的自定义Config文件

XML是一种常用的配置文件格式，具有良好的可读性和扩展性。下面我们将介绍如何在C#中读写XML格式的自定义Config文件。

2.1 创建XML格式的自定义Config文件

首先，创建一个XML格式的自定义Config文件，例如customConfig.xml，内容如下：

<configuration>
  <appSettings>
    <add key="Server" value="localhost" />
    <add key="Database" value="MyDatabase" />
    <add key="User" value="admin" />
    <add key="Password" value="123456" />
  </appSettings>
</configuration>

2.2 读取XML格式的自定义Config文件

在C#中，可以使用System.Xml命名空间中的类来读取XML文件。以下是一个读取customConfig.xml文件的示例代码：

using System;
using System.Xml;

class Program
{
    static void Main()
    {
        // 加载XML文件
        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.Load("customConfig.xml");

        // 获取appSettings节点
        XmlNodeList appSettingsNodes = xmlDoc.SelectNodes("/configuration/appSettings/add");

        // 遍历appSettings节点
        foreach (XmlNode node in appSettingsNodes)
        {
            string key = node.Attributes["key"].Value;
            string value = node.Attributes["value"].Value;
            Console.WriteLine($"Key: {key}, Value: {value}");
        }
    }
}

2.3 写入XML格式的自定义Config文件

在C#中，可以使用System.Xml命名空间中的类来写入XML文件。以下是一个向customConfig.xml文件中添加新配置项的示例代码：

using System;
using System.Xml;

class Program
{
    static void Main()
    {
        // 加载XML文件
        XmlDocument xmlDoc = new XmlDocument();
        xmlDoc.Load("customConfig.xml");

        // 获取appSettings节点
        XmlNode appSettingsNode = xmlDoc.SelectSingleNode("/configuration/appSettings");

        // 创建新的配置项
        XmlElement newElement = xmlDoc.CreateElement("add");
        newElement.SetAttribute("key", "Timeout");
        newElement.SetAttribute("value", "30");

        // 将新配置项添加到appSettings节点
        appSettingsNode.AppendChild(newElement);

        // 保存XML文件
        xmlDoc.Save("customConfig.xml");

        Console.WriteLine("新配置项已添加。");
    }
}

3. 使用JSON格式的自定义Config文件

JSON是一种轻量级的数据交换格式，易于阅读和编写。下面我们将介绍如何在C#中读写JSON格式的自定义Config文件。

3.1 创建JSON格式的自定义Config文件

首先，创建一个JSON格式的自定义Config文件，例如customConfig.json，内容如下：

{
  "appSettings": {
    "Server": "localhost",
    "Database": "MyDatabase",
    "User": "admin",
    "Password": "123456"
  }
}

3.2 读取JSON格式的自定义Config文件

在C#中，可以使用Newtonsoft.Json库（也称为Json.NET）来读取JSON文件。以下是一个读取customConfig.json文件的示例代码：

using System;
using Newtonsoft.Json.Linq;

class Program
{
    static void Main()
    {
        // 读取JSON文件
        string json = System.IO.File.ReadAllText("customConfig.json");

        // 解析JSON
        JObject config = JObject.Parse(json);

        // 获取appSettings节点
        JObject appSettings = (JObject)config["appSettings"];

        // 遍历appSettings节点
        foreach (var setting in appSettings)
        {
            string key = setting.Key;
            string value = setting.Value.ToString();
            Console.WriteLine($"Key: {key}, Value: {value}");
        }
    }
}

3.3 写入JSON格式的自定义Config文件

在C#中，可以使用Newtonsoft.Json库来写入JSON文件。以下是一个向customConfig.json文件中添加新配置项的示例代码：

using System;
using Newtonsoft.Json.Linq;

class Program
{
    static void Main()
    {
        // 读取JSON文件
        string json = System.IO.File.ReadAllText("customConfig.json");

        // 解析JSON
        JObject config = JObject.Parse(json);

        // 获取appSettings节点
        JObject appSettings = (JObject)config["appSettings"];

        // 添加新的配置项
        appSettings["Timeout"] = "30";

        // 保存JSON文件
        System.IO.File.WriteAllText("customConfig.json", config.ToString());

        Console.WriteLine("新配置项已添加。");
    }
}

4. 使用INI格式的自定义Config文件

INI文件是一种简单的配置文件格式，通常用于存储键值对形式的配置信息。下面我们将介绍如何在C#中读写INI格式的自定义Config文件。

4.1 创建INI格式的自定义Config文件

首先，创建一个INI格式的自定义Config文件，例如customConfig.ini，内容如下：

[appSettings]
Server=localhost
Database=MyDatabase
User=admin
Password=123456

4.2 读取INI格式的自定义Config文件

在C#中，可以使用System.IO命名空间中的类来读取INI文件。以下是一个读取customConfig.ini文件的示例代码：

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

class Program
{
    static void Main()
    {
        // 读取INI文件
        string[] lines = File.ReadAllLines("customConfig.ini");

        // 解析INI文件
        Dictionary<string, string> settings = new Dictionary<string, string>();
        string currentSection = "";

        foreach (string line in lines)
        {
            string trimmedLine = line.Trim();

            if (trimmedLine.StartsWith("[") && trimmedLine.EndsWith("]"))
            {
                currentSection = trimmedLine.Substring(1, trimmedLine.Length - 2);
            }
            else if (!string.IsNullOrEmpty(trimmedLine) && !trimmedLine.StartsWith(";"))
            {
                string[] keyValue = trimmedLine.Split(new char[] { '=' }, 2);
                if (keyValue.Length == 2)
                {
                    string key = $"{currentSection}.{keyValue[0].Trim()}";
                    string value = keyValue[1].Trim();
                    settings[key] = value;
                }
            }
        }

        // 输出配置项
        foreach (var setting in settings)
        {
            Console.WriteLine($"Key: {setting.Key}, Value: {setting.Value}");
        }
    }
}

4.3 写入INI格式的自定义Config文件

在C#中，可以使用System.IO命名空间中的类来写入INI文件。以下是一个向customConfig.ini文件中添加新配置项的示例代码：

using System;
using System.IO;

class Program
{
    static void Main()
    {
        // 读取INI文件
        List<string> lines = new List<string>(File.ReadAllLines("customConfig.ini"));

        // 添加新的配置项
        lines.Add("Timeout=30");

        // 保存INI文件
        File.WriteAllLines("customConfig.ini", lines);

        Console.WriteLine("新配置项已添加。");
    }
}

5. 总结

本文详细介绍了如何在C#中读写自定义的Config文件，涵盖了XML、JSON和INI三种常见的配置文件格式。通过使用这些技术，开发者可以根据项目需求灵活地管理和存储配置信息，从而提高应用程序的可维护性和扩展性。

在实际开发中，选择哪种配置文件格式取决于具体的需求和场景。XML适合存储复杂的配置信息，JSON适合存储轻量级的配置信息，而INI则适合存储简单的键值对形式的配置信息。无论选择哪种格式，掌握读写自定义Config文件的技能都将为你的C#开发工作带来极大的便利。