web api封装分页

原创 2016年08月28日 15:02:31


1.封装分页元数据封装在响应Body中

众所周知,在服务器端一次性返回成百上千条数据是非常恐怖的,在我们设计Api的时候,对于Get方法我们应该以分页的方式返回。例如:每次响应给客户端10条数据,并且包含“上一页”和“下一页”的标签,这样用户就能去获得他想要的数据。

public Object Get(int page = 0, int pageSize = 10)
     {
         IQueryable<model> 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("<pre name="code" class="csharp" style="color: rgb(51, 51, 51); font-size: 14px; line-height: 30px; text-indent: 28px;">model
", new { page = page - 1 }) : ""; var nextLink = page < totalPages - 1 ? urlHelper.Link("model", 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 }; }

解释一下上面的代码:

在Get方法上添加了2个有默认值的参数,这两个参数就是用来过滤我们查询结果集的——例如:我们想获取第2页的数据,那么对应的Get请求就应该是这种形式: http://localhost:{your_port}/api/courses/?page=1 ,注意:在这里我们只给了一个参数,那么pageSize就是默认值10.

客户端收到的部分响应就应该是:

{
    "totalCount": 32,
    "totalPages": 4,
    "prevPageLink": "http://localhost:3300/api/courses?page=0&pageSize=10",
    "nextPageLink": "http://localhost:3300/api/courses?page=2&pageSize=10",
    "results": [
        {
            "id": 11,
            "url": "http://localhost:3300/api/courses/11",
            "name": "English Education 2",
            "duration": 4,
            "description": "The course will talk in depth about: English Education 2",
            "tutor": {
                "id": 4,
                "email": "Kareem.Ismail@outlook.com",
                "userName": "KareemIsmail",
                "firstName": "Kareem",
                "lastName": "Ismail",
                "gender": 0
            },
            "subject": {
                "id": 4,
                "name": "English"
            }
        },

Repository中GetAllCourses的返回值为IQueryable,因此在执行skip和take方法时并没有到SQL Server中执行SQL语句,最后查询的也是分页好的数据,体现出按需查询的特色。

在我们返回给客户端的数据中,其中分页元数据中包含了totalCount, totalPages, prevPageLink, nextPageLink这些数据,对于客户端来说我们返回totalCount, totalPages这两条数据非常有用,这样就可以与一些Grid配合使用来绑定结果。

通常来说我们会将分页元数据封装在响应Body中,对于开发者来说我们提供了所有分页信息。但有的API消费者因此只想获取它请求的数据而不需要分页元数据,那么他在解析响应结果是就会很费劲,因此这里出现了另一种方式来向客户端响应分页元数据——在响应报文头部附加分页元数据:Body部分只包含请求的资源,我们新增一个头部信息“X-Pagination”。

2.封装分页元数据到响应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.Response.Headers.Add("X-Pagination",
                                                                Newtonsoft.Json.JsonConvert.SerializeObject(paginationHeader));

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

            return results;
        }

总结

2种分页技术各有优劣,感觉碰到具体应用的时候再做选择了。




Contact Manager Web API 分页和查询(Paging and Querying)

Contact Manager Web API  分页和查询(Paging and Querying) 联系人管理器web API是一个Asp.net web api示例程序,演示了...

web中分页特效

  • 2013年06月09日 09:00
  • 11KB
  • 下载

Swiper的API及自定义分页器等问题-淘宝触屏版首页制作

移动端页面制作的一些基础问题: 1.使用百分比,vw等相对单位,行高vw无效; 2.学会使用border-box,可以有效避免因为计算不精确,导致出现横向滚动条; 3.媒体查询可以帮助更细致的微调不同...

野狗云API之详解(分页,查询,删除,更新)-yellowcong

野狗云的API说实话,不是特别的好用,对于分页操作和查询是鸡肋,对于这两个操作我就不过多吐槽了,但是我想吐槽一下,野狗云的确很坑,当里把数据往死里写,超过了250MB后,你的服务就用不了了(当时我用多...

web通用分页代码有说明

  • 2012年06月28日 11:21
  • 12.33MB
  • 下载

java web mysql 通用分页

  • 2012年11月28日 08:50
  • 12KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:web api封装分页
举报原因:
原因补充:

(最多只允许输入30个字)