ASP.NET MVC Do's and Dont's/Best practices

koolprasad2003
794 views

Open Source Your Knowledge, Become a Contributor

Technology knowledge has to be shared and made accessible for free. Join the movement.

Create Content

Introduction!

ASP.NET MVC (Model-View-Controller architectural pattern) is getting popular day by day, due to Separation of code, extensive templates, data-binding, test-driven development (TDD), Scaffolding and no view state like features, it has REST and SEO support nature. it is really an plugged and extensible framework. We get complete control over HTML with MVC support. But before going to code on ASP.NET MVC we should take care of some Do's and Dont's or best practices. Here i am explaining some Do's and Don'ts of ASP.NET MVC code

Many developers/organizations thinking of migrating their exiting application to ASP.NET MVC, This article will help them to understand code facts

Do's and Dont's/Best Practices

DOsDonts

  • Business logic should be the part of Model only Before start code on MVC we should make understand that Business logic should be reside in Model only, it will add your security and code duplication can be avoided. The view load faster as there is no business present in view.

  • Use only specific view engine View engines are used to create HTML markup from your view, it is the combination of HTML and programming code, ASP.NET has its own asp.net engine where as ASP.NET MVC has its razor engine. You should only use your specified view engine, it will increase application performance, see below snippet

protected void Application_Start()
{
    ViewEngines.Engines.Clear(); //clear all engines
    ViewEngines.Engines.Add(new RazorViewEngine());
}
  • Create separate assembly for Model if the application is large and complex then make separate assembly for Model to avoid An unfortunate mishap. Basically Model should contain business logic, Validation part, session maintenance and data logic part.

  • HTML and data access part should be done from VIEW only As we know VIEW is the presenter part and it should be very flexible. VIEW should not contains any business logic and session maintenance, use ViewData to access data in View.

  • Business logic and data access should not exist in ControllerViewData Controller should be only responsible for calling model, Prepare view, return view, redirect to action etc

  • Delete Demo code from application when you create it Delete AccountController and all other auto created code from application it will slow down the performance

  • Disable request validation Request validation validate the request submitted to server and avoid the potential dangerous characters, but it will also block the contents to post HTML markup tags to the server, so disable it, with the help of ValidateInput we can do it, see below snippet

[ValidateInput(false)]
[AcceptVerbs(HttpVerbs.Post)]
public ActionResult Create([Bind(Exclude="Name")]TestEmployee clsEmp)
{
//code goes here
}
  • Master view model may be use for Uniformness In ASP.NET master pages are used to maintain uniformness in look and feel, same way in ASP.NET MVC we use master view for it.

  • Data Annotations can be used for server side validation Use System.ComponentModel.DataAnnotations namespace for server side validation, just use it in model with attribute, see snippet

Public class GetAddress
{
    [Required(ErrorMessage="Address is mandatory")]
    public string Address { get; set; }
}
  • Use extension methods Extension method help us to simplify LINQ queries and improve application performance, these methods are the static methods and access with this keyword.

  • Remove un-necessary folders and references When you start creating new ASP.NET MVC application, visual studio does create lot of un-necessary folders and references that are not useful, we can remove them to avoid additional overhead on application

  • Do Bundling and Minifying CSS Files Bundling and Minifying is the process of minimizing the size of referenced file like .JS, .JSON, .CSS we can reduce the size of such files which will ultimately boost the application performance, in Bundling we merge all CSS in one file and same done for .JS and .JSON file in Minification we remove extra spaces and enters from file and reduce file size

  • For each view there should be a view model Do you have view ? if yes then create ViewModel. it should used only for data binding and may not contain any presenter code. ViewModel is essential when we want to show some data in different format, in such case view only responsible for present and ViewModel does the job of data transformation

  • Design Routing properly not URL re-writing URL routing is very much different than URL re-writing, may developers consider them as unique thing. URL routing does not create new URL for old URL but it maps resources with route

  • Use ViewData and ViewBag for large data storage If you want to work with lage data, spread sheets, dashboards or volume data sources then ViewData is good option, both views and controllers can easily access ViewData and ViewBag

  • For current and the subsequent requests use TempData TempData is very short-lived instance, it should use only For current and the subsequent requests.

  • Use Glimpse, fidder, F-12 like package to monitor and improve performance of ASP.NET MVC Glimpse NuGet package provide detail diagnostic information of ASP.NET apps, where as fidder, F-12 shows you client side activities, more information can be found on Here

  • Deploy code in Release mode Code with Release is more compressed than debug mode as it does not conain .pdb file so less memory is utilized by it

  • Remove unnessary HTTP headers Remove X-AspNetMvc version from global.asax.cs as it will not provide no direct benifit and un-necessarily use small amount of bandwidth, see below snippet

MvcHandler.DisableMvcResponseHeader = true;
  • Use CDN (Content Delivery Networks) CDN is helping you to download your supportive things (like required .JS, .CSS, .JSON files) from nearest location/server, so travelling time of resources from one location to another will save significantly.

  • Use validationSummary to show all validations in one snap see below method to use to show all validation in one snap

<%= Html.ValidationSummary() %>
  • Razor is recommended We know ASP.NET MVC support multiple engines but Razor is recommended by Microsoft as it is light weight and it has very simple syntax

  • Do you want some repetitive UI to be display on each page ? use Partial view Partial view is like a user control in classic ASP.NET, you can use them if you want to show piece of UI on each page

  • If you are not using bundles and WebAPI then simple remove their associated files Go to App_start directory and remove BundleConfig file, now go to Application_Start method, in Global.asax.cs and remove the line BundleConfig.RegisterBundles, same thing you can do for WebApiConfig

This is not a detail level document, this document at least need a basic knowledge of ASP.NET MVC, i will cover more detail documentation in next version of this document till then enjoy this stuff

Suggestion and Queries are always welcome

-Prasad

Open Source Your Knowledge: become a Contributor and help others learn. Create New Content