How do I use a Custom JSON.NET Converter in RavenDB to deserialize into types from a dynamic DLL?

Question

My RavenDB objects are created from types in a DLL that is loaded dynamically. I cannot load the DLL into the execution context of the current AppDomain, so the JSON deserializer can't find the types.

How would I use a Custom Converter to use the types in my loaded-at-runtime Assembly?

NB I tried serving the DLL from another domain via the AppDomain but that caused conflicts later. Although it solved the problem in that question, I now need to make sure that all of my objects are created from types in the dynamically loaded Assembly.

Can you provide a self-contained example program which demonstrates the problem? — Brian Rogers, Sep 19 '13 at 19:20
Hi Brian, the self-contained program is huge because I am using Roslyn to generate the DLLs. — Dr Rob Lang, Sep 27 '13 at 10:31

score 2 · Accepted Answer · answered Sep 27 '13 at 10:40

Where you want to specify the Assembly to generate the types, this is how you create a custom converter. All of my custom types derive from IEntity. You need to do this so that the deserializer knows when hook into your custom class.

public class DynamicAssemblyJsonConverter : JsonConverter
{
    private Assembly dynamicAssembly = null;

    public DynamicAssemblyJsonConverter(Assembly dynamicAssembly)
    {
        this.dynamicAssembly = dynamicAssembly;
    }

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

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

        var typeName = jObject["$type"].Value<string>().Split(',')[0];

        var target = dynamicAssembly.CreateInstance(typeName);

        serializer.Populate(jObject.CreateReader(), target);

        return target;
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType is IEntity;
    }
}

If you are using RavenDB (like I am), create this CustomConverter and then apply it to Raven before you query or load by assigning it to: Conventions.CustomizeJsonSerializer.

score 0 · Answer 2 · answered Apr 14 '15 at 19:50

Rob's answer works great. However if you need to resolve "$ref" in your converter, you should add:

JToken reference = parser["$ref"];
if (reference != null)
{
    string id = reference.Value<string>();
    result = serializer.ReferenceResolver.ResolveReference(serializer, id);
}

How do I use a Custom JSON.NET Converter in RavenDB to deserialize into types from a dynamic DLL?

2 Answers2

Linked