JSON。net：如何在不使用默认构造函数的情况下反序列化？

Question

我有一个类，它有一个默认构造函数，还有一个重载构造函数，它接受一组参数。这些参数与对象上的字段匹配，并在构造时指定。此时，我需要用于其他目的的默认构造函数，因此如果可以的话，我希望保留它。

我的问题：如果我删除默认的构造函数并传递JSON字符串，对象反序列化正确，并传递构造函数参数没有任何问题。我最终以我所期望的方式找回填充的对象。但是，一旦我将默认构造函数添加到对象中，当我调用JsonConverts时。对象

在这一点上，我已经尝试添加新的JsonSeriazerSetts（）{CheckAdditionalContent=true}到反序列化调用。那什么也没做。

另一个注意：构造函数参数确实与字段的名称完全匹配，除了参数以小写字母开头。我认为这并不重要，因为，就像我提到的，反序列化在没有默认构造函数的情况下运行良好。

以下是我的构造函数示例：

public Result() { }

public Result(int? code, string format, Dictionary<string, string> details = null)
{
    Code = code ?? ERROR_CODE;
    Format = format;

    if (details == null)
        Details = new Dictionary<string, string>();
    else
        Details = details;
}




Answer 1

根据这里的一些答案，我编写了一个CustomConstructorResolver，用于当前项目，我认为它可能会帮助其他人。

它支持以下可配置的解析机制：

• 选择一个私有构造函数，这样就可以定义一个私有构造函数，而不必用属性标记它

public class CustomConstructorResolver : DefaultContractResolver
{
    public string ConstructorAttributeName { get; set; } = "JsonConstructorAttribute";
    public bool IgnoreAttributeConstructor { get; set; } = false;
    public bool IgnoreSinglePrivateConstructor { get; set; } = false;
    public bool IgnoreMostSpecificConstructor { get; set; } = false;

    protected override JsonObjectContract CreateObjectContract(Type objectType)
    {
        var contract = base.CreateObjectContract(objectType);

        // Use default contract for non-object types.
        if (objectType.IsPrimitive || objectType.IsEnum) return contract;

        // Look for constructor with attribute first, then single private, then most specific.
        var overrideConstructor = 
               (this.IgnoreAttributeConstructor ? null : GetAttributeConstructor(objectType)) 
            ?? (this.IgnoreSinglePrivateConstructor ? null : GetSinglePrivateConstructor(objectType)) 
            ?? (this.IgnoreMostSpecificConstructor ? null : GetMostSpecificConstructor(objectType));

        // Set override constructor if found, otherwise use default contract.
        if (overrideConstructor != null)
        {
            SetOverrideCreator(contract, overrideConstructor);
        }

        return contract;
    }

    private void SetOverrideCreator(JsonObjectContract contract, ConstructorInfo attributeConstructor)
    {
        contract.OverrideCreator = CreateParameterizedConstructor(attributeConstructor);
        contract.CreatorParameters.Clear();
        foreach (var constructorParameter in base.CreateConstructorParameters(attributeConstructor, contract.Properties))
        {
            contract.CreatorParameters.Add(constructorParameter);
        }
    }

    private ObjectConstructor<object> CreateParameterizedConstructor(MethodBase method)
    {
        var c = method as ConstructorInfo;
        if (c != null)
            return a => c.Invoke(a);
        return a => method.Invoke(null, a);
    }

    protected virtual ConstructorInfo GetAttributeConstructor(Type objectType)
    {
        var constructors = objectType
            .GetConstructors(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic)
            .Where(c => c.GetCustomAttributes().Any(a => a.GetType().Name == this.ConstructorAttributeName)).ToList();

        if (constructors.Count == 1) return constructors[0];
        if (constructors.Count > 1)
            throw new JsonException($"Multiple constructors with a {this.ConstructorAttributeName}.");

        return null;
    }

    protected virtual ConstructorInfo GetSinglePrivateConstructor(Type objectType)
    {
        var constructors = objectType
            .GetConstructors(BindingFlags.Instance | BindingFlags.NonPublic);

        return constructors.Length == 1 ? constructors[0] : null;
    }

