Skip to main content

Consuming built MVC project under other MVC app

The idea is to reuse build application on multiple child application as a lot of Views and Codes need to be same on all children application. This approach can be a good candidate for a multitenant application, some sort of pluggable architecture or reusing MVC app as parent project.

There are three things need to be done to achieve.
  1. Project built event to copy Views from the parent application.
  2. Area registration on child application.
  3. Custom View path through customized Razor view engine.
Project built event to copy Views from the parent application.

 This has to be configured on child application to copy from application build event. It can be done by going into project property => Build Events => Edit Post Built (Post-built event command line).
Ex:
xcopy "$(SolutionDir)"..\“App.Common\App.Common.Web\Views” “$(ProjectDir)\CommonAppLoc\Views\” /s /i /y /f

xcopy "$(SolutionDir)"..\“App.common\App.Common\App.Common.Web\Areas” “$(ProjectDir)\CommonAppLoc\Areas\” /s /i /y /f

xcopy "$(SolutionDir)"..\“\App.Common\App.Common.Web\Content” “$(ProjectDir)\CommonAppLoc\Content\” /s /i /y /f

There are several macros which can help out to get the desired path. In this one, $(SolutionDir) is used to get solution path and then put the relative path for the application. It can be customized based on a need basis.

In above example, I am trying to copy View, Areas and Content to child application to get physical files.

Area registration on child application.

To consume some other controller, Area registration needs to be done in a different manner with namespace parameter to refer codes of the parent controller from somewhere else.


 public override void RegisterArea(AreaRegistrationContext context)  
 {  
   context.MapRoute(  
     name: "User_default",  
     url: "User/{controller}/{action}/{id}",  
     defaults: new { action = "Index", id = UrlParameter.Optional },  
     namespaces: new[] { "App.Common.Web.Areas.User,Controllers" }  
   );  
 }


NOTE: If want to have the same path as parent application then Area registration on parent application can be and consumed on child application to have paths


Custom View path through customized Razor view engine.

Since the other app Views are copied to the local project, we need to set up our View Engine to look into the newly copied paths. To do that the default view engine needs to override to have those paths.

If we look into the source code of MVC then can have a better idea https://aspnetwebstack.codeplex.com/SourceControl/latest#src/System.Web.Mvc/RazorViewEngine.cs.

So, we can inherit the same RazorViewEngine and customize the paths based on desired locations.

 public class AppCommonRazor  
 : RazorViewEngine  
 {  
   /// <summary>  
   /// Initializes a new instance of the <see cref="AppCommonRazor"/> class.  
   /// </summary>  
   public AppCommonRazor()  
   {  
     ViewLocationFormats = ViewLocationFormats.Concat(new string[]  
     {  
       "~/CommonApp/Views/CustomViewLoc/{1}/{0}.cshtml",  
       "~/CommonApp/Views/CustomViewLoc/{0}.cshtml",  
       "~/CommonApp/Views/{1}/{0}.cshtml",  
       "~/CommonApp/Views/{0}.cshtml",  
     }).ToArray();  
     PartialViewLocationFormats = PartialViewLocationFormats.Concat(new string[]  
     {  
       "~/CommonApp/Views/CustomViewLoc/{1}/{0}.cshtml",  
       "~/CommonApp/Views/CustomViewLoc/Shared/{0}.cshtml",  
       "~/CommonApp/Views/{1}/{0}.cshtml",  
       "~/CommonApp/Views/Shared/{0}.cshtml",  
     }).ToArray();  
     AreaViewLocationFormats = AreaViewLocationFormats.Concat(new string[]  
     {  
       "~/CommonApp/Areas/{2}/Views/CustomViewLoc/{1}/{0}.cshtml",  
       "~/CommonApp/Areas/{2}/Views/CustomViewLoc/Shared/{0}.cshtml",  
       "~/CommonApp/Areas/{2}/Views/{1}/{0}.cshtml",  
       "~/CommonApp/Areas/{2}/Views/Shared/{0}.cshtml",  
     }).ToArray();  
     AreaPartialViewLocationFormats = AreaPartialViewLocationFormats.Concat(new string[]  
     {  
       "~/CommonApp/Areas/{2}/Views/CustomViewLoc/{1}/{0}.cshtml",  
       "~/CommonApp/Areas/{2}/Views/CustomViewLoc/Shared/{0}.cshtml",  
       "~/CommonApp/Areas/{2}/Views/{1}/{0}.cshtml",  
       "~/CommonApp/Areas/{2}/Views/Shared/{0}.cshtml",  
     }).ToArray();  
   }  
 }

The above code is just registering CommonApp path for the application to get the views. The CustomViewLoc path is used to add precedence for views. If any view need further customization then it can be just placed under CustomViewLoc, if it is not present then it picks from original view.

Finally, the View engine registration
This above view engine needs to be registered under Global.asax

 ViewEngines.Engines.Clear();  
 ViewEngines.Engines.Add(new MasterAppCommonRazor());

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

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

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

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

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

Global exception handling and custom logging in AspNet Core with MongoDB

In this, we would be looking into logging and global exception handling in the AspNet Core application with proper registration of logger and global exception handling. Custom logging The first step is to create a data model that we want to save into DB. Error log Data model These are few properties to do logging which could be extended or reduced based on need. public class ErrorLog { /// <summary> /// Gets or sets the Error log identifier. /// </summary> /// <value> /// The Error log identifier. /// </value> [BsonRepresentation(BsonType.ObjectId)] public ObjectId Id { get; set; /// <summary> /// Gets or sets the date. /// </summary> /// <value> /// The date. /// </value> public DateTime Date { get; set; } /// <summary> /// Gets or sets the thread. /// </summary> ...
1 comment
Read more

Strong typed MVC routing on TypeScript/JavaScript

Very often we mess up with routing by giving path which does not exist due to various reason like spelling mistake, name confusions etc. for forming correct URLs . This happens on both server side codes and client side code. There are few strong typed routing provider library present for server side but none is present on the client side. We will look into creating a classes and function to set up our routing paths which will help us to give correct URL based on MVC routing. The idea is to create T4 template file which will be generating client side codes based on MVC routing. I have tried to keep it simple in this version which reads up MVC controllers and public function. The end result looks like this, which is TypeScript code. Makes it pretty simple to use these classes directly without worrying about correct URLs. module Routing { export declare var DomainName: string; export function GetDomainName(): string { return (DomainName != undefined && ...
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

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

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