将 json 反序列化为具有默认私有构造函数的类的 C# 对象

Question

我需要为下面的课程反序列化 json。

public class Test
{
    public string Property { get; set; }

    private Test()
    {
        //NOTHING TO INITIALIZE
    }

    public Test(string prop)
    {
        Property = prop;
    }
}

我可以创建一个像这样的测试实例

var instance = new Test("Instance");

考虑到我的json之类的

"{  "Property":"Instance" }"

我应该如何创建一个 Test 类的对象，因为我的默认构造函数是私有的并且我正在获取 Property 为 NULL 的对象

我正在使用 Newtonsoft Json 解析器。

Answer 1

您可以通过使用[JsonConstructor] 属性标记来让 Json.Net 调用私有构造函数：

[JsonConstructor]
private Test()
{
    //NOTHING TO INITIALIZE
}

请注意，在调用构造函数后，序列化程序仍将使用公共 setter 来填充对象。

---

另一个可能的选择是使用ConstructorHandling 设置：

JsonSerializerSettings settings = new JsonSerializerSettings
{
    ConstructorHandling = ConstructorHandling.AllowNonPublicDefaultConstructor
};

Test t = JsonConvert.DeserializeObject<Test>(json, settings);

Answer 2

您似乎不需要采取任何额外的步骤。

使用 Json.NET v6.0.8，以下 C# 程序在 LINQPad 中运行：

void Main()
{   
    var o = JsonConvert.DeserializeObject<Test>("{\"Property\":\"Instance\"}");

    Debug.Assert(o.Property == "Instance",
        "Property value not set when deserializing.");
}

public class Test
{
    public string Property { get; set; }

    private Test()
    {
    }

    public Test(string propertyValue)
    {
        Property = propertyValue;
    }
}

Answer 3

无需创建 Serializer 设置并在此处分配 ConstructorHandling。请记住将[JsonConstructor] 属性定义为私有构造函数。 我对抽象 BaseNode.cs 及其具体的 ComputerNode.cs 实现有类似的情况。您可以创建类，复制/粘贴下面的代码并进行一些实验。

    public abstract class BaseNode
{
    [JsonConstructor] // ctor used when Json Deserializing
    protected BaseNode(string Owner, string Name, string Identifier)
    {
        this.Name = Name;
        this.Identifier = Identifier;
    }

    // ctor called by concrete class.
    protected BaseNode(string [] specifications)
    {
        if (specifications == null)
        {
            throw new ArgumentNullException();
        }
        if (specifications.Length == 0)
        {
            throw new ArgumentException();
        }

        Name = specifications[0];
        Identifier = specifications[1];

    }

    public string Name{ get; protected set; }
    public string Identifier { get; protected set; }

}


public class ComputerNode: BaseNode
{
    public string Owner { get; private set; }

    [JsonConstructor] // not visible while creating object from outside and only used during Json Deserialization.
    private ComputerNode(string Owner, string Name, string Identifier):base(Owner, Name, Identifier)
    {
        this.Owner = Owner;
    }

    public ComputerNode(string[] specifications):base(specifications)
    {
        Owner = specifications[2];
    }
}

对于 JSON 读写以下代码有帮助 -

    public class Operation<T>
{
    public string path;

    public Operation()
    {
        var path = Path.Combine(Directory.GetCurrentDirectory(), "nodes.txt");

        if (File.Exists(path) == false)
        {
            using (File.Create(path))
            {
            }
        }
        this.path = path;
    }

    public void Write(string path, List<T> nodes)
    {
        var ser = JsonConvert.SerializeObject(nodes, Formatting.Indented);

        File.WriteAllText(path, ser);
    }

    public List<T> Read(string path)
    {
        var text = File.ReadAllText(path);

        var res =  JsonConvert.DeserializeObject<List<T>>(text);
        return res;
    }

}

一切顺利！

Answer 4

今天的简短回答是：将构造函数参数prop 重命名为property，您的代码就可以正常工作了。

public class Test
{
    public string Property { get; }

    public Test(string property)
    {
        Property = property;
    }
}

Console.WriteLine(
  JsonConvert.DeserializeObject(new Test("Instance")));

Newtonsoft.Json 支持使用开箱即用的构造函数参数初始化属性，无需设置任何其他属性或更改任何设置。唯一的限制是参数名称需要与属性名称不区分大小写。

Answer 5

我今天发现，有一个 public 构造函数接受参数 并且没有 声明 未参数化的构造函数导致 NewtonSoft尝试调用唯一可以找到的公共构造函数，因为没有显式的默认构造函数，并且它显然无法找到并调用框架提供的默认构造函数除非它是 唯一的构造函数。

显式声明默认构造函数会导致 NewtonSoft 调用正确的（未参数化的）构造函数。