动态多条件查询分页以及排序(一)--MVC与Entity Framework版url分页版

2022-12-05 10:06:16

一.前言

多条件查询分页以及排序每个系统里都会有这个的代码做好这块可以大大提高开发效率所以博主分享下自己的6个版本的多条件查询分页以及排序

二.目前状况

不论是ado.net 还是EF 在做多条件搜索时都有这类似的代码

这样有几个不好的地方

1.当增加查询条件,需要改代码,对应去写相应的代码。

2.对多表查询以及or的支持不是很好。而我们很常见的需求不可能是一个表的查询

3. 这样写表示层直接出现了SQL语句或者 linq 的拉姆达表达式这是很不好的表示层不应该知道数据访问技术

4.有的时候我们的业务逻辑层接口是这样的 IList<***> seach(string name,string age,string classname,int pageindex,int pagesize,string oderby)

这个时候多一个查询条件对应的还要去修改业务逻辑层 EF由于传递的是表达式树,则更是苦不堪言.

三.我们接下来应该实现的目标

1.当增加条件时不需要修改代码只需要在view上增加相应的查询框即可

2.我们的多条件查询应该做到无关表示层技术(是否是MVC或webform)

3.应该支持多表查询以及OR的操作

4.应该支持更多的查询 like in 不等于等操作

5.关于分页不应该与数据访问耦合在一起个人感觉分页只需要知道总条数以及当前页数和每页多少条然后生成分页代码即可不应该与EF等耦合到一起分页应该是独立出来可控制的

6.客户可以自己添加搜索条件这是个强大的功能想怎么查客户自己添加即可

7. 统一查询接口做到有条件增加不修改代码

8.分页应该支持 url重写或者 mvc路由不应该生成的连接只是?pageindex=值这种的

四.我实现的几个多条件查询分页版本以适应各种需求(每篇会写一个版本的实现以及代码的提供,有好意见的欢迎留言)

1.url get提交版实现URL分页多条件查询以及排序的好处是我们可以把当前的搜索条件当前页数排序等都在url上显示可以方便的发给好友以及后退等浏览器操作(个人给dudu老大建议,博客园应该做成这种的)

2.post 提交版本的搜索条件较大不适合用url的

3.ajax+mvc版本的 (关于AJAX实现我认为有两种 1.服务端实现好内容的拼接,传输给客户端 2直接传递json给客户端客户端来做拼接)

这个版本会实现服务端拼接内容好处是服务端做拼接简单能做更多的事情维护服务端代码方便尤其是强大的Razor

4.ajax+webapi+Knockoutjs 版本

这个版本我实现的是服务端只是传递 json 这样服务端效率很高喜欢这样开发方式的朋友就是前端拼接字符是很不好的代码会显得很乱这个时候前端就需要一个模版引擎我用的是 jquery-temp 配合强大的Knockoutjs

5.动态增加查询条件版

这个版本我实现的是客户可以自己添加查询条件查询条件是动态的

6.移植到webform版

7.EF应该得到表达式树让EF自己生成SQL语句这样方便扩展实现其他方法

五.url get提交版开始

废话了那么多今天就写下url get版的多条件查询以及分页排序

先上个丑陋界面的截图界面虽丑但是功能齐全查询分页排序齐全

看下控制器的代码

我们这里没有各种条件判断判断哪个为空使用哪个排序的判断我们的业务逻辑层接口没有接受表达式树的参数与数据访问层不是耦合的而是使用了Querymodel对象来抽象所有查询条件

这样这个对象可以翻译成 EF的表达式树也可以翻译成SQL语句所以我们的表示层MVC 不用非要使用EF的的底层

而我们的分页只需要知道当前页数总数据以及每页大小去自动生成分页

关于分页很多人喜欢把这个扩展htmlhelper 做成 html.pager 这种做法这样很多表示层的展示都会耦合到这个里面举个例子,比如把分页的布局从 table 变成 ul 这样的这是纯表示层的

本应该修改 view 现在却要去改htmlhelper 而且你的分页代码越强大则htmlhelper 里的内容越多修改起来越不容易所以我的意见是做分页的最好使用html.Partial 然后把分页的逻辑写到

部分页里这样就实现了分页只关注分页与其他的一切都没有关系我们要做的就是构建 Pager类然后传递给模版即可例如

这个版本要注意的就是分页后要保存查询条件

六.url get提交版实现分析

1.先来说下多条件查询吧

我们要做的是把各个条件构建成QueryModel 而如何构建则是关键我们想下获得mvc提交的内容的是根据name 所以我们可以固定一个name的格式如

ID(like操作)： <input type="text" name="[Contains]StuId" value="@StuId" />

这样我们可以通过正则获取想要信息的部分然后在模型绑定构建出QueryModel对象然后再把这个对象翻译成SQL语句或者表达式树就可以用于ado 或者 EF操作了

顺便重点说下这个思路园子里的重典早都实现了而且实现的很好大家可以去他的博客看下以后的各个版本的分页都会用这个表达式树构建为基础这是他文章的链接重典老哥的实现

