बेस क्लास ऑब्जेक्ट्स की सूची को निष्क्रिय करने के लिए JSON.NET में कस्टम JsonConverter कैसे लागू करें?


301

मैं यहां दिए जा रहे JSON.net उदाहरण का विस्तार करने की कोशिश कर रहा हूं। http://james.newtonking.com/projects/json/help/CustomCreationConverter.html

मेरे पास बेस क्लास / इंटरफ़ेस से एक और उप क्लास है

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

public class Employee : Person
{
    public string Department { get; set; }
    public string JobTitle { get; set; }
}

public class Artist : Person
{
    public string Skill { get; set; }
}

List<Person> people  = new List<Person>
{
    new Employee(),
    new Employee(),
    new Artist(),
};

मैं Json के बाद सूची <व्यक्ति> के पीछे कैसे हटना चाहता हूं

[
  {
    "Department": "Department1",
    "JobTitle": "JobTitle1",
    "FirstName": "FirstName1",
    "LastName": "LastName1"
  },
  {
    "Department": "Department2",
    "JobTitle": "JobTitle2",
    "FirstName": "FirstName2",
    "LastName": "LastName2"
  },
  {
    "Skill": "Painter",
    "FirstName": "FirstName3",
    "LastName": "LastName3"
  }
]

मैं TypeNameHandling JsonSerializerSettings का उपयोग नहीं करना चाहता। मैं विशेष रूप से इसे संभालने के लिए कस्टम JsonConverter कार्यान्वयन की तलाश कर रहा हूं। इसके आस-पास के दस्तावेज़ और उदाहरण नेट पर काफी विरल हैं। मैं JsonConverter अधिकार में ओवरराइड ReadJson () विधि कार्यान्वयन प्राप्त करने के लिए प्रतीत नहीं कर सकता।


जवाबों:


315

मानक का उपयोग करते हुए CustomCreationConverter, मैं सही प्रकार ( Personया Employee) उत्पन्न करने के लिए काम करने के लिए संघर्ष कर रहा था , क्योंकि इसे निर्धारित करने के लिए आपको JSON का विश्लेषण करने की आवश्यकता है और Createविधि का उपयोग करके ऐसा करने के लिए कोई अंतर्निहित नहीं है ।

मुझे टाइप रूपांतरण से संबंधित एक चर्चा धागा मिला और यह उत्तर प्रदान करने के लिए निकला। यहां एक लिंक दिया गया है: प्रकार परिवर्तित करना

सबक्लास की आवश्यकता है JsonConverter, ReadJsonविधि को ओवरराइड करने और एक नई अमूर्त Createविधि बनाने की जो एक को स्वीकार करती है JObject

जोबजेक्ट क्लास एक JSON ऑब्जेक्ट को लोड करने का साधन प्रदान करता है और इस ऑब्जेक्ट के भीतर डेटा तक पहुंच प्रदान करता है।

ओवरराइड ReadJsonविधि एक बनाता है JObjectऔर Createविधि (हमारे व्युत्पन्न कनवर्टर वर्ग द्वारा लागू) को लागू करता है, JObjectउदाहरण के लिए।

इस JObjectउदाहरण का विश्लेषण कुछ क्षेत्रों के अस्तित्व की जाँच करके सही प्रकार का निर्धारण करने के लिए किया जा सकता है।

उदाहरण

string json = "[{
        \"Department\": \"Department1\",
        \"JobTitle\": \"JobTitle1\",
        \"FirstName\": \"FirstName1\",
        \"LastName\": \"LastName1\"
    },{
        \"Department\": \"Department2\",
        \"JobTitle\": \"JobTitle2\",
        \"FirstName\": \"FirstName2\",
        \"LastName\": \"LastName2\"
    },
        {\"Skill\": \"Painter\",
        \"FirstName\": \"FirstName3\",
        \"LastName\": \"LastName3\"
    }]";

List<Person> persons = 
    JsonConvert.DeserializeObject<List<Person>>(json, new PersonConverter());

...

public class PersonConverter : JsonCreationConverter<Person>
{
    protected override Person Create(Type objectType, JObject jObject)
    {
        if (FieldExists("Skill", jObject))
        {
            return new Artist();
        }
        else if (FieldExists("Department", jObject))
        {
            return new Employee();
        }
        else
        {
            return new Person();
        }
    }

    private bool FieldExists(string fieldName, JObject jObject)
    {
        return jObject[fieldName] != null;
    }
}

public abstract class JsonCreationConverter<T> : JsonConverter
{
    /// <summary>
    /// Create an instance of objectType, based properties in the JSON object
    /// </summary>
    /// <param name="objectType">type of object expected</param>
    /// <param name="jObject">
    /// contents of JSON object that will be deserialized
    /// </param>
    /// <returns></returns>
    protected abstract T Create(Type objectType, JObject jObject);

