Skip to main content

Fluent mapping approach for EF Core

With the first release of EF Core, there wasn't any proper approach of fluent mapping of entities, in an easy manner for enterprises application where a lot of entities needs to be involved. You might have ended up with nasty or repeated codes.

At that time only way was to compose mapping based on ModelBuilder and by using inline fluent mapping codes. Like in newer version EF Core 2.0 there had been a new release of IEntityTypeConfiguration for the creation of mapping based on single entity and could be registered with ApplyConfiguration by passing a new instance of IEntityTypeConfiguration object. https://docs.microsoft.com/en-us/ef/core/what-is-new (Self-contained type configuration for code first)
This is really good for big application as we can separate mappings based on each entity.

In this article, we would see how to achieve similar functionality in EF Core 1.0 and this implementation is a bit cleaner than 2.0 built-in classes. So, in both of versions, this could be used with minimum effort.

Steps/approach taken to achieve same.


  1. A base class which would have certain constraints and common functionality to take care of certain mappings.
  2. Sample mapping class based on base class for actual fluent mapping implementations.
  3. Application level fluent mapping with a helper method to create mappings generically by passing entity and associated mapping class.
  4. Registration of fluent mappings in application DbContext class by just creating an object of global fluent mapping.

Base class implementation for each Fluent mapping classes

I like to have schema name for each table so I have included parameterized constructor for accepting model name and schema name.

The other optional element I have included is to have common Primary Key Name with Identity field based on interface IPrimaryKey<int>. This allows me to have the same name for all Primary Keys and common mapping codes so that I do not have to repeat all over again.
NOTE:  This is optional you can remove InitPrimaryKey function if you do not need.

 /// <summary>  
 /// Entity builder base class for fluent mapping.  
 /// </summary>  
 /// <typeparam name="TModel">The type of the model.</typeparam>  
 internal abstract class EntityTypeBuilderBase<TModel>  
   where TModel : class  
 {  
   /// <summary>  
   /// The model name  
   /// </summary>  
   private readonly string ModelName;  
   /// <summary>  
   /// The model schema  
   /// </summary>  
   private readonly string ModelSchema;  
   /// <summary>  
   /// Initializes a new instance of the <see cref="EntityTypeBuilderBase{TModel}"/> class.  
   /// </summary>  
   /// <param name="modelName">Name of the model.</param>  
   /// <param name="modelSchema">The model schema.</param>  
   /// <exception cref="ArgumentNullException">  
   /// modelName  
   /// or  
   /// modelName  
   /// </exception>  
   protected EntityTypeBuilderBase(string modelName, string modelSchema)  
   {  
     if (IsNullOrEmpty(modelName))  
     {  
       throw new ArgumentNullException(nameof(modelName));  
     }  
     if (IsNullOrEmpty(modelSchema))  
     {  
       throw new ArgumentNullException(nameof(modelName));  
     }  
     ModelName = modelName;  
     ModelSchema = modelSchema;  
   }  
   /// <summary>  
   /// Initializes the specified builder.  
   /// </summary>  
   /// <param name="builder">The builder.</param>  
   public void Init(EntityTypeBuilder<TModel> builder)  
   {  
     InitPrimaryKey(builder);  
     builder.ToTable(ModelName, ModelSchema);  
   }  
   /// <summary>  
   /// Fluent mapping for the model.  
   /// </summary>  
   /// <param name="builder">The entity DB builder.</param>  
   public abstract void Map(EntityTypeBuilder<TModel> builder);  
   /// <summary>  
   /// Initializes the primary key.  
   /// </summary>  
   /// <param name="entityTypeBuilder">The entity type builder.</param>  
   private static void InitPrimaryKey(EntityTypeBuilder<TModel> entityTypeBuilder)  
   {  
     var primaryKeyBuilder = entityTypeBuilder as EntityTypeBuilder<IPrimaryKey<int>>;  
     if (primaryKeyBuilder != null)  
     {  
       primaryKeyBuilder.HasKey(m => m.Id);  
       primaryKeyBuilder.Property(m => m.Id).ValueGeneratedOnAdd();  
     }  
   }  
 }

