Monday, 10 September 2012

Top 10 ASP.NET MVC Best Practices

This article takes a look at the 10 best practices that can be followed for best and efficient use of ASP.NET MVC Framework 4.

Pre-requisites

As of this writing, ASP.NET MVC 4 has been released. To execute the code examples illustrated in this article, you should have the following installed in your system:
  • ASP.NET MVC 4
  • Visual Studio 2010

What is the ASP.NET MVC Framework?

The ASP.NET MVC Framework is based on the popular and time tested Model View Controller (MVC) Design Pattern. It facilitates designing and implementing applications where you can have a cleaner separation of concerns, better code organization, seamless testability, easy extensibility, scalability and code reuse.
The Official ASP.NET Website states: "The Model-View-Controller (MVC) architectural pattern separates an application into three main components: the model, the view, and the controller. The ASP.NET MVC framework provides an alternative to the ASP.NET Web Forms pattern for creating MVC-based Web applications. The ASP.NET MVC framework is a lightweight, highly testable presentation framework that (as with Web Forms-based applications) is integrated with existing ASP.NET features, such as master pages and membership-based authentication. The MVC framework is defined in the System.Web.Mvc namespace and is a fundamental, supported part of the System.Web namespace." Reference:http://www.asp.net/mvc/tutorials/overview/asp-net-mvc-overview
If you want to upgrade your ASP.NET MVC 3 applications to ASP.NET 4, here’s what you would need to do:
Locate the following text in the application's web.config file:
  • System.Web.Mvc, Version=3.0.0.0
  • System.Web.WebPages, Version=1.0.0.0
  • System.Web.Helpers, Version=1.0.0.0
  • System.Web.WebPages.Razor, Version=1.0.0.0
Now, replace the above with the following text:
  • System.Web.Mvc, Version=4.0.0.0
  • System.Web.WebPages, Version=2.0.0.0
  • System.Web.Helpers, Version=2.0.0.0,
  • System.Web.WebPages.Razor, Version=2.0.0.0,
Delete all references to the following assemblies in your application:
  • System.Web.Mvc (v3.0.0.0)
  • System.Web.WebPages (v1.0.0.0)
  • System.Web.Razor (v1.0.0.0)
  • System.Web.WebPages.Deployment (v1.0.0.0)
  • System.Web.WebPages.Razor (v1.0.0.0)
Add references to the following assemblies:
  • System.Web.Mvc (v4.0.0.0)
  • System.Web.WebPages (v2.0.0.0)
  • System.Web.Razor (v2.0.0.0)
  • System.Web.WebPages.Deployment (v2.0.0.0)
  • System.Web.WebPages.Razor (v2.0.0.0)

Top 10 Best Practices

In this section we will discuss 10 best practices and tips we should keep in mind when working with ASP.NET MVC applications.

Tip 1: Disable Request Validation

Request Validation is a feature that prevents potentially dangerous content from being submitted. This feature is enabled by default. However, at times you might need your application to post HTML markup tags to the server. You would then need this feature to be disabled. Here is how you can do it:
    

  1. [ValidateInput(false)]

    2. 

  2. [AcceptVerbs(HttpVerbs.Post)]

    3. 

  3. public ActionResult Create([Bind(Exclude="Id")]Employee empObj)

    4. 

  4. {

    5. 

  5.  

    6. 

  6. }
    7.

Tip 2: Cache Your Data

You can improve your application's performance to a considerable extent by caching relatively stale data. That way the network bandwidth between the client and the server is also reduced. It is great if you can also cache the rendered action of web pages that are relatively stale, i.e., don’t change much over time.
    

  1. public class HomeController : Controller

    2. 

  2. {

    3. 

  3.     [OutputCache(Duration=3600,

    4. 

  4. VaryByParam="none")]

    5. 

  5.     public ActionResult Index()

    6. 

  6.     {

    7. 

  7.      

    8. 

  8.     }

    9. 

  9. }
    10.

