Implement Efficient Data Paging
by Microsoft
This is step 8 of a free “NerdDinner” application tutorial that walks-through how to build a small, but complete, web application using ASP.NET MVC 1.
Step 8 shows how to add paging support to our /Dinners URL so that instead of displaying 1000s of dinners at once, we’ll only display 10 upcoming dinners at a time - and allow end-users to page back and forward through the entire list in an SEO friendly way.
If you are using ASP.NET MVC 3, we recommend you follow the Getting Started With MVC 3 or MVC Music Store tutorials.
NerdDinner Step 8: Paging Support
If our site is successful, it will have thousands of upcoming dinners. We need to make sure that our UI scales to handle all of these dinners, and allows users to browse them. To enable this, we’ll add paging support to our /Dinners URL so that instead of displaying 1000s of dinners at once, we’ll only display 10 upcoming dinners at a time - and allow end-users to page back and forward through the entire list in an SEO friendly way.
Index() Action Method Recap
The Index() action method within our DinnersController class currently looks like below:
[!code-csharpMain]
1: //
2: // GET: /Dinners/
3:
4: public ActionResult Index() {
5:
6: var dinners = dinnerRepository.FindUpcomingDinners().ToList();
7: return View(dinners);
8: }
When a request is made to the /Dinners URL, it retrieves a list of all upcoming dinners and then renders a listing of all of them out:
Understanding IQuerable<T>
IQueryable<T> is an interface that was introduced with LINQ as part of .NET 3.5. It enables powerful “deferred execution” scenarios that we can take advantage of to implement paging support.
In our DinnerRepository we are returning an IQueryable<Dinner> sequence from our FindUpcomingDinners() method:
[!code-csharpMain]
1: public class DinnerRepository {
2:
3: private NerdDinnerDataContext db = new NerdDinnerDataContext();
4:
5: //
6: // Query Methods
7:
8: public IQueryable<Dinner> FindUpcomingDinners() {
9:
10: return from dinner in db.Dinners
11: where dinner.EventDate > DateTime.Now
12: orderby dinner.EventDate
13: select dinner;
14: }
The IQueryable<Dinner> object returned by our FindUpcomingDinners() method encapsulates a query to retrieve Dinner objects from our database using LINQ to SQL. Importantly, it won’t execute the query against the database until we attempt to access/iterate over the data in the query, or until we call the ToList() method on it. The code calling our FindUpcomingDinners() method can optionally choose to add additional “chained” operations/filters to the IQueryable<Dinner> object before executing the query. LINQ to SQL is then smart enough to execute the combined query against the database when the data is requested.
To implement paging logic we can update our DinnersController’s Index() action method so that it applies additional “Skip” and “Take” operators to the returned IQueryable<Dinner> sequence before calling ToList() on it:
[!code-csharpMain]
1: //
2: // GET: /Dinners/
3:
4: public ActionResult Index() {
5:
6: var upcomingDinners = dinnerRepository.FindUpcomingDinners();
7: var paginatedDinners = upcomingDinners.Skip(10).Take(20).ToList();
8:
9: return View(paginatedDinners);
10: }
The above code skips over the first 10 upcoming dinners in the database, and then returns back 20 dinners. LINQ to SQL is smart enough to construct an optimized SQL query that performs this skipping logic in the SQL database – and not in the web-server. This means that even if we have millions of upcoming Dinners in the database, only the 10 we want will be retrieved as part of this request (making it efficient and scalable).
Adding a “page” value to the URL
Instead of hard-coding a specific page range, we’ll want our URLs to include a “page” parameter that indicates which Dinner range a user is requesting.
Using a Querystring value
The code below demonstrates how we can update our Index() action method to support a querystring parameter and enable URLs like /Dinners?page=2:
[!code-csharpMain]
1: //
2: // GET: /Dinners/
3: // /Dinners?page=2
4:
5: public ActionResult Index(int? page) {
6:
7: const int pageSize = 10;
8:
9: var upcomingDinners = dinnerRepository.FindUpcomingDinners();
10:
11: var paginatedDinners = upcomingDinners.Skip((page ?? 0) * pageSize)
12: .Take(pageSize)
13: .ToList();
14:
15: return View(paginatedDinners);
16: }
The Index() action method above has a parameter named “page”. The parameter is declared as a nullable integer (that is what int? indicates). This means that the /Dinners?page=2 URL will cause a value of “2” to be passed as the parameter value. The /Dinners URL (without a querystring value) will cause a null value to be passed.
We are multiplying the page value by the page size (in this case 10 rows) to determine how many dinners to skip over. We are using the C# null “coalescing” operator (??) which is useful when dealing with nullable types. The code above assigns page the value of 0 if the page parameter is null.
Using Embedded URL values
An alternative to using a querystring value would be to embed the page parameter within the actual URL itself. For example: /Dinners/Page/2 or /Dinners/2. ASP.NET MVC includes a powerful URL routing engine that makes it easy to support scenarios like this.
We can register custom routing rules that map any incoming URL or URL format to any controller class or action method we want. All we need to-do is to open the Global.asax file within our project:
And then register a new mapping rule using the MapRoute() helper method like the first call to routes.MapRoute() below:
[!code-csharpMain]
1: public void RegisterRoutes(RouteCollection routes) {
2:
3: routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
4:
5: routes.MapRoute(
6: "UpcomingDinners", // Route name
7: "Dinners/Page/{page}", // URL with params
8: new { controller = "Dinners", action = "Index" } // Param defaults
9: );
10:
11: routes.MapRoute(
12: "Default", // Route name
13: "{controller}/{action}/{id}", // URL with params
14: new { controller="Home", action="Index",id="" } // Param defaults
15: );
16: }
17:
18: void Application_Start() {
19: RegisterRoutes(RouteTable.Routes);
20: }
Above we are registering a new routing rule named “UpcomingDinners”. We are indicating it has the URL format “Dinners/Page/{page}” – where {page} is a parameter value embedded within the URL. The third parameter to the MapRoute() method indicates that we should map URLs that match this format to the Index() action method on the DinnersController class.
We can use the exact same Index() code we had before with our Querystring scenario – except now our “page” parameter will come from the URL and not the querystring:
[!code-csharpMain]
1: //
2: // GET: /Dinners/
3: // /Dinners/Page/2
4:
5: public ActionResult Index(int? page) {
6:
7: const int pageSize = 10;
8:
9: var upcomingDinners = dinnerRepository.FindUpcomingDinners();
10:
11: var paginatedDinners = upcomingDinners.Skip((page ?? 0) * pageSize)
12: .Take(pageSize)
13: .ToList();
14:
15: return View(paginatedDinners);
16: }
And now when we run the application and type in /Dinners we’ll see the first 10 upcoming dinners:
And when we type in /Dinners/Page/1 we’ll see the next page of dinners:
Adding page navigation UI
The last step to complete our paging scenario will be to implement “next” and “previous” navigation UI within our view template to enable users to easily skip over the Dinner data.
To implement this correctly, we’ll need to know the total number of Dinners in the database, as well as how many pages of data this translates to. We’ll then need to calculate whether the currently requested “page” value is at the beginning or end of the data, and show or hide the “previous” and “next” UI accordingly. We could implement this logic within our Index() action method. Alternatively we can add a helper class to our project that encapsulates this logic in a more re-usable way.
Below is a simple “PaginatedList” helper class that derives from the List<T> collection class built-into the .NET Framework. It implements a re-usable collection class that can be used to paginate any sequence of IQueryable data. In our NerdDinner application we’ll have it work over IQueryable<Dinner> results, but it could just as easily be used against IQueryable<Product> or IQueryable<Customer> results in other application scenarios:
[!code-csharpMain]
1: public class PaginatedList<T> : List<T> {
2:
3: public int PageIndex { get; private set; }
4: public int PageSize { get; private set; }
5: public int TotalCount { get; private set; }
6: public int TotalPages { get; private set; }
7:
8: public PaginatedList(IQueryable<T> source, int pageIndex, int pageSize) {
9: PageIndex = pageIndex;
10: PageSize = pageSize;
11: TotalCount = source.Count();
12: TotalPages = (int) Math.Ceiling(TotalCount / (double)PageSize);
13:
14: this.AddRange(source.Skip(PageIndex * PageSize).Take(PageSize));
15: }
16:
17: public bool HasPreviousPage {
18: get {
19: return (PageIndex > 0);
20: }
21: }
22:
23: public bool HasNextPage {
24: get {
25: return (PageIndex+1 < TotalPages);
26: }
27: }
28: }
Notice above how it calculates and then exposes properties like “PageIndex”, “PageSize”, “TotalCount”, and “TotalPages”. It also then exposes two helper properties “HasPreviousPage” and “HasNextPage” that indicate whether the page of data in the collection is at the beginning or end of the original sequence. The above code will cause two SQL queries to be run - the first to retrieve the count of the total number of Dinner objects (this doesn’t return the objects – rather it performs a “SELECT COUNT” statement that returns an integer), and the second to retrieve just the rows of data we need from our database for the current page of data.
We can then update our DinnersController.Index() helper method to create a PaginatedList<Dinner> from our DinnerRepository.FindUpcomingDinners() result, and pass it to our view template:
[!code-csharpMain]
1: //
2: // GET: /Dinners/
3: // /Dinners/Page/2
4:
5: public ActionResult Index(int? page) {
6:
7: const int pageSize = 10;
8:
9: var upcomingDinners = dinnerRepository.FindUpcomingDinners();
10: var paginatedDinners = new PaginatedList<Dinner>(upcomingDinners, page ?? 0, pageSize);
11:
12: return View(paginatedDinners);
13: }
We can then update the .aspx view template to inherit from ViewPage<NerdDinner.Helpers.PaginatedList<Dinner>> instead of ViewPage<IEnumerable<Dinner>>, and then add the following code to the bottom of our view-template to show or hide next and previous navigation UI:
[!code-aspxMain]
1: <% if (Model.HasPreviousPage) { %>
2:
3: <%= Html.RouteLink("<<<", "UpcomingDinners", new { page = (Model.PageIndex-1) }) %>
4:
5: <% } %>
6:
7: <% if (Model.HasNextPage) { %>
8:
9: <%= Html.RouteLink(">>>", "UpcomingDinners", new { page = (Model.PageIndex + 1) }) %>
10:
11: <% } %>
Notice above how we are using the Html.RouteLink() helper method to generate our hyperlinks. This method is similar to the Html.ActionLink() helper method we’ve used previously. The difference is that we are generating the URL using the “UpcomingDinners” routing rule we setup within our Global.asax file. This ensures that we’ll generate URLs to our Index() action method that have the format: /Dinners/Page/{page} – where the {page} value is a variable we are providing above based on the current PageIndex.
And now when we run our application again we’ll see 10 dinners at a time in our browser:
We also have <<< and >>> navigation UI at the bottom of the page that allows us to skip forwards and backwards over our data using search engine accessible URLs:
| Side Topic: Understanding the implications of IQueryable<T> |
|---|
| IQueryable<T> is a very powerful feature that enables a variety of interesting deferred execution scenarios (like paging and composition based queries). As with all powerful features, you want to be careful with how you use it and make sure it is not abused. It is important to recognize that returning an IQueryable<T> result from your repository enables calling code to append on chained operator methods to it, and so participate in the ultimate query execution. If you do not want to provide calling code this ability, then you should return back IList<T> or IEnumerable<T> results - which contain the results of a query that has already executed. For pagination scenarios this would require you to push the actual data pagination logic into the repository method being called. In this scenario we might update our FindUpcomingDinners() finder method to have a signature that either returned a PaginatedList: PaginatedList< Dinner> FindUpcomingDinners(int pageIndex, int pageSize) { } Or return back an IList<Dinner>, and use a “totalCount” out param to return the total count of Dinners: IList<Dinner> FindUpcomingDinners(int pageIndex, int pageSize, out int totalCount) { } |
Next Step
Let’s now look at how we can add authentication and authorization support to our application.
)
|
|