    public override bool CanConvert(Type objectType)
    {
        return typeof(T).IsAssignableFrom(objectType);
    }

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

    public override object ReadJson(JsonReader reader, 
                                    Type objectType, 
                                     object existingValue, 
                                     JsonSerializer serializer)
    {
        // Load JObject from stream
        JObject jObject = JObject.Load(reader);

        // Create target object based on JObject
        T target = Create(objectType, jObject);

        // Populate the object properties
        serializer.Populate(jObject.CreateReader(), target);

        return target;
    }
}

6
यह अच्छा होगा कि WriteJson पद्धति को भी लागू किया जाए, और प्रकार को सख्त करने के लिए कुछ सार विधि प्रदान की जाए।
त्रिवेंको

54
नोट: यह समाधान पूरे इंटरनेट पर है, लेकिन इसमें एक दोष है जो दुर्लभ अवसरों में ही प्रकट होता है। नई JsonReaderमें बनाया ReadJsonविधि मूल पाठक का विन्यास से कोई भी मान (वारिस नहीं है Culture, DateParseHandling, DateTimeZoneHandling, FloatParseHandling, आदि ...)। इन मूल्यों नया प्रयोग करने से पहले उन पर कॉपी किया जाना चाहिए JsonReaderमें serializer.Populate()
एलेन

9
नया JsonReader बनाने से रोकने के लिए (@Alain द्वारा बताए गए कारणों के कारण), या यदि आपको माता-पिता के कुछ मूल्य के आधार पर बनाई गई ऑब्जेक्ट के प्रकार के बारे में निर्णय लेने की आवश्यकता है, तो इस समाधान को देखें stackoverflow.com/a/22539730/10/10496 । मुझे अधिक प्रभावी और स्पष्ट लगता है (इस तरह की समस्या के लिए भी)।
ज़ोका

8
@ ट्रायनको: खोज के एक लंबे समय के बाद, मुझे पता चला, कि कक्षा JsonConverterमें एक संपत्ति है जिसे कहा जाता है CanReadऔर CanWrite। यदि आपको कस्टम WriteJsonकार्यान्वयन की आवश्यकता नहीं है , तो इसे CanWriteवापस जाने के लिए पर्याप्त है FALSE। सिस्टम फिर डिफ़ॉल्ट व्यवहार पर वापस आ जाएगा। @jdavies: कृपया उसे अपने उत्तर में जोड़ें। अन्यथा यह सीरियलाइजेशन पर क्रैश हो जाएगा।
साइमनसिमिटी

1
मैंने पाया कि आपको NULL मामलों को संभालना होगा, अन्यथा एक अच्छी त्रुटि होगी। का प्रयोग करें: ||| if (Reader.TokenType == JsonToken.Null) अशक्त; |||| स्रोत: stackoverflow.com/a/34185296/857291
सीजर

95

के लिए उपरोक्त समाधान JsonCreationConverter<T> पूरे इंटरनेट पर है, लेकिन इसमें एक दोष है जो दुर्लभ अवसरों में ही प्रकट होता है। ReadJson विधि में बनाया गया नया JsonReader मूल पाठक के कॉन्फ़िगरेशन मानों (संस्कृति, DateParseHandling, DateTimeZoneHandling, FloatParseHandling, आदि ...) में से किसी को भी विरासत में नहीं मिला है। इन मानों को कॉपीराइजर में नए JsonReader का उपयोग करने से पहले कॉपी किया जाना चाहिए।

यह सबसे अच्छा है जो मैं उपरोक्त कार्यान्वयन के साथ कुछ समस्याओं को ठीक करने के लिए आ सकता हूं, लेकिन मुझे अभी भी लगता है कि कुछ चीजें अनदेखी की जा रही हैं:

अद्यतन मैंने इसे और अधिक स्पष्ट विधि के लिए अद्यतन किया है जो किसी मौजूदा पाठक की प्रतिलिपि बनाता है। यह सिर्फ व्यक्तिगत JsonReader सेटिंग्स पर कॉपी करने की प्रक्रिया को एन्क्रिप्ट करता है। आदर्श रूप से यह फ़ंक्शन न्यूटनसॉफ्ट लाइब्रेरी में ही रखा जाएगा, लेकिन अभी के लिए, आप निम्नलिखित का उपयोग कर सकते हैं:

/// <summary>Creates a new reader for the specified jObject by copying the settings
/// from an existing reader.</summary>
/// <param name="reader">The reader whose settings should be copied.</param>
/// <param name="jToken">The jToken to create a new reader for.</param>
/// <returns>The new disposable reader.</returns>
public static JsonReader CopyReaderForObject(JsonReader reader, JToken jToken)
{
    JsonReader jTokenReader = jToken.CreateReader();
    jTokenReader.Culture = reader.Culture;
    jTokenReader.DateFormatString = reader.DateFormatString;
    jTokenReader.DateParseHandling = reader.DateParseHandling;
    jTokenReader.DateTimeZoneHandling = reader.DateTimeZoneHandling;
    jTokenReader.FloatParseHandling = reader.FloatParseHandling;
    jTokenReader.MaxDepth = reader.MaxDepth;
    jTokenReader.SupportMultipleContent = reader.SupportMultipleContent;
    return jTokenReader;
}

इसका उपयोग इस प्रकार किया जाना चाहिए:

public override object ReadJson(JsonReader reader,
                                Type objectType,
                                object existingValue,
                                JsonSerializer serializer)
{
    if (reader.TokenType == JsonToken.Null)
        return null;
    // Load JObject from stream
    JObject jObject = JObject.Load(reader);
    // Create target object based on JObject
    T target = Create(objectType, jObject);
    // Populate the object properties
    using (JsonReader jObjectReader = CopyReaderForObject(reader, jObject))
    {
        serializer.Populate(jObjectReader, target);
    }
    return target;
}

पुराने समाधान निम्नानुसार हैं:

/// <summary>Base Generic JSON Converter that can help quickly define converters for specific types by automatically
/// generating the CanConvert, ReadJson, and WriteJson methods, requiring the implementer only to define a strongly typed Create method.</summary>
public abstract class JsonCreationConverter<T> : JsonConverter
{
    /// <summary>Create an instance of objectType, based properties in the JSON object</summary>
    /// <param name="objectType">type of object expected</param>
    /// <param name="jObject">contents of JSON object that will be deserialized</param>
    protected abstract T Create(Type objectType, JObject jObject);

    /// <summary>Determines if this converted is designed to deserialization to objects of the specified type.</summary>
    /// <param name="objectType">The target type for deserialization.</param>
    /// <returns>True if the type is supported.</returns>
    public override bool CanConvert(Type objectType)
    {
        // FrameWork 4.5
        // return typeof(T).GetTypeInfo().IsAssignableFrom(objectType.GetTypeInfo());
        // Otherwise
        return typeof(T).IsAssignableFrom(objectType);
    }

    /// <summary>Parses the json to the specified type.</summary>
    /// <param name="reader">Newtonsoft.Json.JsonReader</param>
    /// <param name="objectType">Target type.</param>
    /// <param name="existingValue">Ignored</param>
    /// <param name="serializer">Newtonsoft.Json.JsonSerializer to use.</param>
    /// <returns>Deserialized Object</returns>
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
            return null;

        // Load JObject from stream
        JObject jObject = JObject.Load(reader);

        // Create target object based on JObject
        T target = Create(objectType, jObject);

        //Create a new reader for this jObject, and set all properties to match the original reader.
        JsonReader jObjectReader = jObject.CreateReader();
        jObjectReader.Culture = reader.Culture;
        jObjectReader.DateParseHandling = reader.DateParseHandling;
        jObjectReader.DateTimeZoneHandling = reader.DateTimeZoneHandling;
        jObjectReader.FloatParseHandling = reader.FloatParseHandling;

        // Populate the object properties
        serializer.Populate(jObjectReader, target);

        return target;
    }

    /// <summary>Serializes to the specified type</summary>
    /// <param name="writer">Newtonsoft.Json.JsonWriter</param>
    /// <param name="value">Object to serialize.</param>
    /// <param name="serializer">Newtonsoft.Json.JsonSerializer to use.</param>
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }
}

7
CanWrite के बारे में सोचना मत भूलना! (मैं इसे गलत पर सेट करता हूं) आप सेल्फफ्रेंसिंगलूप्स के साथ समाप्त हो सकते हैं (मैंने किया था)। stackoverflow.com/questions/12314438/…
Dribbel

1
क्या आपको भी WriteJson को लागू करने की आवश्यकता नहीं है? कनवर्टर को कैसे पता है कि ऑब्जेक्ट से json में कैसे बदलना है?
डेविड एस।

15