The Map abstract function is important since this is going to be used in each Fluent Mapping classes.

Sample entity mapping class

Suppose we have an entity called LookupCountry. The fluent mapping based on sample model.

 /// <summary>  
 /// Fluent mapping for <see cref="LookupCountry"/> entity.  
 /// </summary>  
 /// <seealso cref="EntityTypeBuilderBase{Country}" />  
 internal class LookupCountryMapping  
   : EntityTypeBuilderBase<LookupCountry>  
 {  
   /// <summary>  
   /// Initializes a new instance of the <see cref="LookupCountryMapping"/> class.  
   /// </summary>  
   public LookupCountryMapping()  
     : base("Country", "Lookup")  
   {  
   }  
   /// <summary>  
   /// Fluent mapping for the model.  
   /// </summary>  
   /// <param name="builder">The entity DB builder.</param>  
   public override void Map(EntityTypeBuilder<LookupCountry> builder)  
   {  
     builder.Property(model => model.Code).HasMaxLength(2);  
     builder.Property(model => model.IsDisabled);  
     builder.Property(model => model.Name).HasMaxLength(255);  
   }  
 }

In this, it is inherited from base class EntityTypeBuilderBase<LookupCountry> having constructor accepting table name and schema.
The overridden Map function is available to put fluent mapping. Since I have used my custom interface for Id mapping and it is being mapped on the base class, I have not put fluent mapping for same. Like I mentioned earlier this could be skipped, just that you have to put fluent mapping for primary key manually in that situation.

Application level FluentMapping class implementation

This class is the beholder of all fluent mappings for the entire application also it allows registering mappings in an easier manner. Let's first see the code then will have a look on explanation.

   /// <summary>  
   /// Fluent Mapping for the application.  
   /// </summary>  
   internal class FluentMapping  
   {  
     /// <summary>  
     /// The model builder  
     /// </summary>  
     private readonly ModelBuilder ModelBuilder;  
     /// <summary>  
     /// Initializes a new instance of the <see cref="FluentMapping"/> class.  
     /// </summary>  
     /// <param name="builder">The database model builder.</param>  
     internal FluentMapping(ModelBuilder builder)  
     {  
       ModelBuilder = builder;  
     }  
     /// <summary>  
     /// Fluent mapping for entire application.  
     /// </summary>  
     internal void Map()  
     {  
       BuildMap<LookupCountry, LookupCountryMapping>(ModelBuilder);  
     }  
     /// <summary>  
     /// Builds the DB model mapping.  
     /// </summary>  
     /// <typeparam name="TModel">The type of the model.</typeparam>  
     /// <typeparam name="TMapper">The type of the mapper.</typeparam>  
     /// <param name="dbModelBuilder">The database model builder.</param>  
     private static void BuildMap<TModel, TMapper>(ModelBuilder dbModelBuilder)  
       where TModel : class  
       where TMapper : EntityTypeBuilderBase<TModel>, new()  
     {  
       var map = new TMapper();  
       var builder = dbModelBuilder.Entity<TModel>();  
       map.Init(builder);  
       map.Map(builder);  
     }  
   }

The key highlights here are Map and BuildMap functions.

The BuildMap function is to create fluent mapping for entities with constraints like it has to be parameterless constructor class and inherited from EntityTypeBuilderBase class. This would allow to us to create a new object of mapper through Generic approach and call methods Init and Map from a base class in a convenient way for mapping.

The internal does not matter since we just need to add a mapping of an entity with related Mapper class in Map function.

 BuildMap<LookupCountry, LookupCountryMapping>(ModelBuilder);

It just says entity and Mapping class with ModelBuilder. Simple enough!

Registration of entire application fluent mapping on DbContext

