C#怎么讀寫自定義的Config文件

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#開發工作帶來極大的便利。