Tip 3: Isolate Data Access Logic From the Controller

The Controller in an ASP.NET MVC application should never have the Data Access logic. The Controller in an ASP.NET MVC application is meant to render the appropriate view based on some user interface action. You should make use of Repository Pattern to isolate Data Access Logic from the Controller – you might need dependency injection to inject the appropriate Repository to your controller at runtime.

Tip 4: Using a Master View Model

We frequently use Master Pages in ASP.NET applications – the same Master Page would be extended by the Content Pages throughout the application to give a similarity as far as look and feel and functionality is concerned. How do we do that in an ASP.NET MVC application? Well, we need a MasterViewModel similar to what is shown in the code snippet below:
    

  1. public class ViewModelBase

    2. 

  2. {

    3. 

  3.     public ViewModelBase()

    4. 

  4.     {

    5. 

  5.  

    6. 

  6.     }

    7. 

  7. //Other methods and properties

    8. 

  8. }
    9.

Tip 5: Use Strongly Typed Models

A strongly typed view is a view that defines its data model as a CLR type instead of a weakly typed dictionary that may contain potentially anything. To create a strongly typed view, check the "Create a strongly-typed view" checkbox while you are creating the view. If you plan to create a strongly typed view manually later, ensure that your view "Inherits" System.Web.Mvc.<Your Namespace>.<YourClass>

Tip 6: Use Data Annotations for Validation

You can make use of the System.ComponentModel.DataAnnotations assembly to validate your server - side code by simply decorating your model with the necessary attributes. Here is an example:
    

  1. public class Employee

    2. 

  2. {

    3. 

  3.     [Required(ErrorMessage="Employee Name Cannot be Blank")]

    4. 

  4.     public string Name { get; set; }

    5. 

  5.  

    6. 

  6.     // ...

    7. 

  7. }
    8.

Tip 7: Take Advantage of Model Binding

Consider the following code snippet:
    

  1. [AcceptVerbs(HttpVerbs.Post)]

    2. 

  2. public ActionResult Create()

    3. 

  3. {

    4. 

  4.     Employee employee = new Employee();

    5. 

  5.     employee.Name = Request.Form["Name"];

    6. 

  6.     

    7. 

  7.     // ...

    8. 

  8.     

    9. 

  9.     return View();

    10. 

  10. }
    11.
You can make use of model binder to save you from having to use the Request and HttpContext properties - just use FormsCollection instead. Here is an example:
    

  1. public ActionResult Create(FormCollection values)

    2. 

  2. {

    3. 

  3.     Employee employee = new Employee();

    4. 

  4.     employee.Name = values["Name"];      

    5. 

  5.             

    6. 

  6.     // ...

    7. 

  7.             

    8. 

  8.     return View();

    9. 

  9. }
    10.

Tip 8: Cache Pages that Contain Shared Data or are Public and don't Require Authorization

You should not cache pages that need authorization in ASP.NET MVC. You should not cache pages that contain private data or need authorization. Caching pages in ASP.NET MVC is simple - just specify the OutputCache directive as shown in the code snippet below:
    

  1. [OutputCache(Duration = 60)]

    2. 

  2. public ActionResult Index()

    3. 

  3. {

    4. 

  4.   return View("Index", somedata);

    5. 

  5. }
    6.

Tip 9: Use Extension Methods

You can make use of Extension Methods to simplifies use of LINQ queries that boost application performance too. This can dramatically reduce the amount of code that you would need to otherwise write when writing your LINQ queries, make your LINQ queries manageable and also improve the application's performance.

Tip 10: Take Advantage of Model Binding

You can take advantage of Microsoft Velocity - a distributed caching engine to boost the application performance of your ASP.NET MVC applications. You can learn more on Velocity from this link:http://blogs.msdn.com/b/velocity/
Posted by at

No comments:

Post a Comment

Subscribe to: Post Comments (Atom)