This is a really straight forward implementation which does not need any explanation. Just need to create an object of FluentMapping class under OnModelCreating function.

 public sealed class MyProjectContext  
   : DbContext  
 {  
   public MyProjectContext(DbContextOptions option)  
     : base(option)  
   {  
   }  
   protected override void OnModelCreating(ModelBuilder builder)  
   {  
     var mapping = new FluentMapping.FluentMapping(builder);  
     mapping.Map();  
   }  
 }


Bonus material: Code Snippet for creating fluent mapping and registration code for same

If you have come so far, I have some bonus materials for composing FluentMapping class and registration of same (BuildMap code) through Visual Studio 20XX Snippet feature.

Please add these two files into Code Snippet Manager from VS 20XX.

FluentMapping.snippet

 <?xml version="1.0" encoding="utf-8"?>   
 <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">   
  <CodeSnippet Format="1.0.0">   
   <Header>   
    <Title>Add A Fluent Mapping</Title>   
    <Author>Vikash Kumar</Author>   
    <Description>Fluent mapping structure.</Description>   
    <Shortcut>FluentMapping</Shortcut>   
   </Header>   
   <Snippet>   
    <Imports>   
     <Import>   
      <Namespace>MyProject.DB.FluentMapping.Base</Namespace>   
     </Import>   
           <Import>   
      <Namespace>Microsoft.EntityFrameworkCore.Metadata.Builders</Namespace>   
     </Import>   
    </Imports>   
    <Declarations>   
     <Literal>   
      <ID>modelname</ID>   
      <ToolTip>Replace with data model name</ToolTip>   
      <Default>MyModel</Default>   
     </Literal>  
    </Declarations>   
    <Code Language="CSharp">   
     <![CDATA[   
 /// <summary>  
 /// Fluent mapping for <see cref="$modelname$"/> entity.  
 /// </summary>  
 /// <seealso cref="EntityTypeBuilderBase{$modelname$}" />       
 internal class $modelname$Mapping  
      : EntityTypeBuilderBase<$modelname$>  
 {  
      /// <summary>  
      /// Initializes a new instance of the <see cref="$modelname$Mapping"/> class.  
      /// </summary>  
      public $modelname$Mapping()  
           : base(nameof($modelname$), Schema.Name)  
      {  
      }  
      /// <summary>  
      /// Fluent mapping for the model.  
      /// </summary>  
      /// <param name="builder">The entity DB builder.</param>  
      public override void Map(EntityTypeBuilder<$modelname$> builder)  
      {  
      }  
 }   
 ]]>   
    </Code>   
   </Snippet>   
  </CodeSnippet>   
 </CodeSnippets>


FluentRegistration.snippet

 <?xml version="1.0" encoding="utf-8" ?>  
 <CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
      <CodeSnippet Format="1.0.0">  
   <Header>   
    <Title>Fluent Mapping registration</Title>   
    <Author>Vikash Kumar</Author>   
    <Description>Fluent mapping registration.</Description>   
    <Shortcut>FluentMappingRegistration</Shortcut>   
   </Header>   
           <Snippet>  
                <Declarations>  
                     <Literal>  
                          <ID>model</ID>  
                          <ToolTip>Model to map</ToolTip>  
                          <Default>MyModel</Default>  
                     </Literal>  
                     <Literal>  
                          <ID>param</ID>  
                          <ToolTip>Model Builder Parameter.</ToolTip>  
                          <Default>ModelBuilder</Default>  
                     </Literal>  
                </Declarations>  
                <Code Language="csharp"><![CDATA[BuildMap<$model$, $model$Mapping>($param$);$end$]]>  
                </Code>  
           </Snippet>  
      </CodeSnippet>  
 </CodeSnippets>





Labels:

Comments

Post a Comment

Popular posts from this blog

Making FluentValidation compatible with Swagger including Enum or fixed List support