बस मैंने सोचा था कि इस पर आधारित एक समाधान भी साझा किया जाएगा जो कि प्रतिबिंब का उपयोग करके ज्ञात विशेषता के साथ काम करता है, किसी भी आधार वर्ग से व्युत्पन्न वर्ग प्राप्त करना था, समाधान पुनरावर्तन से सबसे अच्छा मिलान वर्ग खोजने के लिए लाभ उठा सकता है, हालांकि मुझे इसकी आवश्यकता नहीं थी मामला, मिलान कनवर्टर को दिए गए प्रकार से किया जाता है यदि यह ज्ञात है तो यह उन सभी को स्कैन करेगा जब तक कि यह एक प्रकार से मेल नहीं खाता है जिसमें जस स्ट्रिंग के अंदर सभी गुण हैं, पहले एक से चुना जाएगा।

उपयोग के रूप में सरल है:

 string json = "{ Name:\"Something\", LastName:\"Otherthing\" }";
 var ret  = JsonConvert.DeserializeObject<A>(json, new KnownTypeConverter());

उपरोक्त मामले में रिट बी प्रकार की होगी।

JSON कक्षाएं:

[KnownType(typeof(B))]
public class A
{
   public string Name { get; set; }
}

public class B : A
{
   public string LastName { get; set; }
}

कनवर्टर कोड:

/// <summary>
    /// Use KnownType Attribute to match a divierd class based on the class given to the serilaizer
    /// Selected class will be the first class to match all properties in the json object.
    /// </summary>
    public  class KnownTypeConverter : JsonConverter
    {
        public override bool CanConvert(Type objectType)
        {
            return System.Attribute.GetCustomAttributes(objectType).Any(v => v is KnownTypeAttribute);
        }

        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            // Load JObject from stream
            JObject jObject = JObject.Load(reader);

            // Create target object based on JObject
            System.Attribute[] attrs = System.Attribute.GetCustomAttributes(objectType);  // Reflection. 

                // Displaying output. 
            foreach (System.Attribute attr in attrs)
            {
                if (attr is KnownTypeAttribute)
                {
                    KnownTypeAttribute k = (KnownTypeAttribute) attr;
                    var props = k.Type.GetProperties();
                    bool found = true;
                    foreach (var f in jObject)
                    {
                        if (!props.Any(z => z.Name == f.Key))
                        {
                            found = false;
                            break;
                        }
                    }

                    if (found)
                    {
                        var target = Activator.CreateInstance(k.Type);
                        serializer.Populate(jObject.CreateReader(),target);
                        return target;
                    }
                }
            }
            throw new ObjectNotFoundException();


            // Populate the object properties

        }

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

1
मैं वास्तव में इस समाधान को पसंद करता हूं, लेकिन मैं एक समस्या देख सकता हूं जब कई ज्ञात प्रकार होते हैं जिनके समान संपत्ति के नाम होते हैं। क्या आपने उस समस्या का सामना किया है? धन्यवाद।
कोवो

8

परियोजना JsonSubTypes एक जेनेरिक कन्वर्टर लागू करता है जो इस फीचर को विशेषताओं की मदद से संभालता है।

यहाँ दिए गए ठोस नमूने के लिए यह कैसे काम करता है:

    [JsonConverter(typeof(JsonSubtypes))]
    [JsonSubtypes.KnownSubTypeWithProperty(typeof(Employee), "JobTitle")]
    [JsonSubtypes.KnownSubTypeWithProperty(typeof(Artist), "Skill")]
    public class Person
    {
        public string FirstName { get; set; }
        public string LastName { get; set; }
    }

    public class Employee : Person
    {
        public string Department { get; set; }
        public string JobTitle { get; set; }
    }

    public class Artist : Person
    {
        public string Skill { get; set; }
    }

    [TestMethod]
    public void Demo()
    {
        string json = "[{\"Department\":\"Department1\",\"JobTitle\":\"JobTitle1\",\"FirstName\":\"FirstName1\",\"LastName\":\"LastName1\"}," +
                      "{\"Department\":\"Department1\",\"JobTitle\":\"JobTitle1\",\"FirstName\":\"FirstName1\",\"LastName\":\"LastName1\"}," +
                      "{\"Skill\":\"Painter\",\"FirstName\":\"FirstName1\",\"LastName\":\"LastName1\"}]";


        var persons = JsonConvert.DeserializeObject<IReadOnlyCollection<Person>>(json);
        Assert.AreEqual("Painter", (persons.Last() as Artist)?.Skill);
    }

2
बहुत उपयोगी कनवर्टर। बस मुझे एक कनवर्टर कोडिंग के घंटे खुद को बचाया!
कार्लोस रोड्रिगेज

7

यह कुलदेवता के उत्तर का विस्तार है। यह मूल रूप से एक ही काम करता है, लेकिन संपत्ति का मिलान क्रमबद्ध json ऑब्जेक्ट पर आधारित होता है, .net ऑब्जेक्ट को प्रतिबिंबित नहीं करता है। यह महत्वपूर्ण है अगर आप [JsonProperty] का उपयोग कर रहे हैं, CamelCasePropertyNamesContractResolver का उपयोग कर रहे हैं, या ऐसा कुछ भी कर रहे हैं जो jnet को .net ऑब्जेक्ट से मेल नहीं खाने का कारण बनेगा।

