如何将 JSON 文件读入字符串指定值并使用 System.Text.Json？

Question

我有一个带有 SQL 服务器连接的.Net Core 3.1 控制台应用程序（不是 ASP.NET 核心），其中连接字符串存储在 appsettings.json 文件中

{"ConnectionStrings": { "DefaultConnection":"Server=sqlserver;Database=appDb;User=username;Password=password;" }}

以前我使用 Json.Net 读取字符串

var connString = JObject.Parse(File.ReadAllText("appsettings.json")).GetValue("ConnectionStrings").SelectToken("DefaultConnection").ToString()

它工作得很好。 现在我决定切换到 System.Text.Json 库并遇到动态反序列化问题。 以下代码引发异常：

var dict = JsonSerializer.Deserialize<Dictionary<string, string[]>>("appsettings.json");

System.Text.Json.JsonException：“a”是值的无效开始。 路径：$ | 行号：0 | BytePositionInLine：0。 内部异常 JsonReaderException：“a”是值的无效开始。 行号：0 | 字节位置内线：0。

然后我会从字典中读取指定 Where Key ==“ConnectionStrings”，然后是字符串数组的后续值 ==“DefaultConnection”。 由于异常，我还没有达到那个点，所以我还没有计划如何从字典中阅读。

如何使用新的 System.Text.Json 库从 appsettings.json 文件中读取连接字符串？ 反序列化为Dictianory<string, string[]>是否正确？ 还是使用Dictianory<string, Dictianory<string, string>>会更好？

Answer 1

JsonSerializer.Deserialize需要一个 JSON 字符串，而不是文件名。

您需要将文件加载到字符串中，然后将其传递给Deserialize方法：

var json = File.ReadAllText("appsettings.json");
var dict = JsonSerializer.Deserialize<Dictionary<string, string[]>>(json);

Answer 2

为此，我在 JsonDocument 中使用了 api：

var json = File.ReadAllText("appsettings.json");
var appSettings = JsonDocument.Parse(json, new JsonDocumentOptions { CommentHandling = JsonCommentHandling.Skip });
var result = appSettings.RootElement.GetProperty("ConnectionStrings").GetProperty("DefaultConnection").GetString();  

高温高压

Answer 3

System.Text.Json的好处之一是它可以轻松有效地直接从Stream反序列化。 When reading JSON from I/O such as a file or HTTP request, it's better to just deserialize the Stream directly and avoid the unnecessary allocations and memory required to read it into a string first.

using var reader = new StreamReader("appsettings.json");
var dict = await JsonSerializer.DeserializeAsync<<Dictionary<string, string[]>>(reader.BaseStream);

话虽如此，对于读取appsettings.json的具体情况，最好使用 .NET Generic Host 内置的配置工具，而不是手动解析 Z0ECD11C1D7A287401D148A23BBDDA7。 这带来了额外的好处，例如能够使用环境变量和/或命令行开关覆盖这些设置，以及更轻松地将它们移动到另一个存储系统，如 KeyVault。