FluentValidation is not directly compatible with Swagger API to validate models. But they do provide an interface through which we can compose Swagger validation manually. That means we look under FluentValidation validators and compose Swagger validator properties to make it compatible. More of all mapping by reading information from FluentValidation and setting it to Swagger Model Schema. These can be done on any custom validation from FluentValidation too just that proper schema property has to be available from Swagger. Custom validation from Enum/List values on FluentValidation using FluentValidation.Validators; using System.Collections.Generic; using System.Linq; using static System.String; /// <summary> /// Validator as per list of items. /// </summary> /// <seealso cref="PropertyValidator" /> public class FixedListValidator : PropertyValidator { /// <summary> /// Gets the valid items /// <...
1 comment
Read more

Elegantly dealing with TimeZones in MVC Core / WebApi

In any new application handling TimeZone/DateTime is mostly least priority and generally, if someone is concerned then it would be handled by using DateTime.UtcNow on codes while creating current dates and converting incoming Date to UTC to save on servers. Basically, the process is followed by saving DateTime to UTC format in a database and keep converting data to native format based on user region or single region in the application's presentation layer. The above is tedious work and have to be followed religiously. If any developer misses out the manual conversion, then that area of code/view would not work. With newer frameworks, there are flexible ways to deal/intercept incoming or outgoing calls to simplify conversion of TimeZones. These are steps/process to achieve it. 1. Central code for storing user's state about TimeZone. Also, central code for conversion logic based on TimeZones. 2. Dependency injection for the above class to ...
4 comments
Read more

Handling JSON DateTime format on Asp.Net Core

This is a very simple trick to handle JSON date format on AspNet Core by global settings. This can be applicable for the older version as well. In a newer version by default, .Net depends upon Newtonsoft to process any JSON data. Newtonsoft depends upon Newtonsoft.Json.Converters.IsoDateTimeConverter class for processing date which in turns adds timezone for JSON data format. There is a global setting available for same that can be adjusted according to requirement. So, for example, we want to set default formatting to US format, we just need this code. services.AddMvc() .AddJsonOptions(options => { options.SerializerSettings.DateTimeZoneHandling = "MM/dd/yyyy HH:mm:ss"; });
1 comment
Read more

Storing and restoring Kendo Grid state from Database

There is no any built in way to store entire grid state into database and restore back again with all filters, groups, aggregates, page and page size. At first, I was trying to restore only filters by looking through DataSourceRequest. DataSourceRequest is kind of communication medium between client and server for the operation we do on grid. All the request comes via DataSourceRequest. In previous approach, I was trying to store IFileDescriptor interface which come with class FileDescriptor by looping through filters and serializing into string for saving into database but this IFileDescriptor can also contain CompositeFilterDescriptor which can be nested in nested object which are very tricky to handle. So, I had decompiled entire Kendo.MVC library and found out that all Kendo MVC controls are derived from “JsonObject”. It is there own implementation with ”Serialize” abstract function and “ToJson” function. In controls they are overriding “Serialize” method which depicts t...
Post a Comment
Read more

Trim text in MVC Core through Model Binder

