Skip to main content

C# MVC Pattern

Introduction​

The Model-View-Controller (MVC) pattern is a fundamental architectural design pattern in modern web development, particularly popular in C# applications through the ASP.NET MVC framework. MVC divides an application into three interconnected components, each with specific responsibilities, which leads to better organized code, improved maintainability, and enhanced scalability.

In this tutorial, we'll explore:

  • What the MVC pattern is and why it's useful
  • How each component (Model, View, Controller) works
  • How to implement MVC in C# using ASP.NET MVC
  • Real-world applications and best practices

What is MVC?​

MVC is an architectural pattern that separates an application into three main components:

  1. Model - Represents your data and business logic
  2. View - Displays the data to the user (the UI)
  3. Controller - Handles user input and coordinates between Model and View

This separation of concerns makes your code more organized, easier to test, and simpler to maintain.

Components of MVC​

Model​

The Model represents the application's data and business logic. It:

  • Contains data, state, and application logic
  • Is independent of the user interface
  • Notifies the View when data changes
  • Processes data from the Controller

View​

The View is responsible for presenting data to users:

  • Displays the Model data to the user
  • Sends user actions to the Controller
  • Is typically implemented as HTML, CSS, and limited logic
  • Can be multiple views for the same data

Controller​

The Controller acts as an intermediary between Model and View:

  • Processes incoming requests
  • Manipulates data using the Model
  • Selects which View to render
  • Passes data from the Model to the View

Implementing MVC in C# with ASP.NET MVC​

Let's create a simple example of an MVC application for managing a book collection:

1. Setting Up the Project​

First, create a new ASP.NET MVC project in Visual Studio:

  1. Open Visual Studio
  2. Select "Create a new project"
  3. Choose "ASP.NET Core Web Application"
  4. Name your project "BookCollection" and click "Create"
  5. Select "Web Application (Model-View-Controller)" and click "Create"

2. Creating the Model​

Let's create a simple Book model:

csharp
// Models/Book.cs
namespace BookCollection.Models
{
    public class Book
    {
        public int Id { get; set; }
        public string Title { get; set; }
        public string Author { get; set; }
        public int Year { get; set; }
        public string Genre { get; set; }
    }
}

3. Creating the Controller​

Next, let's create a controller to handle book operations:

csharp
// Controllers/BooksController.cs
using BookCollection.Models;
using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;

namespace BookCollection.Controllers
{
    public class BooksController : Controller
    {
        // In a real app, this would come from a database
        private static List<Book> _books = new List<Book>
        {
            new Book { Id = 1, Title = "Clean Code", Author = "Robert C. Martin", Year = 2008, Genre = "Programming" },
            new Book { Id = 2, Title = "Design Patterns", Author = "Erich Gamma et al.", Year = 1994, Genre = "Programming" },
            new Book { Id = 3, Title = "The Pragmatic Programmer", Author = "Andrew Hunt & David Thomas", Year = 1999, Genre = "Programming" }
        };

        // GET: /Books/
        public IActionResult Index()
        {
            return View(_books);
        }

        // GET: /Books/Details/5
        public IActionResult Details(int id)
        {
            var book = _books.Find(b => b.Id == id);
            if (book == null)
            {
                return NotFound();
            }
            return View(book);
        }
    }
}

4. Creating the Views​

Now, let's create the views to display our books:

Index View (displays all books):

html
<!-- Views/Books/Index.cshtml -->
@model IEnumerable<BookCollection.Models.Book>

@{
    ViewData["Title"] = "Book Collection";
}

<h1>Book Collection</h1>

<table class="table">
    <thead>
        <tr>
            <th>Title</th>
            <th>Author</th>
            <th>Year</th>
            <th>Genre</th>
            <th>Actions</th>
        </tr>
    </thead>
    <tbody>
    @foreach (var book in Model) {
        <tr>
            <td>@book.Title</td>
            <td>@book.Author</td>
            <td>@book.Year</td>
            <td>@book.Genre</td>
            <td>
                <a asp-action="Details" asp-route-id="@book.Id">Details</a>
            </td>
        </tr>
    }
    </tbody>
