การใช้แนวคิดของtotemและzlangnerฉันได้สร้างสิ่งKnownTypeConverter
ที่จะสามารถกำหนดผู้สืบทอดที่เหมาะสมที่สุดในขณะที่คำนึงถึงว่าข้อมูล json อาจไม่มีองค์ประกอบที่เป็นตัวเลือก
ดังนั้นบริการส่งการตอบสนอง JSON ที่มีอาร์เรย์ของเอกสาร (ขาเข้าและขาออก) เอกสารมีทั้งชุดองค์ประกอบทั่วไปและอีกชุด ในกรณีนี้องค์ประกอบที่เกี่ยวข้องกับเอกสารขาออกเป็นตัวเลือกและอาจขาด
ในเรื่องนี้คลาสพื้นฐานDocument
ถูกสร้างขึ้นซึ่งมีชุดคุณสมบัติทั่วไป มีการสร้างคลาสผู้สืบทอดสองคลาสด้วย: - OutgoingDocument
เพิ่มองค์ประกอบเพิ่มเติมสองตัวเลือก"device_id"
และ"msg_id"
; - IncomingDocument
เพิ่มองค์ประกอบหนึ่งที่จำเป็น"sender_id"
;
ภารกิจคือการสร้างตัวแปลงที่ขึ้นอยู่กับข้อมูล json และข้อมูลจาก KnownTypeAttribute จะสามารถกำหนดคลาสที่เหมาะสมที่สุดที่ช่วยให้คุณสามารถบันทึกข้อมูลจำนวนมากที่สุดที่ได้รับ ควรพิจารณาว่าข้อมูล json อาจไม่มีองค์ประกอบเสริม เพื่อลดจำนวนการเปรียบเทียบองค์ประกอบ json และคุณสมบัติของตัวแบบข้อมูลฉันตัดสินใจไม่คำนึงถึงคุณสมบัติของคลาสพื้นฐานและสัมพันธ์กับองค์ประกอบ 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; }
}
Converter:
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;
}
}
PS: ในกรณีของฉันถ้าไม่มีผู้สืบทอดไม่ได้ถูกเลือกโดยตัวแปลง (สิ่งนี้สามารถเกิดขึ้นได้หากข้อมูล JSON มีข้อมูลจากคลาสฐานเท่านั้นหรือข้อมูล JSON ไม่มีองค์ประกอบที่เป็นตัวเลือกจากOutgoingDocument
) ดังนั้นวัตถุของOutgoingDocument
คลาส จะถูกสร้างขึ้นเนื่องจากมีการระบุไว้เป็นอันดับแรกในรายการKnownTypeAttribute
แอตทริบิวต์ ตามคำขอของคุณคุณสามารถเปลี่ยนแปลงการใช้งานKnownTypeConverter
ในสถานการณ์นี้ได้