Trimming text can be done on client side codes, but I believe it is most suitable on MVC Model Binder since it would be at one place on infrastructure level which would be free from any manual intervention of developer. This would allow every post request to be processed and converted to a trimmed string. Let us start by creating Model binder using Microsoft.AspNetCore.Mvc.ModelBinding; using System; using System.Threading.Tasks; public class TrimmingModelBinder : IModelBinder { private readonly IModelBinder FallbackBinder; public TrimmingModelBinder(IModelBinder fallbackBinder) { FallbackBinder = fallbackBinder ?? throw new ArgumentNullException(nameof(fallbackBinder)); } public Task BindModelAsync(ModelBindingContext bindingContext) { if (bindingContext == null) { throw new ArgumentNullException(nameof(bindingContext)); } var valueProviderResult = bindingContext.ValueProvider.GetValue(bin...
1 comment
Read more

LDAP with ASP.Net Identity Core in MVC with project.json

Lightweight Directory Access Protocol (LDAP), the name itself explain it. An application protocol used over an IP network to access the distributed directory information service. The first and foremost thing is to add references for consuming LDAP. This has to be done by adding reference from Global Assembly Cache (GAC) into project.json "frameworks": { "net461": { "frameworkAssemblies": { "System.DirectoryServices": "4.0.0.0", "System.DirectoryServices.AccountManagement": "4.0.0.0" } } }, These  System.DirectoryServices  and  System.DirectoryServices.AccountManagement  references are used to consume LDAP functionality. It is always better to have an abstraction for irrelevant items in consuming part. For an example, the application does not need to know about PrincipalContext or any other dependent items from those two references to make it extensible. So, we can begin wi...
Post a Comment
Read more

Configuring Ninject, Asp.Net Identity UserManager, DataProtectorTokenProvider with Owin

It can be bit tricky to configure both Ninject and Asp.Net Identity UserManager if some value is expected from DI to configure UserManager. We will look into configuring both and also use OwinContext to get UserManager. As usual, all configuration need to be done on Startup.cs. It is just a convention but can be used with different name, the important thing is to decorate class with following attribute to make it Owin start-up: [assembly: OwinStartup(typeof(MyProject.Web.Startup))] Ninject configuration Configuring Ninject kernel through method which would be used to register under Owin. Startup.cs public IKernel CreateKernel() { var kernel = new StandardKernel(); try { //kernel.Bind<IHttpModule>().To<HttpApplicationInitializationHttpModule>(); // TODO: Put any other injection which are required. return kernel; } catch { kernel.Dispose(); thro...
Post a Comment
Read more

Data seed for the application with EF, MongoDB or any other ORM.

Most of ORMs has moved to Code first approach where everything is derived/initialized from codes rather than DB side. In this situation, it is better to set data through codes only. We would be looking through simple technique where we would be Seeding data through Codes. I would be using UnitOfWork and Repository pattern for implementing Data Seeding technique. This can be applied to any data source MongoDB, EF, or any other ORM or DB. Things we would be doing. - Creating a base class for easy usage. - Interface for Seed function for any future enhancements. - Individual seed classes. - Configuration to call all seeds. - AspNet core configuration to Seed data through Seed configuration. Creating a base class for easy usage public abstract class BaseSeed<TModel> where TModel : class { protected readonly IMyProjectUnitOfWork MyProjectUnitOfWork; public BaseSeed(IMyProjectUnitOfWork MyProjectUnitOfWork) { ...
Post a Comment
Read more

A wrapper implementation for Kendo Grid usage

A wrapper implementation for any heavily used item is always a good practice. Whatever is not written by us and used at a lot of places should be wrapped within specific functionality to keep it future proof and easily changeable. This also encourages DRY principle to keep our common setting at a central place. Kendo UI items are enormous in configuration, one of an issue I find people keep repeating codes for Kendo Grid configuration. They have built very flexible system to have any configuration, but in most of the cases, we do not need all of those complicated configuration. We would try to see a simpler configuration of same. The actual core implementation is bit complex, but we do not have to bother about it once done since the focus is just on usage only. I recommend doing this practice for as simple as jQuery events, form handling or as simple as any notification system. This just won't make things simple but makes codes much more manageable, easy understand, read or open f...
Post a Comment
Read more

Using Redis distributed cache in dotnet core with helper extension methods

Redis cache is out process cache provider for a distributed environment. It is popular in Azure Cloud solution, but it also has a standalone application to operate upon in case of small enterprises application. How to install Redis Cache on a local machine? Redis can be used as a local cache server too on our local machines. At first install, Chocolatey https://chocolatey.org/ , to make installation of Redis easy. Also, the version under Chocolatey supports more commands and compatible with Official Cache package from Microsoft. After Chocolatey installation hit choco install redis-64 . Once the installation is done, we can start the server by running redis-server . Distributed Cache package and registration dotnet core provides IDistributedCache interface which can be overrided with our own implementation. That is one of the beauties of dotnet core, having DI implementation at heart of framework. There is already nuget package available to override IDistributedCache i...
3 comments
Read more