Skip to main content

Unit Of Work injection through Asp.Net Core Dependency Injection

This article is not directly related to UnitOfWork but leveraging Asp.Net Core Dependency Injection to consume Unit Of Work.

In one of the previous article about project architecture, I was not very satisfied with the approach for Unit Of Work implementation for initialization of repository even if with some advantage.

Here is old code for UnitOfWork.

  public sealed partial class MyProjectUnitOfWork   
    : UnitOfWork<DbContext>, IMyProjectUnitOfWork   
   {   
    public MyProjectUnitOfWork(IContextFactory<DbContext> contextFactory)   
     : base(contextFactory)   
    {   
    }   
    /// <summary>   
    /// BookRepository holder   
    /// </summary>   
    private MyProject.DB.Repository.BookRepository _bookRepository;   
    /// <summary>   
    /// Gets the BookRepository repository.   
    /// </summary>   
    /// <value>   
    /// The BookRepository repository.   
    /// </value>   
    MyProject.Interface.Repository.IBookRepository IMyProjectUnitOfWork.BookRepository   
    {   
     get   
     {   
      return _bookRepository =   
      _bookRepository ?? new MyProject.DB.Repository.BookRepository(Context);   
     }   
    }   
   }

The major reason for dissatisfaction was due to direct initialization of those repositories. Even if it lazy initialization and globally at one place but still the direct dependency.

So, what changed in the Asp.Net Core DI that in the earlier code I have not accommodated. Actually it does not change, in fact, the DIs libraries are more feature rich in comparison of Asp.Net Core DI. The only good thing is we would not generally depend on any third party libraries since there is built in the library available with Framework itself. So, this gives freedom to use DI related codes on dependent projects without much worrying about that DI framework could change in future.

After keeping this in mind what all need to be changed:

  1. MyProjectUnitOfWork implementation to get repository in a new way.
  2. Constructor change to resolve service through Service Provider.
  3. Initialization of DIs for repositories.
  4. Making entry point in Startup.cs 