उपयोग सरल है:

[KnownType(typeof(B))]
public class A
{
   public string Name { get; set; }
}

public class B : A
{
   public string LastName { get; set; }
}

कनवर्टर कोड:

/// <summary>
/// Use KnownType Attribute to match a divierd class based on the class given to the serilaizer
/// Selected class will be the first class to match all properties in the json object.
/// </summary>
public class KnownTypeConverter : JsonConverter {
    public override bool CanConvert( Type objectType ) {
        return System.Attribute.GetCustomAttributes( objectType ).Any( v => v is KnownTypeAttribute );
    }

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

    public override object ReadJson( JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer ) {
        // Load JObject from stream
        JObject jObject = JObject.Load( reader );

        // Create target object based on JObject
        System.Attribute[ ] attrs = System.Attribute.GetCustomAttributes( objectType );  // Reflection. 

        // check known types for a match. 
        foreach( var attr in attrs.OfType<KnownTypeAttribute>( ) ) {
            object target = Activator.CreateInstance( attr.Type );

            JObject jTest;
            using( var writer = new StringWriter( ) ) {
                using( var jsonWriter = new JsonTextWriter( writer ) ) {
                    serializer.Serialize( jsonWriter, target );
                    string json = writer.ToString( );
                    jTest = JObject.Parse( json );
                }
            }

            var jO = this.GetKeys( jObject ).Select( k => k.Key ).ToList( );
            var jT = this.GetKeys( jTest ).Select( k => k.Key ).ToList( );

            if( jO.Count == jT.Count && jO.Intersect( jT ).Count( ) == jO.Count ) {
                serializer.Populate( jObject.CreateReader( ), target );
                return target;
            }
        }

        throw new SerializationException( string.Format( "Could not convert base class {0}", objectType ) );
    }

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

    private IEnumerable<KeyValuePair<string, JToken>> GetKeys( JObject obj ) {
        var list = new List<KeyValuePair<string, JToken>>( );
        foreach( var t in obj ) {
            list.Add( t );
        }
        return list;
    }
}

5

टोटेम के ज्ञात प्रकार के समाधान पर एक और भिन्नता के रूप में, आप अन्य प्रकार की विशेषताओं का उपयोग करने की आवश्यकता से बचने के लिए एक सामान्य प्रकार के रिवाल्वर बनाने के लिए प्रतिबिंब का उपयोग कर सकते हैं।

यह Juval Lowy की GenericResolver के समान तकनीक का उपयोग करता है WCF के लिए ।

जब तक आपका आधार वर्ग सार या इंटरफ़ेस है, तब तक ज्ञात प्रकार स्वचालित रूप से ज्ञात प्रकार की विशेषताओं के साथ सजाए जाने के बजाय निर्धारित होंगे।

अपने स्वयं के मामले में मैंने संपत्ति से इसे निर्धारित करने की कोशिश करने के बजाय अपने जसन ऑब्जेक्ट में टाइप करने के लिए $ प्रकार की संपत्ति का उपयोग करने का विकल्प चुना, हालांकि आप संपत्ति आधारित निर्धारण का उपयोग करने के लिए अन्य समाधानों से उधार ले सकते थे।

 public class JsonKnownTypeConverter : JsonConverter
{
    public IEnumerable<Type> KnownTypes { get; set; }

    public JsonKnownTypeConverter() : this(ReflectTypes())
    {

    }
    public JsonKnownTypeConverter(IEnumerable<Type> knownTypes)
    {
        KnownTypes = knownTypes;
    }

    protected object Create(Type objectType, JObject jObject)
    {
        if (jObject["$type"] != null)
        {
            string typeName = jObject["$type"].ToString();
            return Activator.CreateInstance(KnownTypes.First(x => typeName == x.Name));
        }
        else
        {
            return Activator.CreateInstance(objectType);
        }
        throw new InvalidOperationException("No supported type");
    }

    public override bool CanConvert(Type objectType)
    {
        if (KnownTypes == null)
            return false;

        return (objectType.IsInterface || objectType.IsAbstract) && KnownTypes.Any(objectType.IsAssignableFrom);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // Load JObject from stream
        JObject jObject = JObject.Load(reader);

        // Create target object based on JObject
        var target = Create(objectType, jObject);
        // Populate the object properties
        serializer.Populate(jObject.CreateReader(), target);
        return target;
    }

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

