Json.Net 序列化类名而不是内部属性

Question

这是代码：

public class ParameterDictionary : Dictionary<HydroObjectIdentifier, string>
{

    public void WriteToJson(string jsonFilePath)
    {
        string json = Newtonsoft.Json.JsonConvert.SerializeObject(this, formatting: Newtonsoft.Json.Formatting.Indented);
        System.IO.File.WriteAllText(jsonFilePath, json);
    }

}

public struct HydroObjectIdentifier
{

    public string Name { get; set; }
    public string TypeName { get; set; }

    public HydroObjectIdentifier(string name, string typeName)
    {
        this.Name = name;
        this.TypeName = typeName;
    }

}

...这是 Json 结果。请注意，它显示了类名 RSEngine.HydroObjectIdentifier 而不是它的参数，这在我的代码中不是有意的。

{
  "RSEngine.HydroObjectIdentifier": [
    {
      "myString"
    },
    ...

如 cmets 中所述，预期行为是将 Name 和 TypeName 写入 json，而不是类的名称。

Answer 1

您看到此行为的原因是因为您使用复杂对象 (HydroObjectIdentifier) 作为字典中的键。在 JSON 中，对象键必须始终是字符串，根据 the spec。当 Json.Net 尝试序列化字典时，它会看到您的键是 not 字符串。因为它需要一个字符串，所以它只是在你的类上调用ToString()。 C# 中ToString() 的默认实现返回类型的名称，在您的情况下为RSEngine.HydroObjectIdentifier。

如果您实现自己的 ToString() 方法，正如另一个答案中所建议的那样，那么您可以制作任何您想要解决问题的密钥。但是，这种方法的缺点是您将无法将 JSON 反序列化回您的字典中。这是因为 Json.Net 无法使用相反的“FromString”方法将序列化的密钥从字符串转换回您的标识符类。如果您需要能够使用 JSON（序列化和反序列化）进行完整的往返，那么您将需要一个不同的解决方案。

在 Json.Net 中有几种可能的方法来处理复杂的字典键：

1. 为您的标识符类实现TypeConverter，如Json.Net Serialization Guide 中所述。有关详细信息，请参阅 MSDN 中的 How to: Implement a Type Converter。实现类型转换器后，您需要使用 [TypeConverter] 属性标记您的类，以便 Json.Net 知道使用它。
2. 对字典使用自定义的JsonConverter，这会改变键值对写入 JSON 的方式。有关该方法的示例，请参阅 How To Serialize a class that derives from a Dictionary。

Answer 2

尝试重写 ToString() 方法：

public struct HydroObjectIdentifier
{

    public string Name { get; set; }
    public string TypeName { get; set; }

    public override string ToString()
    {
        return Newtonsoft.Json.JsonConvert.SerializeObject(this);
    }

    public HydroObjectIdentifier(string name, string typeName)
    {
        this.Name = name;
        this.TypeName = typeName;
    }

}