MyProjectUnitOfWork T4 for code generation

 
 <#@ template debug="true" hostSpecific="true" #>  
 <#@ output extension=".cs" #>  
 <#@ Assembly Name="System.Core" #>  
 <#@ import namespace="System" #>  
 <#@ import namespace="EnvDTE" #>  
 <#@ import namespace="EnvDTE80" #>  
 <#@ import namespace="System" #>  
 <#@ import namespace="System.IO" #>  
 <#@ import namespace="System.Diagnostics" #>  
 <#@ import namespace="System.Linq" #>  
 <#@ import namespace="System.Collections" #>  
 <#@ import namespace="System.Collections.Generic" #>   
 <#@ include file="EF.Utility.CS.ttinclude"#>  
 <#@ include file="../../T4Plugin/VisualStudioAutomationHelper.ttinclude" #>  
 <#@ include file="../../T4Plugin/MultiOutput.ttinclude" #>  
 <#  
   var modelProjectNamespace = "MyProject.Model";  
   var modelNamespace = "MyProject.Model.DataModel";  
   var modelNamespaceReplace = "MyProject.Interface.Repository";  
   var repositoryNamespace = "MyProject.DB.Repository";  
   CodeGenerationTools code = new CodeGenerationTools(this);  
   var codeDom = CodeDomProvider.CreateProvider("C#");  
   var modelProject = VisualStudioHelper.GetProject(modelProjectNamespace);  
   var allModelClasses = VisualStudioHelper.GetAllCodeElementsOfType(modelProject.CodeModel.CodeElements, EnvDTE.vsCMElement.vsCMElementClass, false);  
   var types = (from modelClass in allModelClasses.OfType<CodeClass2>()  
       where modelClass.FullName.StartsWith(modelNamespace) &&   
         !modelClass.FullName.EndsWith("MetadataSource")  
       select modelClass  
     ).OrderBy(clas=>clas.FullName);  
 #>  
 //------------------------------------------------------------------------------  
 // <auto-generated>  
 //   This code was generated from a template and will be re-created if deleted  
 //       with default implementation.  
 // </auto-generated>  
 //------------------------------------------------------------------------------  
 using System;  
 using MyProject.Interface.Infrastructure;  
 using Microsoft.EntityFrameworkCore;  
 using Microsoft.Extensions.DependencyInjection;  
 namespace <#=    code.VsNamespaceSuggestion()#>  
 {  
   /// <summary>  
   /// MyProject implementation of Unit of Work  
   /// </summary>  
      public sealed partial class MyProjectUnitOfWork  
           : IMyProjectUnitOfWork  
      {  
     /// <summary>  
     /// The service provider  
     /// </summary>  
     private readonly IServiceProvider ServiceProvider;  
     /// <summary>  
     /// Initializes a new instance of the <see cref="MyProjectUnitOfWork"/> class.  
     /// </summary>  
     /// <param name="dbContext">The database context.</param>  
     /// <param name="serviceProvider">The service provider.</param>  
     public MyProjectUnitOfWork(MyProjectContext dbContext, IServiceProvider serviceProvider)  
       : base(dbContext)  
     {  
       ServiceProvider = serviceProvider;  
     }  
                          <#  
   foreach (var type in types)  
   {  
     var nameSpace = type.Namespace.Name.Replace(modelNamespace,repositoryNamespace);  
     var interfaceNameSpace = type.Namespace.Name.Replace(modelNamespace,modelNamespaceReplace);  
     var name = type.Name + "Repository";  
     var fullName = nameSpace + "." + name;  
           var interfaceFullName = $"{interfaceNameSpace}.I{type.Name}Repository";  
                #>  
           /// <summary>  
           /// <#=      name #> holder  
           /// </summary>  
     private <#=      fullName #> _<#=      code.CamelCase(name) #>;  
     /// <summary>  
     /// Gets the <#=      type.Name #>Repository repository.  
     /// </summary>  
     /// <value>  
     /// The <#=      type.Name #>Repository repository.  
     /// </value>  
     <#=interfaceFullName#> IMyProjectUnitOfWork.<#=      type.Name #>Repository   
     {   
          get  
          {  
                     return ServiceProvider.GetService<<#=      fullName #>>();  
          }  
     }  
      <#}  
      #>}  
 }

The above would generate

 //------------------------------------------------------------------------------  
 // <auto-generated>  
 //   This code was generated from a template and will be re-created if deleted  
 //       with default implementation.  
 // </auto-generated>  
 //------------------------------------------------------------------------------  
 using System;  
 using MyProject.Interface.Infrastructure;  
 using Microsoft.EntityFrameworkCore;  
 using Microsoft.Extensions.DependencyInjection;  
 namespace MyProject.DB.Infrastructure  
 {  
   /// <summary>  
   /// MyProject implementation of Unit of Work  
   /// </summary>  
      public sealed partial class MyProjectUnitOfWork  
           : IMyProjectUnitOfWork  
      {  
     /// <summary>  
     /// The service provider  
     /// </summary>  
     private readonly IServiceProvider ServiceProvider;  
     /// <summary>  
     /// Initializes a new instance of the <see cref="MyProjectUnitOfWork"/> class.  
     /// </summary>  
     /// <param name="dbContext">The database context.</param>  
     /// <param name="serviceProvider">The service provider.</param>  
     public MyProjectUnitOfWork(MyProjectContext dbContext, IServiceProvider serviceProvider)  
       : base(dbContext)  
     {  
       ServiceProvider = serviceProvider;  
     }  
           /// <summary>  
           /// BookRepository holder  
           /// </summary>  
     private MyProject.DB.Repository.BookRepository _bookRepository;  
     /// <summary>  
     /// Gets the BookRepository repository.  
     /// </summary>  
     /// <value>  
     /// The BookRepository repository.  
     /// </value>  
     MyProject.Interface.Repository.IBookRepository IMyProjectUnitOfWork.BookRepository   
     {   
          get  
          {  
                     return ServiceProvider.GetService<MyProject.DB.Repository.BookRepository>();  
          }  
     }  
      }  
 }

By looking into the code, it is just using ServiceProvider to get the registered services.

Now, need to write code to register service. This again would be populated through T4 and dependency injection codes.

T4 to generate DI codes for Repositories 

 <#@ template debug="true" hostSpecific="true" #>  
 <#@ output extension=".cs" #>  
 <#@ Assembly Name="System.Core" #>  
 <#@ import namespace="System" #>  
 <#@ import namespace="EnvDTE" #>  
 <#@ import namespace="EnvDTE80" #>  
 <#@ import namespace="System" #>  
 <#@ import namespace="System.IO" #>  
 <#@ import namespace="System.Diagnostics" #>  
 <#@ import namespace="System.Linq" #>  
 <#@ import namespace="System.Collections" #>  
 <#@ import namespace="System.Collections.Generic" #>   
 <#@ include file="EF.Utility.CS.ttinclude"#>  
 <#@ include file="../../../T4Plugin/VisualStudioAutomationHelper.ttinclude" #>  
 <#@ include file="../../../T4Plugin/MultiOutput.ttinclude" #>  
 <#  
   var modelProjectNamespace = "MyProject.Model";  
   var modelNamespace = "MyProject.Model.DataModel";  
   var modelNamespaceReplace = "MyProject.Interface.Repository";  
   var repositoryNamespace = "MyProject.DB.Repository";  
   CodeGenerationTools code = new CodeGenerationTools(this);  
   var codeDom = CodeDomProvider.CreateProvider("C#");  
   var modelProject = VisualStudioHelper.GetProject(modelProjectNamespace);  
   var allModelClasses = VisualStudioHelper.GetAllCodeElementsOfType(modelProject.CodeModel.CodeElements, EnvDTE.vsCMElement.vsCMElementClass, false);  
   var types = (from modelClass in allModelClasses.OfType<CodeClass2>()  
       where modelClass.FullName.StartsWith(modelNamespace) &&   
         !modelClass.FullName.EndsWith("MetadataSource")  
       select modelClass  
     ).OrderBy(clas=>clas.FullName);  
 #>  
 //------------------------------------------------------------------------------  
 // <auto-generated>  
 //   This code was generated from a template and will be re-created if deleted  
 //       with default implementation.  
 // </auto-generated>  
 //------------------------------------------------------------------------------  
 using Microsoft.Extensions.DependencyInjection;  
 namespace <#=    code.VsNamespaceSuggestion()#>  
 {  
   /// <summary>  
   /// Registration of repository with Dependency Injection.  
   /// </summary>  
      public static class ExtensionUnitOfWorkService  
      {  
     /// <summary>  
     /// Registers the repositories.  
     /// </summary>  
     /// <param name="service">The service collection.</param>  
           public static void RegisterRepositories(this IServiceCollection service)  
           {  
 <#  
   foreach (var type in types)  
   {  
     var nameSpace = type.Namespace.Name.Replace(modelNamespace,repositoryNamespace);  
     var interfaceNameSpace = type.Namespace.Name.Replace(modelNamespace,modelNamespaceReplace);  
     var name = type.Name + "Repository";  
     var fullName = nameSpace + "." + name;  
           var interfaceFullName = $"{interfaceNameSpace}.I{type.Name}Repository";  
           #>               service.AddScoped<<#= interfaceFullName #>, <#= fullName #>>();  
 <#  
   }#>          }  
      }  
 }

Once executed it would generate codes to map Repository interfaces with respective classes.

 //------------------------------------------------------------------------------  
 // <auto-generated>  
 //   This code was generated from a template and will be re-created if deleted  
 //       with default implementation.  
 // </auto-generated>  
 //------------------------------------------------------------------------------  
 using Microsoft.Extensions.DependencyInjection;  
 namespace MyProject.DB.Infrastructure.Configuration  
 {  
   /// <summary>  
   /// Registration of repository with Dependency Injection.  
   /// </summary>  
      public static class ExtensionUnitOfWorkService  
      {  
     /// <summary>  
     /// Registers the repositories.  
     /// </summary>  
     /// <param name="service">The service collection.</param>  
           public static void RegisterRepositories(this IServiceCollection service)  
           {  
                service.AddScoped<MyProject.Interface.Repository.IBookRepository, MyProject.DB.Repository.BookRepository>();  
           }  
      }  
 }



Two things are done by now MyProjectUnitOfWork properties implementation to get Repositories from ServiceProvider and then mappings of Repository interface to respective classes on ExtensionUnitOfWorkService class.

DbContext registration and above services registration

 /// <summary>  
 /// DB Configuration.  
 /// </summary>  
 public static class ExtensionRepositoryConfiguration  
 {  
   /// <summary>  
   /// Adds the database configuration to MVC Core.  
   /// </summary>  
   /// <param name="services">The services.</param>  
   /// <param name="configuration">The configuration.</param>  
   /// <param name="connectionName">Name of the connection.</param>  
   public static void AddDb(this IServiceCollection services,  
     IConfigurationRoot configuration, string connectionName)  
   {  
     services.AddDbContext<MyProjectContext>(options =>  
     {  
       options.UseSqlServer(connectionName,  
         serverOption => serverOption.MigrationsAssembly("MyProject.Web"));  
     });  
     services.AddScoped<IMyProjectUnitOfWork>((serv) =>  
     {  
       return new MyProjectUnitOfWork(serv.GetService<MyProjectContext>(), serv);  
     });  
     services.RegisterRepositories();  
   }  
 }


All DIs for Repositories are done by calling RegisterRepositories and general Context injection.

Finally, on Startup.cs, need to call this.

 services.AddDb(Configuration, Configuration.GetConnectionString("SqlDatabaseDevelopment"));


SOURCE CODE: https://github.com/viku85/RepositoryUnitOfWorkDiSample

Labels:

Comments

Post a Comment

Popular posts from this blog

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...
2 comments
Read more

Getting started with Raspberry Pi

Raspberry Pi is a small, low powered motherboard contains 512 RAM, combined CPU and GPU. It has LAN, 2 USB, HDMI input, Audio Out, SD Card reader and S-Video connectors. We can have many Linux distribution OS on it. To configure, we just need to attach SD Card to it. SD Card could range from class 4 to class 10. In some cases Raspberry Pi could support less then class 4 cards too. It could be powered through mini USB mobile charger. Let's get started with installing OS on SD Card. There are various ways to install OS. Like we can download OSes through  http://www.raspberrypi.org/downloads  and follow the instructions given on it. There is something BerryBoot multi-boot loader through which we can have more then one OS on Raspberry Pi and boot OS according to our need.  http://www.berryterminal.com/doku.php/berryboot  instructions could be followed to install OS with very simple steps. You need to have internet connection on Raspberry Pi to install OS. It coul...
Post a Comment
Read more

Kendo MVC Grid DataSourceRequest with AutoMapper - Advance

The actual process to make DataSourceRequest compatible with AutoMapper was explained in my previous post  Kendo MVC Grid DataSourceRequest with AutoMapper , where we had created custom model binder attribute and in that property names were changed as data models. In this post we will be looking into using AutoMapper's Queryable extension to retrieve the results based on selected columns. When  Mapper.Map<RoleViewModel>(data)  is called it retrieves all column values from table. The Queryable extension provides a way to retrieve only selected columns from table. In this particular case based on properties of  RoleViewModel . The previous approach that we implemented is perfect as far as this article ( 3 Tips for Using Telerik Data Access and AutoMapper ) is concern about performance where it states: While this functionality allows you avoid writing explicit projection in to your LINQ query it has the same fatal flaw as doing so - it prevents the qu...
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

OpenId Authentication with AspNet Identity Core

This is a very simple trick to make AspNet Identity work with OpenId Authentication. More of all both approach is completely separate to each other, there is no any connecting point. I am using  Microsoft.AspNetCore.Authentication.OpenIdConnect  package to configure but it should work with any other. Configuring under Startup.cs with IAppBuilder app.UseCookieAuthentication(new CookieAuthenticationOptions { AuthenticationScheme = CookieAuthenticationDefaults.AuthenticationScheme, LoginPath = new PathString("/Account/Login"), CookieName = "MyProjectName", }) .UseIdentity() .UseOpenIdConnectAuthentication(new OpenIdConnectOptions { ClientId = "<AzureAdClientId>", Authority = String.Format("https://login.microsoftonline.com/{0}", "<AzureAdTenant>"), ResponseType = OpenIdConnectResponseType.IdToken, PostLogoutRedirectUri = "<my website url>", ...
Post a Comment
Read more

Centralized model validation both for MVC/WebApi and SPA client-side validation using FluentValidation

Validation is one of the crucial parts of any application. It has to validate on both client side and server side requests. What are target features or implementation from this article? Model validation for any given model. Centralized/One code for validation on both server-side and client-side. Automatic validation of model without writing any extra codes on/under actions for validation.  NO EXTRA/ANY codes on client-side to validate any form. Compatible with SPA. Can be compatible with any client-side validation framework/library. Like Angular Reactive form validation or any jquery validation libraries. Tools used in the implementation? FluentValidation : I feel DataAnnotation validation are excellent and simple to use, but in case of complex validation or writing any custom validations are always tricker and need to write a lot of codes to achieve whereas FluentValidations are simple even in case of complex validation. Generally, we need to validate inc...
2 comments
Read more

Implementing/Automating audit logs in Telerik Data Access

Audit logs can be tedious task if done manually, also developer might miss to update audit log implementation on certain level. The codes would be repeated on all places if not centralized. There are many approach available to maintain change history of model/table. Like having single history table and manage all changes of all models in same table. We may maintain in same table with some flags and JSON data for change list. We will look for maintaining history table based on each required data models with minimum effort and performance. To reduce code, I am going to use T4 to generate history models automatically based on original model. Also we are going to take care of Artificial type values. Step 1 - Create a custom attribute to mark model that history need to be maintained. /// <summary> /// Attribute to maintain history table /// </summary> [AttributeUsage(AttributeTargets.Class)] public class ManageHistoryAttribute : Attribute ...
Post a 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

C# Response files

Response files are similar to batch files, having some specific instruction. On execution they perform some predefined task based on instruction. Response file contains instruction to compile programs. If we have to build complex program through command line then response files are really helpful in development process. rsp is an extension for response files. By default, csc.rsp file exists under "Framework" folder Ex: C:\Windows\Microsoft.NET\Framework\v4.0.30319. csc.rsp contains long list of system references (dlls). Some contents under csc.rsp # Reference the common Framework libraries /r:Accessibility.dll /r:Microsoft.CSharp.dll /r:System.Configuration.dll /r:System.Configuration.Install.dll /r:System.Core.dll /r:System.Data.dll /r:System.Data.DataSetExtensions.dll /r:System.Data.Linq.dll .......... In same way we can have our own response file defined which might include some third party dll. Let's see an example. Suppose we have to create an appli...
Post a Comment
Read more

main method return value

Mainly we used to write "static void main" for entry point in console application. Placement of void denotes return type. In main function we could have "int" too but what does it really mean. "int main" signifies return type as integer. The return type of main function tells about execution status of application. Even if we have specified void as return type then it would be marked as successful program execution. If we mark int as return type then we are able to control the execution status. Now, what is the benefit of making main function as int. Windows OS saves result in  %ERRORLEVEL% environment variable of OS. If we create batch file and execute application through it then we will able to get status and based on result we can trigger something else through batch file. Let's suppose we have created program called TEST.EXE. Batch file script: @echo off REM Execute main program REM TEST.EXE @if  "%ERRORLEVEL%" == "0...
Post a Comment
Read more