    //Static helpers
    static Assembly CallingAssembly = Assembly.GetCallingAssembly();

    static Type[] ReflectTypes()
    {
        List<Type> types = new List<Type>();
        var referencedAssemblies = Assembly.GetExecutingAssembly().GetReferencedAssemblies();
        foreach (var assemblyName in referencedAssemblies)
        {
            Assembly assembly = Assembly.Load(assemblyName);
            Type[] typesInReferencedAssembly = GetTypes(assembly);
            types.AddRange(typesInReferencedAssembly);
        }

        return types.ToArray();
    }

    static Type[] GetTypes(Assembly assembly, bool publicOnly = true)
    {
        Type[] allTypes = assembly.GetTypes();

        List<Type> types = new List<Type>();

        foreach (Type type in allTypes)
        {
            if (type.IsEnum == false &&
               type.IsInterface == false &&
               type.IsGenericTypeDefinition == false)
            {
                if (publicOnly == true && type.IsPublic == false)
                {
                    if (type.IsNested == false)
                    {
                        continue;
                    }
                    if (type.IsNestedPrivate == true)
                    {
                        continue;
                    }
                }
                types.Add(type);
            }
        }
        return types.ToArray();
    }

फिर इसे एक फॉर्मेटर के रूप में स्थापित किया जा सकता है

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.Converters.Add(new JsonKnownTypeConverter());

1

यहाँ एक और समाधान है जो के उपयोग से बचा जाता है jObject.CreateReader(), और इसके बजाय एक नया बनाता है JsonTextReader(जो कि डिफ़ॉल्ट JsonCreate.Deserialzeविधि द्वारा उपयोग किया जाने वाला व्यवहार है :

public abstract class JsonCreationConverter<T> : JsonConverter
{
    protected abstract T Create(Type objectType, JObject jObject);

    public override bool CanConvert(Type objectType)
    {
        return typeof(T).IsAssignableFrom(objectType);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType == JsonToken.Null)
            return null;

        // Load JObject from stream
        JObject jObject = JObject.Load(reader);

        // Create target object based on JObject
        T target = Create(objectType, jObject);

        // Populate the object properties
        StringWriter writer = new StringWriter();
        serializer.Serialize(writer, jObject);
        using (JsonTextReader newReader = new JsonTextReader(new StringReader(writer.ToString())))
        { 
            newReader.Culture = reader.Culture;
            newReader.DateParseHandling = reader.DateParseHandling;
            newReader.DateTimeZoneHandling = reader.DateTimeZoneHandling;
            newReader.FloatParseHandling = reader.FloatParseHandling;
            serializer.Populate(newReader, target);
        }

        return target;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }
}

1

कई बार कार्यान्वयन इंटरफ़ेस के समान नामस्थान में मौजूद होगा। तो, मैं इस के साथ आया:

    public class InterfaceConverter : JsonConverter
    {
    public override bool CanWrite => false;
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        var token = JToken.ReadFrom(reader);
        var typeVariable = this.GetTypeVariable(token);
        if (TypeExtensions.TryParse(typeVariable, out var implimentation))
        { }
        else if (!typeof(IEnumerable).IsAssignableFrom(objectType))
        {
            implimentation = this.GetImplimentedType(objectType);
        }
        else
        {
            var genericArgumentTypes = objectType.GetGenericArguments();
            var innerType = genericArgumentTypes.FirstOrDefault();
            if (innerType == null)
            {
                implimentation = typeof(IEnumerable);
            }
            else
            {
                Type genericType = null;
                if (token.HasAny())
                {
                    var firstItem = token[0];
                    var genericTypeVariable = this.GetTypeVariable(firstItem);
                    TypeExtensions.TryParse(genericTypeVariable, out genericType);
                }

                genericType = genericType ?? this.GetImplimentedType(innerType);
                implimentation = typeof(IEnumerable<>);
                implimentation = implimentation.MakeGenericType(genericType);
            }
        }

        return JsonConvert.DeserializeObject(token.ToString(), implimentation);
    }

    public override bool CanConvert(Type objectType)
    {
        return !typeof(IEnumerable).IsAssignableFrom(objectType) && objectType.IsInterface || typeof(IEnumerable).IsAssignableFrom(objectType) && objectType.GetGenericArguments().Any(t => t.IsInterface);
    }

    protected Type GetImplimentedType(Type interfaceType)
    {
        if (!interfaceType.IsInterface)
        {
            return interfaceType;
        }

        var implimentationQualifiedName = interfaceType.AssemblyQualifiedName?.Replace(interfaceType.Name, interfaceType.Name.Substring(1));
        return implimentationQualifiedName == null ? interfaceType : Type.GetType(implimentationQualifiedName) ?? interfaceType;
    }