    protected virtual ConstructorInfo GetMostSpecificConstructor(Type objectType)
    {
        var constructors = objectType
            .GetConstructors(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic)
            .OrderBy(e => e.GetParameters().Length);

        var mostSpecific = constructors.LastOrDefault();
        return mostSpecific;
    }
}

以下是以XML留档为要点的完整版本：https://gist.github.com/maverickelementalch/80f77f4b6bdce3b434b0f7a1d06baa95

感谢您的反馈。

Answer 2

匿名用户

有点晚了，不太适合这里，但是我要在这里添加我的解决方案，因为我的问题已经作为这个问题的副本关闭了，因为这个解决方案完全不同。

我需要一种通用的方法来指导Json。NET为用户定义的结构类型选择最具体的构造函数，因此我可以省略JsonConstructor属性，该属性将为定义每个此类结构的项目添加依赖项。

我已经逆向工程了一点，并实现了一个自定义合同解析器，在那里我重写了CreateObject合同方法来添加我的自定义创建逻辑。

public class CustomContractResolver : DefaultContractResolver {

    protected override JsonObjectContract CreateObjectContract(Type objectType)
    {
        var c = base.CreateObjectContract(objectType);
        if (!IsCustomStruct(objectType)) return c;

        IList<ConstructorInfo> list = objectType.GetConstructors(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic).OrderBy(e => e.GetParameters().Length).ToList();
        var mostSpecific = list.LastOrDefault();
        if (mostSpecific != null)
        {
            c.OverrideCreator = CreateParameterizedConstructor(mostSpecific);
            c.CreatorParameters.AddRange(CreateConstructorParameters(mostSpecific, c.Properties));
        }

        return c;
    }

    protected virtual bool IsCustomStruct(Type objectType)
    {
        return objectType.IsValueType && !objectType.IsPrimitive && !objectType.IsEnum && !objectType.Namespace.IsNullOrEmpty() && !objectType.Namespace.StartsWith("System.");
    }

    private ObjectConstructor<object> CreateParameterizedConstructor(MethodBase method)
    {
        method.ThrowIfNull("method");
        var c = method as ConstructorInfo;
        if (c != null)
            return a => c.Invoke(a);
        return a => method.Invoke(null, a);
    }
}

我是这样用的。

public struct Test {
  public readonly int A;
  public readonly string B;

  public Test(int a, string b) {
    A = a;
    B = b;
  }
}

var json = JsonConvert.SerializeObject(new Test(1, "Test"), new JsonSerializerSettings {
  ContractResolver = new CustomContractResolver()
});
var t = JsonConvert.DeserializeObject<Test>(json);
t.A.ShouldEqual(1);
t.B.ShouldEqual("Test");

Answer 3

Json。Net更喜欢在对象上使用默认（无参数）构造函数（如果有）。如果有多个构造函数，并且您需要Json。Net使用非默认的构造函数，然后可以将[JsonConstructor]属性添加到需要Json的构造函数中。Net调用。

[JsonConstructor]
public Result(int? code, string format, Dictionary<string, string> details = null)
{
    ...
}

构造函数参数名必须与JSON对象的相应属性名相匹配（忽略大小写），这一点很重要，这样才能正常工作。但是，您不必为对象的每个属性都使用构造函数参数。对于构造函数参数未涵盖的JSON对象属性，JSON。Net将尝试使用公共属性访问器（或标记为[JsonProperty]的属性/字段）在构建对象后填充该对象。

如果您不想向类添加属性，或者不想控制要反序列化的类的源代码，那么另一种选择是创建自定义JsonConverter来实例化和填充对象。例如：

class ResultConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return (objectType == typeof(Result));
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // Load the JSON for the Result into a JObject
        JObject jo = JObject.Load(reader);

        // Read the properties which will be used as constructor parameters
        int? code = (int?)jo["Code"];
        string format = (string)jo["Format"];

        // Construct the Result object using the non-default constructor
        Result result = new Result(code, format);

        // (If anything else needs to be populated on the result object, do that here)

        // Return the result
        return result;
    }

    public override bool CanWrite
    {
        get { return false; }
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

然后，将转换器添加到序列化程序设置中，并在反序列化时使用这些设置：

JsonSerializerSettings settings = new JsonSerializerSettings();
settings.Converters.Add(new ResultConverter());
Result result = JsonConvert.DeserializeObject<Result>(jsontext, settings);