</table>

Details View (displays information about a specific book):

html
<!-- Views/Books/Details.cshtml -->
@model BookCollection.Models.Book

@{
    ViewData["Title"] = "Book Details";
}

<h1>Book Details</h1>

<div>
    <h4>@Model.Title</h4>
    <hr />
    <dl class="row">
        <dt class="col-sm-2">Title</dt>
        <dd class="col-sm-10">@Model.Title</dd>
        
        <dt class="col-sm-2">Author</dt>
        <dd class="col-sm-10">@Model.Author</dd>
        
        <dt class="col-sm-2">Year</dt>
        <dd class="col-sm-10">@Model.Year</dd>
        
        <dt class="col-sm-2">Genre</dt>
        <dd class="col-sm-10">@Model.Genre</dd>
    </dl>
</div>
<div>
    <a asp-action="Index">Back to List</a>
</div>

5. Running the Application​

When you run the application, you'll see a list of books. Clicking on the "Details" link for any book will show you more information about that specific book.

The MVC Request Lifecycle​

Understanding how MVC processes requests is crucial:

  1. Request Routing: The browser sends a request to the server, which is routed to the appropriate controller action based on the URL pattern.
  2. Controller Processing: The controller action is executed, which typically interacts with one or more models to retrieve or update data.
  3. View Selection: The controller selects a view and passes any required data to it.
  4. View Rendering: The view is rendered using the provided data, generating HTML to be sent back to the browser.
  5. Response: The generated HTML is sent back to the browser as an HTTP response.

Here's a visual representation of the flow:

Browser Request → Routing → Controller → Model → Controller → View → Response → Browser

Real-World MVC Application: Building a Task Management System​

Let's extend our understanding with a more complex example - a task management system:

1. Models​

csharp
// Models/Task.cs
namespace TaskManager.Models
{
    public class Task
    {
        public int Id { get; set; }
        public string Title { get; set; }
        public string Description { get; set; }
        public DateTime DueDate { get; set; }
        public bool IsCompleted { get; set; }
        public Priority Priority { get; set; }
        public int CategoryId { get; set; }
        public virtual Category Category { get; set; }
    }

    public enum Priority
    {
        Low,
        Medium,
        High,
        Critical
    }
}

// Models/Category.cs
namespace TaskManager.Models
{
    public class Category
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public string Color { get; set; }
        public virtual ICollection<Task> Tasks { get; set; }
    }
}

2. Data Context (Entity Framework)​

csharp
// Data/TaskManagerContext.cs
using Microsoft.EntityFrameworkCore;
using TaskManager.Models;

namespace TaskManager.Data
{
    public class TaskManagerContext : DbContext
    {
        public TaskManagerContext(DbContextOptions<TaskManagerContext> options)
            : base(options)
        {
        }

        public DbSet<Task> Tasks { get; set; }
        public DbSet<Category> Categories { get; set; }
    }
}

3. Controllers​

csharp
// Controllers/TasksController.cs
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Rendering;
using Microsoft.EntityFrameworkCore;
using TaskManager.Data;
using TaskManager.Models;
using System.Linq;
using System.Threading.Tasks;

namespace TaskManager.Controllers
{
    public class TasksController : Controller
    {
        private readonly TaskManagerContext _context;

        public TasksController(TaskManagerContext context)
        {
            _context = context;
        }