(ps:这周刚刚见过他本人,聊得甚欢,开心.希望以后还可以多聚聚)

不过重典老哥的表达式树构建我改成自己的实现了整体思路还是一样的自恋的说下 ~ 我的可读性更高些哈哈因为重典已经描述的很详细了具体可以看我的代码和他的文章

当然我们得到通过QueryModel 得到的表达式树通过扩展方法直接调用Where方法即可让我们看下我们的EF的业务逻辑层

动态多条件查询分页以及排序(一)--MVC与Entity Framework版url分页版

 public class StudentService:IStudentService

    {

        /// <summary>

        /// 按条件搜索

        /// </summary>

        /// <param name="query">搜索条件</param>

        /// <param name="pageIndex">当前页数(索引从1开始)</param>

        /// <param name="pageSize">每页显示条数</param>

        /// <param name="total">总条数</param>

        /// <param name="orderBy">排序字段</param>

        /// <param name="ascending">是否升序</param>

        /// <returns></returns>

        public IList<Student> Search(QueryModel query, int pageIndex, int pageSize, out int total, string orderBy, bool ascending)

        {

            IList<Student> stulist = Builder<Student>.CreateListOfSize(321).TheFirst(44).With(x => x.StuName = "hy").And(x => x.Nullint = 1).And(x => x.LoveGril = "LILI").And(x => x.CreateTime = new DateTime(2012, 02, 03)).And(x => x.Birthday = new DateTime(2012, 09, 01)).And(x => x.Stuclass = new StuClass() { ClassId = "2", ClassName = "二班" }).TheNext(33).With(x => x.StuName = "wlf").And(x => x.Nullint = 2).And(x => x.LoveGril = "MM").And(x => x.CreateTime = new DateTime(2012, 06, 06)).And(x => x.Birthday = new DateTime(2012, 09, 010)).And(x => x.Stuclass = new StuClass() { ClassId = "1", ClassName = "一班" }).TheNext(244).And(x=>x

                .Stuclass=new StuClass(){ClassId = "3", ClassName = "三班"}).Build();

            var dbcontext = stulist.AsQueryable(); //模拟EF context 假设数据库里原数据为200条 

            dbcontext = dbcontext.Where(query);

            total = dbcontext.Count();//执行查询数量sql

            dbcontext = dbcontext.OrderBy(orderBy, ascending).Skip(pageSize * (pageIndex - 1)).Take(pageSize);

            return dbcontext.ToList();//执行分页排序查询sql

        }

    }

这里说下为了大家调试方便不用真正的数据库用了测试神奇NBuilder 来模拟的然后转换成AsQueryable 来模拟EF的

看上面代码可以看到没有了各个分支的条件判断以及排序的判断以后多出查询条件不需要修改业务逻辑层了~

2.接下来说下url get提交的思路

上问说过自己的观点分页最好能放到部分页而不是扩展htmlhelper 所以我的实现方式是把构建Pager分页视图类传递给部分视图来做如何展示一些分页有关的逻辑封装在 Pager里

下面是Pager的代码

   public class Pager

    {

        public Pager(int currentPageIndex, int totalItemCount, int pagesize = 20)

        {

            this.TotalItemCount = totalItemCount;

            this.PageSize = pagesize;

            this.CurrentPageIndex = currentPageIndex > TotalPageCount ? 1 : currentPageIndex;

        }

        /// <summary>

        /// 当前第几页

        /// </summary>

        public int CurrentPageIndex { get; set; }

        /// <summary>

        /// 每页显示多少条

        /// </summary>

        public int PageSize { get; set; }

        /// <summary>

        /// 总共多少条记录

        /// </summary>

        public int TotalItemCount { get; set; }

        /// <summary>

        /// 总共多少页

        /// </summary>

        public int TotalPageCount

        {

            get

            {

                double pageCount = (double)TotalItemCount / (double)PageSize;

                pageCount = Math.Ceiling(pageCount);

                return (int)pageCount;

            }

        }

        /// <summary>

        /// 是否显示

        /// </summary>

        public bool IsShow

        {

            get

            {

                if (TotalPageCount > 0)

                {

                    return true;

                }

                else

                {

                    return false;

                }

            }

        }

        /// <summary>

        /// 是否显示上一页

        /// </summary>

        public bool HasPreviousPage

        {

            get

            {

                return (CurrentPageIndex > 1);

            }

        }

        /// <summary>

        /// 是否显示下一页

        /// </summary>

        public bool HasNextPage

        {

            get

            {

                return (CurrentPageIndex < TotalPageCount);

            }

        }

    }

而分页的部分视图只用根据这个类去管理如何展示

这里分享几个小技巧

技巧一.

因为我们要实现下面需求

1. 我们要保存以前的URL 信息再里面不能让以前的消失 2 需要支持 url路由后的分页比如控制器/方法/Page1 而不是？pageIndex=1 3.因为很多个页面都要用到所以要与方法名解耦

实现这个的技巧关键就是使用RouteValueDictionary

通过上面的代码就可以保存住以前的参数了接着就是

dict["PageIndex"] = 1;//设置页码

@Html.RouteLink("首页", dict);

