How to serialize an object using it parents Interfaces? - serialization

Question

Using c# 8. I have a set of base Interfaces with default implementation:
public interface IEventBase
{
string PostRoutingKey { get; set; }
string EventSource => Assembly.GetEntryAssembly()?.GetName().Name;
long Timestamp => DateTimeOffset.UtcNow.ToUnixTimeSeconds();
Guid EventId => Guid.NewGuid();
string EventKey { get; set; }
}
public interface IActionNotifiable : IEventBase
{
[JsonProperty(Required = Required.Always)]
string SenderName { get; set; }
[JsonProperty(Required = Required.Always)]
string ReceiverName { get; set; }
[JsonProperty(Required = Required.Always)]
string SenderId { get; set; }
[JsonProperty(Required = Required.Always)]
string ReceiverId { get; set; }
string Title { get; set; }
string ShortDescription { get; set; }
string LongDescription { get; set; }
ActionNotifiableStatusEnum Status { get; set; }
Dictionary<string, string> ExtraProperties { get; set; }
}
public interface IPush : IActionNotifiable
{
[JsonProperty(Required = Required.Always)]
public string CallbackUrl { get; set; }
}
public class DerivedConcretePush : IPush
{
public string PostRoutingKey { get; set; }= string.Empty;
public string EventKey { get; set; }= string.Empty;
public string SenderName { get; set; }= string.Empty;
public string ReceiverName { get; set; }= string.Empty;
public string SenderId { get; set; }= string.Empty;
public string ReceiverId { get; set; }= string.Empty;
public string Title { get; set; }= string.Empty;
public string ShortDescription { get; set; }= string.Empty;
public string LongDescription { get; set; }= string.Empty;
public ActionNotifiableStatusEnum Status { get; set; }
public Dictionary<string, string> ExtraProperties { get; set; } = new Dictionary<string, string>();
public string CallbackUrl { get; set; }= string.Empty;
}
And trying to Serialize the object using the SerilizeObject from https://www.newtonsoft.com/json, doing something like this:
var message = JsonConvert.SerializeObject(#event, JsonConvertExtension.GetCamelCaseSettings());
and my JsonSettings looks like this:
public static JsonSerializerSettings GetCamelCaseSettings()
{
return new JsonSerializerSettings
{
ContractResolver = new DefaultContractResolver
{
NamingStrategy = new CamelCaseNamingStrategy()
},
Formatting = Formatting.Indented,
TypeNameHandling = TypeNameHandling.Auto
};
}
I get something like this:
{
"postRoutingKey": "",
"eventKey": "sericy-rabbiteventconsumer-cli.DerivedConcretePush",
"senderName": "",
"receiverName": "",
"senderId": "",
"receiverId": "",
"title": "just a tittle",
"shortDescription": "",
"longDescription": "body",
"status": 0,
"extraProperties": {},
"callbackUrl": ""
}
I had tried playing around with TypeNameHandling and passing the IEventBase type to SerializeObject.
What is the best way to serialize the object including all the Interface properties?

Answer 1

I end up creating a custom contract resolver:
public class InterfaceContractResolver : DefaultContractResolver
{
private readonly Type[] _interfaceTypes;
private readonly ConcurrentDictionary<Type, Type> _typeToSerializeMap;
public InterfaceContractResolver(params Type[] interfaceTypes)
{
_interfaceTypes = interfaceTypes;
_typeToSerializeMap = new ConcurrentDictionary<Type, Type>();
NamingStrategy = new CamelCaseNamingStrategy();
}
protected override IList<JsonProperty> CreateProperties(
Type type,
MemberSerialization memberSerialization)
{
var typeToSerialize = _typeToSerializeMap.GetOrAdd(
type,
t => _interfaceTypes.FirstOrDefault(
it => it.IsAssignableFrom(t)) ?? t);
var props = base.CreateProperties(typeToSerialize, memberSerialization);
// mark all props as not ignored
foreach (var prop in props)
{
prop.Ignored = false;
}
return props;
}
}
internal static class JsonConvertExtension
{ {
public static JsonSerializerSettings GetCamelCaseSettings() public static JsonSerializerSettings SetupJsonSerializerSettings(Type eventType)
{ {
var eventTypes = eventType.GetParentTypes().ToArray();
return new JsonSerializerSettings return new JsonSerializerSettings
{ {
ContractResolver = new DefaultContractResolver ContractResolver = new InterfaceContractResolver(eventTypes),
{ Formatting = Formatting.Indented,
NamingStrategy = new CamelCaseNamingStrategy() TypeNameHandling = TypeNameHandling.Auto,
},
Formatting = Formatting.Indented
}; };
And calling it using the type:
var message = JsonConvert.SerializeObject(#event, JsonConvertExtension.SetupJsonSerializerSettings(#event.GetType()));