        // GET: Tasks
        public async Task<IActionResult> Index(string sortOrder, string currentFilter, string searchString, int? pageNumber)
        {
            ViewData["CurrentSort"] = sortOrder;
            ViewData["TitleSortParm"] = String.IsNullOrEmpty(sortOrder) ? "title_desc" : "";
            ViewData["DateSortParm"] = sortOrder == "Date" ? "date_desc" : "Date";
            ViewData["PrioritySortParm"] = sortOrder == "Priority" ? "priority_desc" : "Priority";

            if (searchString != null)
            {
                pageNumber = 1;
            }
            else
            {
                searchString = currentFilter;
            }

            ViewData["CurrentFilter"] = searchString;

            var tasks = from t in _context.Tasks
                        select t;

            if (!String.IsNullOrEmpty(searchString))
            {
                tasks = tasks.Where(s => s.Title.Contains(searchString)
                                       || s.Description.Contains(searchString));
            }

            switch (sortOrder)
            {
                case "title_desc":
                    tasks = tasks.OrderByDescending(s => s.Title);
                    break;
                case "Date":
                    tasks = tasks.OrderBy(s => s.DueDate);
                    break;
                case "date_desc":
                    tasks = tasks.OrderByDescending(s => s.DueDate);
                    break;
                case "Priority":
                    tasks = tasks.OrderBy(s => s.Priority);
                    break;
                case "priority_desc":
                    tasks = tasks.OrderByDescending(s => s.Priority);
                    break;
                default:
                    tasks = tasks.OrderBy(s => s.Title);
                    break;
            }

            int pageSize = 10;
            return View(await PaginatedList<Task>.CreateAsync(tasks.Include(t => t.Category).AsNoTracking(), pageNumber ?? 1, pageSize));
        }

        // Additional controller methods for Create, Edit, Details, Delete, etc.
        // ...
    }
}

4. Views​

html
<!-- Views/Tasks/Index.cshtml -->
@model PaginatedList<TaskManager.Models.Task>

@{
    ViewData["Title"] = "Tasks";
}

<h1>My Tasks</h1>

<p>
    <a asp-action="Create" class="btn btn-primary">Create New Task</a>
</p>

<form asp-action="Index" method="get">
    <div class="form-group">
        <label for="searchString">Search:</label>
        <input type="text" name="SearchString" value="@ViewData["CurrentFilter"]" class="form-control" />
        <input type="submit" value="Search" class="btn btn-secondary mt-2" />
    </div>
</form>

<table class="table table-striped">
    <thead>
        <tr>
            <th>
                <a asp-action="Index" asp-route-sortOrder="@ViewData["TitleSortParm"]">Title</a>
            </th>
            <th>
                <a asp-action="Index" asp-route-sortOrder="@ViewData["DateSortParm"]">Due Date</a>
            </th>
            <th>
                <a asp-action="Index" asp-route-sortOrder="@ViewData["PrioritySortParm"]">Priority</a>
            </th>
            <th>
                Category
            </th>
            <th>
                Status
            </th>
            <th>Actions</th>
        </tr>
    </thead>
    <tbody>
        @foreach (var item in Model) {
        <tr>
            <td>
                @Html.DisplayFor(modelItem => item.Title)
            </td>
            <td>
                @Html.DisplayFor(modelItem => item.DueDate)
            </td>
            <td>
                <span class="badge @GetPriorityClass(item.Priority)">
                    @Html.DisplayFor(modelItem => item.Priority)
                </span>
            </td>
            <td>
                <span class="badge" style="background-color: @item.Category.Color">
                    @Html.DisplayFor(modelItem => item.Category.Name)
                </span>
            </td>
            <td>
                @if(item.IsCompleted) {
                    <span class="badge bg-success">Completed</span>
                } else {
                    <span class="badge bg-warning">Pending</span>
                }
            </td>
            <td>
                <a asp-action="Edit" asp-route-id="@item.Id" class="btn btn-sm btn-primary">Edit</a> |
                <a asp-action="Details" asp-route-id="@item.Id" class="btn btn-sm btn-info">Details</a> |
                <a asp-action="Delete" asp-route-id="@item.Id" class="btn btn-sm btn-danger">Delete</a>
            </td>
        </tr>
        }
    </tbody>
</table>

@{
    var prevDisabled = !Model.HasPreviousPage ? "disabled" : "";
    var nextDisabled = !Model.HasNextPage ? "disabled" : "";
}

