[翻译]创建ASP.NET WebApi RESTful 服务（7）

实现资源分页

本章我们将介绍几种不同的结果集分页方式，实现手工分页，然后将Response通过两个不同的方式进行格式化（通过Response的Envelop元数据或header）。

大家都知道一次查询返回几百条数据是很讨厌的事情，那么在WebApi中分页就更有必要。

手动分页和封装

接下来我们修改CoursesController来实现分页而不是返回所有数据。

 

public Object Get(int page = 0, int pageSize = 10)
    {
        IQueryable<Course> query;

        query = TheRepository.GetAllCourses().OrderBy(c => c.CourseSubject.Id);
        var totalCount = query.Count();
        var totalPages = (int)Math.Ceiling((double)totalCount / pageSize);

        var urlHelper = new UrlHelper(Request);
        var prevLink = page > 0 ? urlHelper.Link("Courses", new { page = page - 1 }) : "";
        var nextLink = page < totalPages - 1 ? urlHelper.Link("Courses", new { page = page + 1 }) : "";

        var results = query
        .Skip(pageSize * page)
        .Take(pageSize)
        .ToList()
        .Select(s => TheModelFactory.Create(s));

        return new
        {
            TotalCount = totalCount,
            TotalPages = totalPages,
            PrevPageLink = prevLink,
            NextPageLink = nextLink,
            Results = results
        };

    }

代码很简单，添加两个可选参数，它们最终会被格式化为QueryString。例如http://localhost:{your_port}/api/courses/?page=1代表你需要访问第一页的10条数据。不出意外，结果可能是这样的：

{

    "totalCount": 33,
    "totalPages": 4,
    "prevPageLink": "http://localhost:8323/api/courses?page=0&pageSize=10",
    "nextPageLink": "http://localhost:8323/api/courses?page=2&pageSize=10",
    "results": [ /* Array containts the results*/ ]

}

结果是我们通过将数据封装为json通过Response的结果返回，这样记录总数也可以被返回。一个明显的缺点是这种类似的数据可能会污染我们期望的结果集，所以接下来我们通过在Response Header中添加一个X-Pagination参数来实现这一功能。

通过Response Header实现分页

实现代码如下：

public IEnumerable<StudentBaseModel> Get(int page = 0, int pageSize = 10)
   {
       IQueryable<Student> query;

       query = TheRepository.GetAllStudentsWithEnrollments().OrderBy(c => c.LastName);

       var totalCount = query.Count();
       var totalPages = (int)Math.Ceiling((double)totalCount / pageSize);

       var urlHelper = new UrlHelper(Request);
       var prevLink = page > 0 ? urlHelper.Link("Students", new { page = page - 1, pageSize = pageSize }) : "";
       var nextLink = page < totalPages - 1 ? urlHelper.Link("Students", new { page = page + 1, pageSize = pageSize }) : "";

       var paginationHeader = new
       {
           TotalCount = totalCount,
           TotalPages = totalPages,
           PrevPageLink = prevLink,
           NextPageLink = nextLink
       };

       System.Web.HttpContext.Current.F.Add("X-Pagination",
       Newtonsoft.Json.JsonConvert.SerializeObject(paginationHeader));

       var results = query
       .Skip(pageSize * page)
       .Take(pageSize)
       .ToList()
       .Select(s => TheModelFactory.CreateSummary(s));

       return results;
   }

需要注意代码中，我们在Response.Headers中添加了一个通过json序列化的分页参数。这样返回结果及就可以直接被使用，无法再考虑额外的信息。

来源：http://bitoftech.net/2013/11/25/implement-resources-pagination-asp-net-web-api/