这样就可以设置分页以及解耦控制器和方法名了~

如果你设置了类似的路由

 routes.MapRoute("Page", "{controller}/{action}/page{PageIndex}", new { controller = "WLFQuery", action = "Index", PageIndex = 1 });

那么也是支持的~

2.技巧二

因为我们的分页支持通过下拉框选择页码后自动跳页有点儿像webform 的autopostback 而我们又是get 提交版的需要解决一个问题选择后自动跳页需要带上以前的查询条件不能跳完页以后查询条件消失了

这里采用的办法借鉴了一下 aspnetpager 作者的 urlpager的思路

用一个隐藏的a 标签这个a 标签生成的连接保存了当前的查询条件等他的页面数显示成"*pageindex* 当我们选择下拉框跳页后用选择的值替换这个"*pageindex* 然后跳转到当前href 则解决了上述问题
上代码

    <text>跳转至</text>
    <select id="pageselect" onchange="selectchange()">
        @for (int i = 1; i <=@Model.TotalPageCount; i++)
            {
                var selected = "";
                if (i==Model.CurrentPageIndex)
                {
                    selected = "selected='selected'";
                }            
            <option value="@i" @selected>@i</option>
            }
    </select>
    
    {
        dict["PageIndex"] = "*pageindex*";
    }
    <a style="display:none" id="pagelink" href="@Url.RouteUrl(dict)" ></a>
    //  
    <script type="text/javascript">

            function selectchange() {
                var pageselect = document.getElementById("pageselect");
                var pageselectValue = pageselect.options[pageselect.selectedIndex].value;

                var linkdom= document.getElementById("pagelink");
                var href = linkdom.href;
                href = href.replace("*pageindex*", pageselectValue);

                window.location = href;
  
            }
    </script>
    
    <text>页</text>

3.点击搜索时 get 提交并回到第一页

 <form action="@Url.Action("index", new { PageIndex = 1 })" method="get">

 </form>

具体代码可以下载源码看~

七. URL GET提交的遗憾

上面基本功能已经实现但是有些遗憾的是大家知道 mvc没有viewstate机制而且我们的又是URL分页及时是webform 也会面临这个问题

虽然我们通过url保存了搜索的状态但是没有解决点击分页后搜索框的内容还在。所以会出来一个奇怪的现象按条件搜索完比如搜索姓名为hy的然后点击分页搜索框的内容没了

但是分页后内容却还是hy的因为我们的url 里存的有搜索结果但是重新加载后文本框的内容却没了这样虽然无伤大雅但是还是略感不爽如果非要解决也不是没有办法只是觉得都不是很完美

方案1.

 ID(like操作)： <input type="text" name="[Contains]StuId"  value="@Request.QueryString["[Contains]StuId"]" /><br />

因为我们的url里保存的有真实的搜索条件所以我们可以通过Request.QueryString["[Contains]StuId"] 直接得到但是我觉得在MVC里出现Request.QueryString 这样的信息不好看

方案2.

ViewContext.Controller.ValueProvider.GetValue("[Contains]StuId").RawValue 通过这样也可以得到值

方案3.

在控制器里

ViewBag.Query = querymodel; 记录搜索条件然后在view里读出来

   QueryModel query=ViewBag.Query as QueryModel;

      string StuId=query.Items.Where(x => x.Field == "StuId").Select(x=>x.Value).FirstOrDefault()!=null?query.Items.Where(x => x.Field == "StuId").Select(x=>x.Value).FirstOrDefault().ToString():"";

上面三个方式感觉都有不完美的地方因为我们还原的内容不只是 text 有可能是多选框下拉列表等所以要做处理就稍微麻烦了下比如

 string[] newarrlovewgril = (string[])arrlovegril;

          MMischeck= newarrlovewgril.Contains("MM") ? "checked='checked'" : "";

          LUCIischeck = newarrlovewgril.Contains("LILI") ? "checked='checked'" : "";

          GAGAischeck = newarrlovewgril.Contains("GAGA") ? "checked='checked'" : "";

 MM<input type="checkbox" name="lovegril" value="MM" @MMischeck />

        LILI<input type="checkbox" name="lovegril" value="LILI" @LUCIischeck />

        GAGA<input type="checkbox" name="lovegril"  value="GAGA" @GAGAischeck />

我再想把这些还原也做成自动化的不用任何代码的求集思广益希望大家给些建议

八.总结

EF实现动态查询以及排序的关键就在于表达式树的构建。所以学会并理解表达式树很关键,这个不尽在这里有用,用来代替反射也可以提高效率~不过表达式树的生成建议实际项目中加上缓存。

表达式树的学习可以看下这几篇

http://www.cnblogs.com/Terrylee/archive/2008/08/01/custom-linq-provider-part-1-expression-tree.html

http://www.cnblogs.com/Ninputer/archive/2009/08/28/expression_tree1.html

http://msdn.microsoft.com/en-us/library/bb397951.aspx

短短文章花了半天才写完~ 希望对大家有帮助或者能给大家一些启示有问题可以留言交流欢迎批评和建议感谢阅读~

码农公寓

相关文章