<nav aria-label="Page navigation">
    <ul class="pagination">
        <li class="page-item @prevDisabled">
            <a asp-action="Index"
               asp-route-sortOrder="@ViewData["CurrentSort"]"
               asp-route-pageNumber="@(Model.PageIndex - 1)"
               asp-route-currentFilter="@ViewData["CurrentFilter"]"
               class="page-link">
                Previous
            </a>
        </li>
        <li class="page-item @nextDisabled">
            <a asp-action="Index"
               asp-route-sortOrder="@ViewData["CurrentSort"]"
               asp-route-pageNumber="@(Model.PageIndex + 1)"
               asp-route-currentFilter="@ViewData["CurrentFilter"]"
               class="page-link">
                Next
            </a>
        </li>
    </ul>
</nav>

@functions {
    public string GetPriorityClass(Priority priority)
    {
        switch(priority)
        {
            case Priority.Low:
                return "bg-success";
            case Priority.Medium:
                return "bg-info";
            case Priority.High:
                return "bg-warning";
            case Priority.Critical:
                return "bg-danger";
            default:
                return "bg-secondary";
        }
    }
}

Benefits of MVC in C# Web Development​

  1. Separation of Concerns: Each component has distinct responsibilities, making the codebase more organized.
  2. Testability: Components can be tested independently, making unit testing easier.
  3. Maintainability: Changes to one component typically don't affect others.
  4. Parallel Development: Different team members can work on models, views, and controllers simultaneously.
  5. Code Reusability: Models can be reused across multiple views.
  6. SEO Friendly: MVC applications can generate clean URLs that are friendly to search engines.

MVC Best Practices​

  1. Keep Controllers Thin: Controllers should contain minimal logic, delegating to services or the model.
  2. Use ViewModels: Create specific classes to transfer data between controllers and views instead of using domain models directly.
  3. Validate on Both Ends: Implement validation in both client (JavaScript) and server (C#) sides.
  4. Use Dependency Injection: Inject services and repositories into controllers.
  5. Follow Naming Conventions: Use consistent naming patterns for models, views, and controllers.
  6. Use Areas for Large Applications: Organize large applications into areas to manage complexity.

Common Pitfalls to Avoid​

  1. Fat Controllers: Putting too much business logic in controllers
  2. Mixing Concerns: Putting data access code in controllers or views
  3. Complex Views: Views with excessive logic
  4. Tight Coupling: Highly dependent components that are hard to test or modify
  5. Inconsistent Naming: Confusing naming conventions that make it hard to follow the request flow

Summary​

The MVC pattern is a powerful architectural approach for building structured, maintainable web applications in C#. By separating concerns into Models (data), Views (presentation), and Controllers (coordination), you can create applications that are easier to develop, test, and maintain.

ASP.NET MVC provides a robust framework for implementing this pattern in C# applications, offering features like routing, model binding, and view engines that streamline development. The pattern's flexibility allows it to scale from simple applications like our book collection example to complex systems like task managers and beyond.

Additional Resources​

  1. Microsoft Documentation: ASP.NET MVC
  2. Books:
    • "Pro ASP.NET MVC 5" by Adam Freeman
    • "ASP.NET Core in Action" by Andrew Lock
  3. Online Courses:
    • Pluralsight: "ASP.NET MVC 5 Fundamentals"
    • Microsoft Learn: "Create web apps with ASP.NET Core MVC"

Exercises​

  1. Task Manager Extension: Add functionality to mark tasks as complete/incomplete to the task manager example.
  2. Category Management: Create a full CRUD interface for managing categories in the task manager.
  3. Dashboard View: Create a dashboard that shows statistics about tasks (e.g., tasks by priority, upcoming deadlines).
  4. User Authentication: Add user authentication to the task manager so different users can have their own tasks.
  5. API Controller: Create an API controller that exposes task data as JSON for consumption by a JavaScript frontend.

By completing these exercises, you'll gain hands-on experience with various aspects of MVC development in C#, reinforcing the concepts covered in this tutorial.


If you spot any mistakes on this website, please let me know at [email protected]. I’d greatly appreciate your feedback! :)