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

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

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

Channel, ChannelReader and ChannelWriter to manage data streams in multi-threading environment

I came across Channel class while working with SignalR which looks really interesting. By looking into NuGet packages ( https://www.nuget.org/packages/System.Threading.Channels ), it seems just 4 months old. The Channel class provides infrastructure to have multiple reads and write simuletensely through it's Reader and Writer properties. This is where it is handy in case of SignalR where data streaming needs to be done but is not just limited to that but wherever something needs to be read/write/combination of both in a multi-threading environment. In my case with SignalR, I had to stream stock data at a regular interval of time. public ChannelReader<StockData> StreamStock() { var channel = Channel.CreateUnbounded<StockData>(); _stockManager.OnStockData = stockData => { channel.Writer.TryWrite(stockData); }; return channel.Reader; } The SignalR keeps return type of ChannelReader<StockData> open so that whatev...
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...
2 comments
Read more

Blazor 0.5.0 Interop JavaScript from C# and C# to JavaScript call

Blazor provides two-way communication from JS to C# and C# to JS which is called Interop. The version upgrade to Blazor 0.5.0 changed the approach in interactions between cshtml and JS files. The newer version simplifies JS calling by avoiding pre-registration of JS function. In this article, we would see how to call a JS method by passing multiple parameters from cshtml and parameterized call from JS to cshtml. The scenario that is used in this article has a Kendo AutoComplete to search book and populate information based on the selection. An example of a call to JS from cshtml await JSRuntime.Current.InvokeAsync<string>( "searchBook.Init", "#SearchTitle", new DotNetObjectRef(this)); Takeaways from the above example: - JSRuntime.Current give environment to execute out-process JS. - InvokeAsync is a function that would allow executing the JS function. - The searchBook.Init is a JS function call, we would see it in details in the second sec...
Post a Comment
Read more

Kendo MVC Grid DataSourceRequest with AutoMapper

Kendo Grid does not work directly with AutoMapper but could be managed by simple trick using mapping through ToDataSourceResult. The solution works fine until different filters are applied. The problems occurs because passed filters refer to view model properties where as database model properties are required after AutoMapper is implemented. So, the plan is to intercept DataSourceRequest  and modify names based on database model. To do that we are going to create implementation of  CustomModelBinderAttribute to catch calls and have our own implementation of DataSourceRequestAttribute from Kendo MVC. I will be using same source code from Kendo but will replace column names for different criteria for sort, filters, group etc. Let's first look into how that will be implemented. public ActionResult GetRoles([MyDataSourceRequest(GridId.RolesUserGrid)] DataSourceRequest request) { if (request == null) { throw new Argume...
Post a Comment
Read more

Architecture solution composting Repository Pattern, Unit Of Work, Dependency Injection, Factory Pattern and others

Project architecture is like garden, we plant the things in certain order and eventually they grow in similar manner. If things are planted well then they will all look(work) great and easier to manage. If they grow as cumbersome it would difficult to maintain and with time more problems would be happening in maintenance. There is no any fixed or known approach to decide project architecture and specially with Agile Methodology. In Agile Methodology, we cannot predict how our end products will look like similarly we cannot say a certain architecture will fit well for entire development lifespan for project. So, the best thing is to modify the architecture as per our application growth. I understand that it sounds good but will be far more problematic with actual development. If it is left as it is then more problems will arise with time. Just think about moving plant vs a full grown tree. Coming to technical side, In this article, I will be explaining about the various techniques ...
Post a Comment
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

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

Advance enum generation for lookup table through T4

Sometime back I had written simple T4 to generate enum for look up tables http://vikutech.blogspot.in/2014/01/enumeration-generation-for-lookup-table.html . Later on I had posted same on Nu-Get https://www.nuget.org/packages/t4.lookup . This time I am going to extend it to support multiple enums, enum Id, configuration through class and different settings for enum description, columns. Here is the entire code for generating code <#@ template debug="true" hostSpecific="true" #> <#@ output extension=".cs" #> <#@ Assembly Name="System.Data" #> <#@ import namespace="System" #> <#@ import namespace="System.Collections.Generic" #> <#@ include file="EF.Utility.CS.ttinclude"#> <#@ import namespace="System.Data.SqlClient" #> <# // TODO: Look for alternatives to remove connection string var connectString = "data source=.;initial...
Post a Comment
Read more