ABP开发框架前后端开发系列---（13）高级查询功能及界面的处理

在一般的检索界面中，基于界面易用和美观方便的考虑，我们往往只提供一些常用的条件查询进行列表数据的查询，但是有时候一些业务表字段很多，一些不常见的条件可能在某些场景下也需要用到。因此我们在通用的查询条件之外，一般可以考虑增加 一个高级查询的模块来管理这些不常见条件的查询处理。本篇随笔基于这个需求，综合ABP框架的特点，整合了高级查询模块功能的处理。

1、高级查询模块的回顾

我们知道，在界面布局中，一般常见的查询条件不能太多，否则会显得臃肿而且占用太多空间，非常不美观，因此常见的查询都是提供寥寥几个的输出条件进行列表记录的查询的。

又或者一些更多内容的界面，我们也是仅仅提供多几个条件，其他的想办法通过高级查询界面进行查询管理。

在早期博客里面《Winform开发框架之通用高级查询模块》，我曾经介绍过一款通用的高级查询界面处理，用在Winform框架里面，可以对数据表更多的字段进行统一的查询处理。

对于内容较多的查询，我们可以在主界面增加一个高级查询按钮入口，如上图所示，单击后，显示一个所有字段的列表，如下界面。

一般来说，查询条件分为文本输入，如姓名，邮件，名称等这些。

日期类型条件输入界面：

数字类型条件输入界面：

输入以上几种条件后，高级查询界面里面会显示友好的条件内容，确保用户能够看懂输入的条件，如下所示是输入几个不同类型的条件的显示内容。

以上是高级查询模块的思路，整体界面和处理逻辑虽然可以采用，但是在ABP框架模式下，以前的处理方式有所不同了，下面详细介绍一下如何在ABP框架模块下整合这个高级查询模块的内容。

2、ABP框架模块下的高级查询处理

我们先来了解一下最终在ABP框架下整合的高级查询模块界面如下所示。

可以设置一些模糊查询条件，以及一些区间的查询值，如下所示。

这个模块是以ABP框架的Web API获取数据，并通过Winform界面进行调用，从而形成了一个ABP+Winform的框架体系。

前面ABP框架系列介绍过，我们一般使用GetAll和分页条件DTO进行数据的检索，如下是产品分页DTO的定义

    /// <summary>
    /// 用于根据条件分页查询，DTO对象
    /// </summary>
    public class ProductPagedDto : PagedAndSortedInputDto

