从 C# 中的文件反序列化 Json

Posted 2023-04-12

【中文标题】从 C# 中的文件反序列化 Json

【英文标题】：Deserialize Json from file in C#

【发布时间】：2015-10-24 19:44:22

【问题描述】：

我已经设法在不从键中删除路径的情况下找到了解决方案。感谢各位的帮助，并指出问题，我真的很感激！ :)

将 Json 加载到字符串中，将其反序列化为动态，通过它运行 foreach，并添加到其中包含 ResFiles 的列表。

static void loadJson()

    List<ResFile> fileList = new List<ResFile>();
    string jsonString = File.ReadAllText(jsonPath);
    dynamic files = JsonConvert.DeserializeObject(jsonString);

    foreach (var f in files.objects)
        fileList.Add(new ResFile(f.Name, f.Value.hash.ToString(), (int)f.Value.size.Value));

---

我正在尝试使用 Newtonsoft 的 Json 库在 C# 中反序列化一些 Json 文件。 这些文件以其哈希命名，而不是真实文件名，我想将它们重命名为正确名称，如下所示：10a54fc66c8f479bb65c8d39c3b62265ac82e742 >> file_1.ext em>

Json 文件：

  "files": 
    "file_1.ext": 
      "hash": "10a54fc66c8f479bb65c8d39c3b62265ac82e742",
      "size": 8112
    ,
    "file_2.ext": 
      "hash": "14cfb2f24e7d91dbc22a2a0e3b880d9829320243",
      "size": 7347
    ,
    "file_3.ext": 
      "hash": "bf7fadaf64945f6b31c803d086ac6a652aabef9b",
      "size": 3838
    ,
    "file_4.ext": 
      "hash": "48f7e1bb098abd36b9760cca27b9d4391a23de26",
      "size": 6905
    
  

我试过用这个反序列化：

static void loadJson()

    using (StreamReader reader = new StreamReader(jsonPath))
    
        string json = reader.ReadToEnd();
        dynamic files = JsonConvert.DeserializeObject(json);
    

反序列化本身可以工作，但我不知道如何循环它们。

我也尝试过这样做：

class ResFile

    public string name;
    public string hash;
    public int size;

并以某种方式强制反序列化使用它，但它当然不起作用。

【参考方案1】：

根据您的示例 json，您的课程将是：

public class ResFile

    public string hash  set; get; 
    public int size  set; get; 


public class ResRoot

    public Dictionary<string, ResFile> Files  set; get; 

---

你可以反序列化为

var res = JsonConvert.DeserializeObject<ResRoot>(File.ReadAllText(filename));

---

foreach(var f in res.Files)

    Console.WriteLine("Name=0 Size=1", f.Key, f.Value.size);

【讨论】：

它给出 NullRef 错误，res 对象为空。但是路径是正确的，并且文件正确读取。反序列化中的某些内容不起作用。

@DavidDosa 鉴于您的 json 示例，上述代码有效。在发布之前进行了测试。

该文件，其中包含真实数据，包含 3k 行，几乎有 100k 个字符...也许这就是问题所在，因为我已经让您的代码正常工作，而且真的，上面给出的示例，它可以工作，但对于真实文件，它不会。文件名也包含它的路径，因为是分类的，会不会有问题？

@DavidDosa 很可能有问题的示例 json 不是真实示例的简化情况。把你的 json 放到json2csharp.com 看看它会为你生成什么。

该页面为 Json 中的每个文件生成类，3k 类，我认为不是最好的。问题似乎出在文件名中。它也包含文件的路径。 （“声音/环境/洞穴/cave4.ogg”）

【参考方案2】：

请遵循 C# 约定，不要将成员变量公开或以小写开头的属性名称。为了使您的常规对象可反序列化，您可以使用 System.Runtime.Serialization DataContract 和 DataMember 属性。 DataContract 表示该类型的对象是可序列化的，DataMember 用于指定属性的序列化名称。

class ResFile

    [DataMember(Name = "name")]
    public string Name  get; set;  

    [DataMember(Name = "hash")]
    public string Hash  get; set;  

    [DataMember(Name = "size")]
    public int Size  get; set; 

    public ResFile ()  


[DataContract]
class ResFileCollection

    [DataMember(Name ="files")]
    public Dictionary<string, ResFile> Files  get; set; 

这里是反序列化：

string json = File.ReadAllText("data.json");
        var files = JsonConvert.DeserializeObject<ResFileCollection>(json);
        foreach(KeyValuePair<string, ResFile> f in files.Files)
        
            Console.WriteLine("0 1 2", f.Key, f.Value.Name, f.Value.Hash);
        

为了获得更好的性能，序列化的属性名称也应该更短。一个例子：

[DataMember(Name="src")]
public string SourcePath  get; set; 

【讨论】：

you could use the System.Runtime.Serialization DataContract and DataMember attributes No Json.Net 不需要它们。遵循 c# 命名约定很好，但您不需要任何额外的 Attribute 甚至为此。 Json.Net 会自动处理。

它不需要它们，但它也不会忽略它们。它们还暗示该类型应该被序列化，从而使代码更具可读性。在某些情况下，JSON 中的长字符串可能会出现问题。 PascalCase 也不在 javascript 的约定中。

值得注意的是，使用此 DataContract 解决方案的任何人都应在此处查看 MSDN 文章：docs.microsoft.com/en-us/dotnet/framework/wcf/feature-details/…。它需要一些额外的程序集： System.Runtime.Serialization.Primatives 和 System.Runtime.Serialization.Json ，但比让第三方 JSON 库处理运行时组件更符合 Microsoft 规范。由于该解决方案比其他解决方案更符合 C# .NET Microsoft 规范，因此受到支持。