C# 读写 JSON 配置文件详解

在C#中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，被广泛应用于配置文件、数据交换等场景。使用JSON作为配置文件的优势在于其可读性强、易于编辑，并且能跨平台使用。下面我们将详细介绍如何使用C#来读写JSON配置文件。

读取JSON配置文件

在C#中，我们通常使用Newtonsoft.Json库（也称为Json.NET）来处理JSON数据。这个库提供了丰富的功能来序列化和反序列化JSON数据。

首先，你需要在项目中安装Newtonsoft.Json包，这通常可以通过NuGet包管理器来完成。

以下是一个简单的示例，演示如何读取一个JSON配置文件：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.IO;

public class ConfigReader
{
    public static void Main(string[] args)
    {
        string jsonFilePath = "config.json"; // 配置文件路径
        string jsonContent = File.ReadAllText(jsonFilePath); // 读取文件内容
        JObject jsonObject = JObject.Parse(jsonContent); // 解析JSON内容

        // 读取配置项
        string setting1 = (string)jsonObject["Setting1"];
        int setting2 = (int)jsonObject["Setting2"];
        bool setting3 = (bool)jsonObject["Setting3"];

        Console.WriteLine($"Setting1: {setting1}");
        Console.WriteLine($"Setting2: {setting2}");
        Console.WriteLine($"Setting3: {setting3}");
    }
}

假设你的config.json文件内容如下：

{
    "Setting1": "SomeValue",
    "Setting2": 123,
    "Setting3": true
}

写入JSON配置文件

写入JSON配置文件同样可以使用Newtonsoft.Json库。以下是一个简单的示例：

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.IO;

public class ConfigWriter
{
    public static void Main(string[] args)
    {
        var configObj = new
        {
            Setting1 = "NewValue",
            Setting2 = 456,
            Setting3 = false
        };

        string jsonContent = JsonConvert.SerializeObject(configObj, Formatting.Indented); // 转换为格式化的JSON字符串
        File.WriteAllText("config.json", jsonContent); // 写入文件
    }
}

这段代码会创建一个新的JSON对象，并将其序列化为一个格式化的JSON字符串，然后写入到config.json文件中。结果文件内容可能如下：

{
  "Setting1": "NewValue",
  "Setting2": 456,
  "Setting3": false
}

注意事项

• 确保你的JSON文件格式正确，否则解析可能会失败。
• 在处理JSON数据时，注意数据类型的转换和异常处理。
• 如果你的配置文件很大，考虑使用流式处理来提高性能。
• Newtonsoft.Json库功能强大，但也有一些其他库可供选择，如System.Text.Json，它是.NET Core 3.0及更高版本中引入的一个高性能、低内存消耗的库。
• 当处理敏感信息时，确保对配置文件进行适当的加密和保护。

结论

通过以上的介绍和示例代码，你应该已经了解了如何在C#中读写JSON配置文件。这些技能对于开发基于配置文件的应用程序非常有用，特别是当你需要灵活地管理应用程序设置时。