而PagedAndSortedInputDto也是自定义的类，它主要用来承载一些分页和排序的信息，如下所示

    /// <summary>
    /// 带有排序对象的分页基类
    /// </summary>
    public class PagedAndSortedInputDto : PagedInputDto, ISortedResultRequest
    {
        /// <summary>
        /// 排序信息
        /// </summary>
        public string Sorting { get; set; }

其中的PagedInputDto也是自定义类，主要承载分页信息。

    /// <summary>
    /// 分页对象
    /// </summary>
    public class PagedInputDto : IPagedResultRequest
    {
        [Range(, int.MaxValue)]
        public int MaxResultCount { get; set; }

        [Range(, int.MaxValue)]
        public int SkipCount { get; set; }

        public PagedInputDto()
        {
            MaxResultCount = int.MaxValue;
        }
    }

这样的构建，我们可以传递分页和排序信息，因此在GetAll函数里面，就可以根据这些条件进行数据查询了。

而我们通过重写过滤条件和排序处理，就可以实现数据的分页查询了。对于产品信息的过滤处理和排序处理，我们重写函数如下所示。

        /// <summary>
        /// 自定义条件处理
        /// </summary>
        /// <param name="input">查询条件Dto</param>
        /// <returns></returns>
        protected override IQueryable<Product> CreateFilteredQuery(ProductPagedDto input)
        {
            return base.CreateFilteredQuery(input)
                .WhereIf(!input.ExcludeId.IsNullOrWhiteSpace(), t => t.Id != input.ExcludeId) //不包含排除ID

                .WhereIf(!input.ProductNo.IsNullOrWhiteSpace(), t => t.ProductNo.Contains(input.ProductNo)) //如需要精确匹配则用Equals
                .WhereIf(!input.BarCode.IsNullOrWhiteSpace(), t => t.BarCode.Contains(input.BarCode)) //如需要精确匹配则用Equals
                .WhereIf(!input.MaterialCode.IsNullOrWhiteSpace(), t => t.MaterialCode.Contains(input.MaterialCode)) //如需要精确匹配则用Equals
                .WhereIf(!input.ProductType.IsNullOrWhiteSpace(), t => t.ProductType.Contains(input.ProductType)) //如需要精确匹配则用Equals
                .WhereIf(!input.ProductName.IsNullOrWhiteSpace(), t => t.ProductName.Contains(input.ProductName)) //如需要精确匹配则用Equals
                .WhereIf(!input.Unit.IsNullOrWhiteSpace(), t => t.Unit.Contains(input.Unit)) //如需要精确匹配则用Equals
                .WhereIf(!input.Note.IsNullOrWhiteSpace(), t => t.Note.Contains(input.Note)) //如需要精确匹配则用Equals
                .WhereIf(!input.Description.IsNullOrWhiteSpace(), t => t.Description.Contains(input.Description)) //如需要精确匹配则用Equals

                 //状态
                .WhereIf(input.Status.HasValue, t => t.Status==input.Status)

                 //成本价区间查询
                .WhereIf(input.PriceStart.HasValue, s => s.Price >= input.PriceStart.Value)
                .WhereIf(input.PriceEnd.HasValue, s => s.Price <= input.PriceEnd.Value)

                //销售价区间查询
                .WhereIf(input.SalePriceStart.HasValue, s => s.SalePrice >= input.SalePriceStart.Value)
                .WhereIf(input.SalePriceEnd.HasValue, s => s.SalePrice <= input.SalePriceEnd.Value)

                //特价区间查询
                .WhereIf(input.SpecialPriceStart.HasValue, s => s.SpecialPrice >= input.SpecialPriceStart.Value)
                .WhereIf(input.SpecialPriceEnd.HasValue, s => s.SpecialPrice <= input.SpecialPriceEnd.Value)
                .WhereIf(input.IsUseSpecial.HasValue, t => t.IsUseSpecial == input.IsUseSpecial) //如需要精确匹配则用Equals

                //最低折扣区间查询
                .WhereIf(input.LowestDiscountStart.HasValue, s => s.LowestDiscount >= input.LowestDiscountStart.Value)
                .WhereIf(input.LowestDiscountEnd.HasValue, s => s.LowestDiscount <= input.LowestDiscountEnd.Value)

                //创建日期区间查询
                .WhereIf(input.CreationTimeStart.HasValue, s => s.CreationTime >= input.CreationTimeStart.Value)
                .WhereIf(input.CreationTimeEnd.HasValue, s => s.CreationTime <= input.CreationTimeEnd.Value);
        }

        /// <summary>
        /// 自定义排序处理
        /// </summary>
        /// <param name="query">可查询LINQ</param>
        /// <param name="input">查询条件Dto</param>
        /// <returns></returns>
        protected override IQueryable<Product> ApplySorting(IQueryable<Product> query, ProductPagedDto input)
        {
            //按创建时间倒序排序
            return base.ApplySorting(query, input).OrderByDescending(s => s.CreationTime);//时间降序
        }

虽然我们一般在界面上不会放置所有的条件，但是高级查询模块倒是可以把分页条件DTO里面的条件全部摆上去的。

高级查询模块的条件如下所示。

我们高级查询里面的条件还是以GetAll里面的对象分页查询Dto里面的属性，我们需要根据这些条件进行构建，也需要以这些属性的类型进行一个控件的选择。

因此我们需要一个属性的名称说明，以及在高级查询模块的列表界面中对显示那些字段进行控制，如下代码所示。

        private FrmAdvanceSearch dlg;
        /// <summary>
        /// 高级查询的操作
        /// </summary>
        private async void AdvanceSearch()
        {
            if (dlg == null)
            {
                dlg = new FrmAdvanceSearch();
                dlg.SetFieldTypeList<ProductPagedDto>();//通过分页对象获取查询属性和类型
                dlg.ColumnNameAlias = await ProductApiCaller.Instance.GetColumnNameAlias();
                dlg.DisplayColumns = "ProductNo,BarCode,MaterialCode,ProductType,ProductName,Unit,Price,SalePrice,SpecialPrice,IsUseSpecial,LowestDiscount,Note,Description,Status,CreatorUserId,CreationTime";

通过 SetFieldTypeList<ProductPagedDto> 的处理，我们把分页对象的查询属性和类型赋值给了高级查询模块，让它根据类型来创建不同的输入显示，如常规的字符串、数值区段、日期区段，下拉列表等等。

对于下拉列表，我们需要绑定它的数据源，如下代码所示。

 dlg.AddColumnListItem("ProductType", await DictItemUtil.GetDictListItemByDictType("产品类型"));//字典列表
 dlg.AddColumnListItem("Status", await DictItemUtil.GetDictListItemByDictType("产品状态"));//字典列表

而对于一些常规的固定列表，也可以以类似的方式加入下拉列表

    //固定转义的列表
    var specialList = new List<CListItem>() { new CListItem("特价", "True"), new CListItem("一般", "False") };
    dlg.AddColumnListItem("IsUseSpecial", specialList);

或者

    dlg.AddColumnListItem("Sex", "男,女");//固定列表

因此整个调用高级查询模块的代码如下所示

    private FrmAdvanceSearch dlg;
    /// <summary>
    /// 高级查询的操作
    /// </summary>
    private async void AdvanceSearch()
    {
        if (dlg == null)
        {
            dlg = new FrmAdvanceSearch();
            dlg.SetFieldTypeList<ProductPagedDto>();//通过分页对象获取查询属性和类型
            dlg.ColumnNameAlias = await ProductApiCaller.Instance.GetColumnNameAlias();
            dlg.DisplayColumns = "ProductNo,BarCode,MaterialCode,ProductType,ProductName,Unit,Price,SalePrice,SpecialPrice,IsUseSpecial,LowestDiscount,Note,Description,Status,CreatorUserId,CreationTime";

            #region 下拉列表数据

            dlg.AddColumnListItem("ProductType", await DictItemUtil.GetDictListItemByDictType("产品类型"));//字典列表
            dlg.AddColumnListItem("Status", await DictItemUtil.GetDictListItemByDictType("产品状态"));//字典列表

            //固定转义的列表
            var specialList = new List<CListItem>() { new CListItem("特价", "True"), new CListItem("一般", "False") };
            dlg.AddColumnListItem("IsUseSpecial", specialList);

            //dlg.AddColumnListItem("Sex", "男,女");//固定列表
            //dlg.AddColumnListItem("Credit", await ProductApiCaller.Instance.GetFieldList("Credit"));//动态列表

            #endregion

            dlg.ConditionChanged += new FrmAdvanceSearch.ConditionChangedEventHandler(dlg_ConditionChanged);
        }
        dlg.ShowDialog();
    }

在处理获取数据GetData函数的时候，我们需要根据高级查询进行一定的切换，以便显示正确的过滤条件，如下代码所示是获取数据的处理。

        /// <summary>
        /// 获取数据
        /// </summary>
        /// <returns></returns>
        private async Task<IPagedResult<ProductDto>> GetData()
        {
            ProductPagedDto pagerDto = null;
            if (advanceCondition != null)
            {
                pagerDto = new ProductPagedDto(this.winGridViewPager1.PagerInfo);
                pagerDto = dlg.GetPagedResult(pagerDto);
            }
            else
            {
                //构建分页的条件和查询条件
                pagerDto = new ProductPagedDto(this.winGridViewPager1.PagerInfo)
                {
                    //添加所需条件
                    ProductNo = this.txtProductNo.Text.Trim(),
                    BarCode = this.txtBarCode.Text.Trim(),
                    MaterialCode = this.txtMaterialCode.Text.Trim(),
                    ProductType = this.txtProductType.Text.Trim(),
                    ProductName = this.txtProductName.Text.Trim(),
                    Description = this.txtDescription.Text.Trim(),
                };

                //日期和数值范围定义
                //创建时间，需在ProductPagedDto中添加DateTime?类型字段CreationTimeStart和CreationTimeEnd
                var CreationTime = new TimeRange(this.txtCreationTime1.Text, this.txtCreationTime2.Text); //日期类型
                pagerDto.CreationTimeStart = CreationTime.Start;
                pagerDto.CreationTimeEnd = CreationTime.End;

            }

            var result = await ProductApiCaller.Instance.GetAll(pagerDto);
            return result;
        }

在高级查询的处理方式下，我们是传入一个列表的分页对象属性，然后传入一个分页DTO对象，就可以构建出我们需要的分页查询条件，传递给Web API端获取对应条件的数据了。

    pagerDto = new ProductPagedDto(this.winGridViewPager1.PagerInfo);
    pagerDto = dlg.GetPagedResult(pagerDto);        

而高级查询模块，所需要处理的逻辑就是需要根据不同的属性类型，赋值常规的属性值或者区段属性值，从而构建出分页对应的属性条件即可。

如果是区段（包括日期或者数值）的，我们分页查询条件里面，会有一个ABCStart,ABCEnd的对象属性，依照这个规则，获取到对应的用户输入，采用反射方式赋值DTO对象即可。