How to store JSON in an entity field with EF Core?

by

Going to answer this one differently.

Ideally the domain model should have no idea how data is stored. Adding backing fields and extra [NotMapped] properties is actually coupling your domain model to your infrastructure.

Remember – your domain is king, and not the database. The database is just being used to store parts of your domain.

Instead you can use EF Core’s HasConversion() method on the EntityTypeBuilder object to convert between your type and JSON.

Given these 2 domain models:

public class Person
{
    public int Id { get; set; }

    [Required]
    [MaxLength(50)]
    public string FirstName { get; set; }

    [Required]
    [MaxLength(50)]
    public string LastName { get; set; }

    [Required]
    public DateTime DateOfBirth { get; set; }

    public IList<Address> Addresses { get; set; }      
}

public class Address
{
    public string Type { get; set; }
    public string Company { get; set; }
    public string Number { get; set; }
    public string Street { get; set; }
    public string City { get; set; }
}

I have only added attributes that the domain is interested in – and not details that the DB would be interested in; I.E there is no [Key].

My DbContext has the following IEntityTypeConfiguration for the Person:

public class PersonsConfiguration : IEntityTypeConfiguration<Person>
{
    public void Configure(EntityTypeBuilder<Person> builder)
    {
        // This Converter will perform the conversion to and from Json to the desired type
        builder.Property(e => e.Addresses).HasConversion(
            v => JsonConvert.SerializeObject(v, new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore }),
            v => JsonConvert.DeserializeObject<IList<Address>>(v, new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore }));
    }
}

With this method you can completely decouple your domain from your infrastructure. No need for all the backing field & extra properties.

More Related Contents:

  1. Does Json.NET cache types’ serialization information?
  2. Json.Net Serialization of Type with Polymorphic Child Object
  3. Using JsonConvert.DeserializeObject to deserialize Json to a C# POCO class
  4. How to write a JSON file in C#?
  5. JSON.Net: Force serialization of all private fields and all fields in sub-classes
  6. Parse Json string in C#
  7. Not ableTo Serialize Dictionary with Complex key using Json.net
  8. How to tell Json.Net globally to apply the StringEnumConverter to all enums
  9. How can I serialize/deserialize a dictionary with custom keys using Json.Net?
  10. What is the difference between PreserveReferencesHandling and ReferenceLoopHandling in Json.Net?
  11. How to call JsonConvert.DeserializeObject and disable a JsonConverter applied to a base type via [JsonConverter]?
  12. JSON.Net Self referencing loop detected
  13. Newtonsoft JSON dynamic property name
  14. JsonSerializerSettings and Asp.Net Core
  15. Filter all queries (trying to achieve soft delete)
  16. Newtonsoft JSON.net deserialization error where fields in JSON change order
  17. Can Newtonsoft Json.NET skip serializing empty lists?
  18. The entity type ‘Microsoft.AspNet.Identity.EntityFramework.IdentityUserLogin’ requires a key to be defined
  19. Serialize as NDJSON using Json.NET
  20. JSON serialize properties on class inheriting list [duplicate]
  21. Cascade deleting with EF Core
  22. Find and return JSON differences using newtonsoft in C#?
  23. How do I change the default Type for Numeric deserialization?
  24. Ignoring null fields in Json.net
  25. How can I tell Json.NET to ignore properties in a 3rd-party object?
  26. Entity Framework Core: Guid Greater Than for Paging
  27. Deserialize array of key value pairs using Json.NET
  28. Json.net serialize numeric properties as string
  29. Using Custom WCF Body Deserialization without changing URI Template Deserialization
  30. Json.Net PopulateObject – update list elements based on ID

Leave a Comment