    protected string GetTypeVariable(JToken token)
    {
        if (!token.HasAny())
        {
            return null;
        }

        return token.Type != JTokenType.Object ? null : token.Value<string>("$type");
    }
}

इसलिए, आप इसे विश्व स्तर पर शामिल कर सकते हैं:

public static JsonSerializerSettings StandardSerializerSettings => new JsonSerializerSettings
    {
        Converters = new List<JsonConverter>
        {
            new InterfaceConverter()
        }
    };

1

टोटेम और ज़्लेंग्नेर के विचार का उपयोग करते हुए , मैंने एक KnownTypeConverterऐसा बनाया है जो सबसे उपयुक्त उत्तराधिकारी को निर्धारित करने में सक्षम होगा, जबकि यह ध्यान में रखते हुए कि json डेटा में वैकल्पिक तत्व नहीं हो सकते हैं।

इसलिए, सेवा एक JSON प्रतिक्रिया भेजता है जिसमें दस्तावेज़ों की एक सरणी होती है (आवक और जावक)। दस्तावेजों में तत्वों और अलग-अलग दोनों का एक सामान्य सेट है। इस मामले में, निवर्तमान दस्तावेजों से संबंधित तत्व वैकल्पिक हैं और अनुपस्थित हो सकते हैं।

इस संबंध में, एक आधार वर्ग Documentबनाया गया था जिसमें संपत्तियों का एक सामान्य समूह शामिल है। दो अंतर्निहित वर्ग भी बनाए जाते हैं: - OutgoingDocumentदो वैकल्पिक तत्वों को जोड़ता है "device_id"और "msg_id"; - IncomingDocumentएक अनिवार्य तत्व जोड़ता है "sender_id";

कार्य एक कनवर्टर बनाने के लिए था जो कि नॉटआउट टाइप से डेटा और जानकारी के आधार पर, सबसे उपयुक्त वर्ग को निर्धारित करने में सक्षम होगा जो आपको प्राप्त जानकारी की सबसे बड़ी राशि को बचाने की अनुमति देता है। यह भी ध्यान में रखा जाना चाहिए कि json डेटा में वैकल्पिक तत्व नहीं हो सकते हैं। जोंस तत्वों और डेटा मॉडल के गुणों की तुलना को कम करने के लिए, मैंने बेस क्लास के गुणों को ध्यान में नहीं रखने का फैसला किया है और केवल जीनस तत्वों के साथ संबंध स्थापित किया है।

सेवा से डेटा:

{
    "documents": [
        {
            "document_id": "76b7be75-f4dc-44cd-90d2-0d1959922852",
            "date": "2019-12-10 11:32:49",
            "processed_date": "2019-12-10 11:32:49",
            "sender_id": "9dedee17-e43a-47f1-910e-3a88ff6bc258",
        },
        {
            "document_id": "5044a9ac-0314-4e9a-9e0c-817531120753",
            "date": "2019-12-10 11:32:44",
            "processed_date": "2019-12-10 11:32:44",
        }
    ], 
    "total": 2
}

डेटा मॉडल:

/// <summary>
/// Service response model
/// </summary>
public class DocumentsRequestIdResponse
{
    [JsonProperty("documents")]
    public Document[] Documents { get; set; }

    [JsonProperty("total")]
    public int Total { get; set; }
}

// <summary>
/// Base document
/// </summary>
[JsonConverter(typeof(KnownTypeConverter))]
[KnownType(typeof(OutgoingDocument))]
[KnownType(typeof(IncomingDocument))]
public class Document
{
    [JsonProperty("document_id")]
    public Guid DocumentId { get; set; }

    [JsonProperty("date")]
    public DateTime Date { get; set; }

    [JsonProperty("processed_date")]
    public DateTime ProcessedDate { get; set; } 
}

/// <summary>
/// Outgoing document
/// </summary>
public class OutgoingDocument : Document
{
    // this property is optional and may not be present in the service's json response
    [JsonProperty("device_id")]
    public string DeviceId { get; set; }

    // this property is optional and may not be present in the service's json response
    [JsonProperty("msg_id")]
    public string MsgId { get; set; }
}

/// <summary>
/// Incoming document
/// </summary>
public class IncomingDocument : Document
{
    // this property is mandatory and is always populated by the service
    [JsonProperty("sender_sys_id")]
    public Guid SenderSysId { get; set; }
}

कनवर्टर:

public class KnownTypeConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return System.Attribute.GetCustomAttributes(objectType).Any(v => v is KnownTypeAttribute);
    }

    public override bool CanWrite => false;

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // load the object 
        JObject jObject = JObject.Load(reader);

        // take custom attributes on the type
        Attribute[] attrs = Attribute.GetCustomAttributes(objectType);

        Type mostSuitableType = null;
        int countOfMaxMatchingProperties = -1;

        // take the names of elements from json data
        HashSet<string> jObjectKeys = GetKeys(jObject);

        // take the properties of the parent class (in our case, from the Document class, which is specified in DocumentsRequestIdResponse)
        HashSet<string> objectTypeProps = objectType.GetProperties(BindingFlags.Instance | BindingFlags.Public)
            .Select(p => p.Name)
            .ToHashSet();

        // trying to find the right "KnownType"
        foreach (var attr in attrs.OfType<KnownTypeAttribute>())
        {
            Type knownType = attr.Type;
            if(!objectType.IsAssignableFrom(knownType))
                continue;

            // select properties of the inheritor, except properties from the parent class and properties with "ignore" attributes (in our case JsonIgnoreAttribute and XmlIgnoreAttribute)
            var notIgnoreProps = knownType.GetProperties(BindingFlags.Instance | BindingFlags.Public)
                .Where(p => !objectTypeProps.Contains(p.Name)
                            && p.CustomAttributes.All(a => a.AttributeType != typeof(JsonIgnoreAttribute) && a.AttributeType != typeof(System.Xml.Serialization.XmlIgnoreAttribute)));

            //  get serializable property names
            var jsonNameFields = notIgnoreProps.Select(prop =>
            {
                string jsonFieldName = null;
                CustomAttributeData jsonPropertyAttribute = prop.CustomAttributes.FirstOrDefault(a => a.AttributeType == typeof(JsonPropertyAttribute));
                if (jsonPropertyAttribute != null)
                {
                    // take the name of the json element from the attribute constructor
                    CustomAttributeTypedArgument argument = jsonPropertyAttribute.ConstructorArguments.FirstOrDefault();
                    if(argument != null && argument.ArgumentType == typeof(string) && !string.IsNullOrEmpty((string)argument.Value))
                        jsonFieldName = (string)argument.Value;
                }
                // otherwise, take the name of the property
                if (string.IsNullOrEmpty(jsonFieldName))
                {
                    jsonFieldName = prop.Name;
                }

                return jsonFieldName;
            });


            HashSet<string> jKnownTypeKeys = new HashSet<string>(jsonNameFields);

            // by intersecting the sets of names we determine the most suitable inheritor
            int count = jObjectKeys.Intersect(jKnownTypeKeys).Count();

            if (count == jKnownTypeKeys.Count)
            {
                mostSuitableType = knownType;
                break;
            }

            if (count > countOfMaxMatchingProperties)
            {
                countOfMaxMatchingProperties = count;
                mostSuitableType = knownType;
            }
        }

        if (mostSuitableType != null)
        {
            object target = Activator.CreateInstance(mostSuitableType);
            using (JsonReader jObjectReader = CopyReaderForObject(reader, jObject))
            {
                serializer.Populate(jObjectReader, target);
            }
            return target;
        }

        throw new SerializationException($"Could not serialize to KnownTypes and assign to base class {objectType} reference");
    }

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

    private HashSet<string> GetKeys(JObject obj)
    {
        return new HashSet<string>(((IEnumerable<KeyValuePair<string, JToken>>) obj).Select(k => k.Key));
    }

    public static JsonReader CopyReaderForObject(JsonReader reader, JObject jObject)
    {
        JsonReader jObjectReader = jObject.CreateReader();
        jObjectReader.Culture = reader.Culture;
        jObjectReader.DateFormatString = reader.DateFormatString;
        jObjectReader.DateParseHandling = reader.DateParseHandling;
        jObjectReader.DateTimeZoneHandling = reader.DateTimeZoneHandling;
        jObjectReader.FloatParseHandling = reader.FloatParseHandling;
        jObjectReader.MaxDepth = reader.MaxDepth;
        jObjectReader.SupportMultipleContent = reader.SupportMultipleContent;
        return jObjectReader;
    }
}

पुनश्च: मेरे मामले में, अगर कोई भी इनहेरिटर कन्वर्टर द्वारा नहीं चुना गया है (यह तब हो सकता है यदि JSON डेटा में केवल बेस क्लास से जानकारी हो या JSON डेटा में वैकल्पिक तत्व शामिल न हों OutgoingDocument), तो OutgoingDocumentक्लास का एक ऑब्जेक्ट बनाया जाएगा, क्योंकि यह पहले KnownTypeAttributeविशेषताओं की सूची में सूचीबद्ध है । आपके अनुरोध पर, आप KnownTypeConverterइस स्थिति में कार्यान्वयन को भिन्न कर सकते हैं ।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.