技術文章 » 基於SqlSugar的開發框架循序漸進介紹（31）-- 在查詢介面中實現多表聯合和單表物件的統一處理

基於SqlSugar的開發框架循序漸進介紹（31）-- 在查詢介面中實現多表聯合和單表物件的統一處理

2023-06-03 09:00:16

在一些複雜的業務表中間查詢資料，有時候操作會比較複雜一些，不過基於SqlSugar的相關操作，處理的程式碼會比較簡單一些，以前我在隨筆《基於SqlSugar的開發框架循序漸進介紹（2）-- 基於中間表的查詢處理》介紹過基於主表和中間表的聯合查詢，而往往實際會比這個會複雜一些。本篇隨筆介紹聯合多個表進行查詢以及樹形列表的條件展示的處理實現，系統能夠給大家一些參考思路。

1、SqlSugar的開發框架的資料查詢處理

在隨筆《基於SqlSugar的開發框架循序漸進介紹（2）-- 基於中間表的查詢處理》中，介紹過兩個表的聯合查詢，如下所示程式碼所示。

/// <summary>
/// 根據使用者ID獲取對應的角色列表
/// </summary>
/// <param name="userID">使用者ID</param>
/// <returns></returns>
private async Task<List<RoleInfo>> GetByUser(int userID)
{
    var query = this.Client.Queryable<RoleInfo, User_RoleInfo>(
    (t, m) => t.Id == m.Role_ID && m.User_ID == userID)
    .Select(t => t); //聯合條件獲取物件

    query = query.OrderBy(t => t.CreateTime);//排序
    var list = await query.ToListAsync();//獲取列表
    return list;
}

/// <summary>
/// 根據機構獲取對應的角色列表(判斷機構角色中間表）
/// </summary>
/// <param name="ouID">機構的ID</param>
/// <returns></returns>
public async Task<List<RoleInfo>> GetRolesByOu(int ouID)
{
    var query = this.Client.Queryable<RoleInfo, OU_RoleInfo>(
    (t, m) => t.Id == m.Role_ID && m.Ou_ID == ouID)
    .Select(t => t); //聯合條件獲取物件

    query = query.OrderBy(t => t.CreateTime);//排序
    var list = await query.ToListAsync();//獲取列表
    return list;
}

我們對於後端的資料查詢，一般都是傳入一個條件物件，通過條件類的屬性進行構建查詢資訊，如下簡單的處理操作。

/// <summary>
/// 應用層服務介面實現
/// </summary>
public class CustomerService : MyCrudService<CustomerInfo, string, CustomerPagedDto>, ICustomerService
{
    /// <summary>
    /// 自定義條件處理
    /// </summary>
    /// <param name="input">查詢條件Dto</param>
    /// <returns></returns>
    protected override ISugarQueryable<CustomerInfo> CreateFilteredQueryAsync(CustomerPagedDto input)
    {
        var query = base.CreateFilteredQueryAsync(input);

        query = query
            .WhereIF(!input.ExcludeId.IsNullOrWhiteSpace(), t => t.Id != input.ExcludeId) //不包含排除ID
            .WhereIF(!input.Name.IsNullOrWhiteSpace(), t => t.Name.Contains(input.Name)) //如需要精確匹配則用Equals
                                                                                         //年齡區間查詢
            .WhereIF(input.AgeStart.HasValue, s => s.Age >= input.AgeStart.Value)
            .WhereIF(input.AgeEnd.HasValue, s => s.Age <= input.AgeEnd.Value)

            //建立日期區間查詢
            .WhereIF(input.CreateTimeStart.HasValue, s => s.CreateTime >= input.CreateTimeStart.Value)
            .WhereIF(input.CreateTimeEnd.HasValue, s => s.CreateTime <= input.CreateTimeEnd.Value)
            ;

        return query;
    }

上面的 CreateFilteredQueryAsync 方法是一個基礎類別函數，主要是構建該業務表的一些資料查詢的匹配處理，如對於複雜一些的查詢條件，這個內容會增加很多，不過都是可以通過程式碼生成工具基於資料庫表欄位來進行一一對應的生成，從而避免人工繁瑣的敲擊程式碼。

如下面是基礎類別函數的常規條件查詢和計數的函數處理。

/// <summary>
/// 根據條件獲取列表
/// </summary>
/// <param name="input">分頁查詢條件</param>
/// <returns></returns>
public virtual async Task<PagedResultDto<TEntity>> GetListAsync(TGetListInput input)
{
    var query = CreateFilteredQueryAsync(input);
    var totalCount = await query.CountAsync();

    query = ApplySorting(query, input);
    query = ApplyPaging(query, input);

    var list = await query.ToListAsync();

    return new PagedResultDto<TEntity>(
       totalCount,
       list
   );
}

/// <summary>
/// 根據條件計算記錄數量
/// </summary>
/// <param name="input">查詢條件，忽略分頁資訊</param>
/// <returns></returns>
public virtual async Task<long> CountAsync(TGetListInput input)
{
    var query = CreateFilteredQueryAsync(input);

    var totalCount = await query.CountAsync();
    return totalCount; //返回符合條件的所有數量
}

上面的 CreateFilteredQueryAsync 方法一般會在具體的業務類中進行重寫，從而實現具體條件的查詢過濾。

 

2、對於多表的聯合處理操作

而對於複雜的多表之間的聯合查詢處理，如果分開多個函數來實現，可能會比較麻煩，而且也不夠統一，因此我們可以統一整合在CreateFilteredQueryAsync 實現。

而一些特殊的條件，我們可以在原有生成的條件分頁類裡面，增加更多的屬性，用來在聯合查詢中賦值、或者獲取值。如下圖是我們額外增加的幾個特殊的屬性，用來在其他業務表中進行關聯查詢的欄位。

由於客戶分組是在另外一張表裡面記錄的，客戶和分組之間的關聯，是通過中間表的聯合查詢獲得的。

 客戶和供應商也有一箇中間表的關聯關係，因此我們如何聯合查詢，根據條件，可以通過下面的程式碼進行聯合查詢獲得。

            if (!input.GroupId.IsNullOrWhiteSpace())
            {
                // 聯合 CustomerGroup_CustomerInfo 表進行查詢
                query = this.Client.Queryable<CustomerInfo, CustomerGroup_CustomerInfo>(
                       (t, m) => t.Id == m.Customer_ID && m.CustomerGroup_ID == input.GroupId)
                       .Select(t => t).MergeTable(); //聯合條件獲取物件
            }       
            if(!input.SupplierId.IsNullOrEmpty())
            {
                query = this.Client.Queryable<CustomerInfo, Customer_SupplierInfo>(
                        (t, m) => t.Id == m.Customer_ID && m.Supplier_ID == input.SupplierId)
                        .Select(t => t).MergeTable(); //聯合條件獲取物件
            }

上面的程式碼，需要注意的是，不同表之間聯合獲得的結果，如果需要整合到主表進行的查詢中，則需要使用 .MergeTable() 操作進行合併處理。

這種最終我們可以得到比較複雜一些的查詢處理了。

        /// <summary>
        /// 自定義條件處理
        /// </summary>
        /// <param name="input">查詢條件Dto</param>
        /// <returns></returns>
        protected override ISugarQueryable<CustomerInfo> CreateFilteredQueryAsync(CustomerPagedDto input)
        {
            var query = base.CreateFilteredQueryAsync(input);
            if (!input.GroupId.IsNullOrWhiteSpace())
            {
                // 聯合 CustomerGroup_CustomerInfo 表進行查詢
                query = this.Client.Queryable<CustomerInfo, CustomerGroup_CustomerInfo>(
                       (t, m) => t.Id == m.Customer_ID && m.CustomerGroup_ID == input.GroupId)
                       .Select(t => t).MergeTable(); //聯合條件獲取物件
            }       
            if(!input.SupplierId.IsNullOrEmpty())
            {
                query = this.Client.Queryable<CustomerInfo, Customer_SupplierInfo>(
                        (t, m) => t.Id == m.Customer_ID && m.Supplier_ID == input.SupplierId)
                        .Select(t => t).MergeTable(); //聯合條件獲取物件
            }

            //通過名稱或程式碼查詢，任一符合即可
            query = query.WhereIF(!input.NameOrCode.IsNullOrWhiteSpace(), t => t.Name.Contains(input.NameOrCode) || t.SimpleName.Contains(input.NameOrCode) || t.HandNo.Contains(input.NameOrCode));

            query = query
               .WhereIF(!input.ExcludeId.IsNullOrWhiteSpace(), t => t.Id != input.ExcludeId) //不包含排除ID
               .WhereIF(!input.HandNo.IsNullOrWhiteSpace(), t => t.HandNo.Contains(input.HandNo)) //如需要精確匹配則用Equals
                .WhereIF(!input.Name.IsNullOrWhiteSpace(), t => t.Name.Contains(input.Name)) //如需要精確匹配則用Equals
                .WhereIF(!input.SimpleName.IsNullOrWhiteSpace(), t => t.SimpleName.Contains(input.SimpleName)) //如需要精確匹配則用Equals
                .WhereIF(!input.Province.IsNullOrWhiteSpace(), t => t.Province.Contains(input.Province)) //如需要精確匹配則用Equals
                .WhereIF(!input.City.IsNullOrWhiteSpace(), t => t.City.Contains(input.City)) //如需要精確匹配則用Equals
                .WhereIF(!input.District.IsNullOrWhiteSpace(), t => t.District.Contains(input.District)) //如需要精確匹配則用Equals
                .WhereIF(!input.Area.IsNullOrWhiteSpace(), t => t.Area.Contains(input.Area)) //如需要精確匹配則用Equals
                .WhereIF(!input.Address.IsNullOrWhiteSpace(), t => t.Address.Contains(input.Address)) //如需要精確匹配則用Equals
                .WhereIF(!input.ZipCode.IsNullOrWhiteSpace(), t => t.ZipCode.Contains(input.ZipCode)) //如需要精確匹配則用Equals
                .WhereIF(!input.Telephone.IsNullOrWhiteSpace(), t => t.Telephone.Contains(input.Telephone)) //如需要精確匹配則用Equals
                .WhereIF(!input.Fax.IsNullOrWhiteSpace(), t => t.Fax.Contains(input.Fax)) //如需要精確匹配則用Equals
                .WhereIF(!input.Contact.IsNullOrWhiteSpace(), t => t.Contact.Contains(input.Contact)) //如需要精確匹配則用Equals
                .WhereIF(!input.ContactPhone.IsNullOrWhiteSpace(), t => t.ContactPhone.Contains(input.ContactPhone)) //如需要精確匹配則用Equals
                .WhereIF(!input.ContactMobile.IsNullOrWhiteSpace(), t => t.ContactMobile.Contains(input.ContactMobile)) //如需要精確匹配則用Equals
                .WhereIF(!input.Email.IsNullOrWhiteSpace(), t => t.Email.Contains(input.Email)) //如需要精確匹配則用Equals
                .WhereIF(!input.QQ.IsNullOrWhiteSpace(), t => t.QQ.Contains(input.QQ)) //如需要精確匹配則用Equals
                .WhereIF(!input.Industry.IsNullOrWhiteSpace(), t => t.Industry.Contains(input.Industry)) //如需要精確匹配則用Equals
                .WhereIF(!input.BusinessScope.IsNullOrWhiteSpace(), t => t.BusinessScope.Contains(input.BusinessScope)) //如需要精確匹配則用Equals
                .WhereIF(!input.Brand.IsNullOrWhiteSpace(), t => t.Brand.Contains(input.Brand)) //如需要精確匹配則用Equals
                .WhereIF(!input.PrimaryClient.IsNullOrWhiteSpace(), t => t.PrimaryClient.Contains(input.PrimaryClient)) //如需要精確匹配則用Equals
                .WhereIF(!input.PrimaryBusiness.IsNullOrWhiteSpace(), t => t.PrimaryBusiness.Contains(input.PrimaryBusiness)) //如需要精確匹配則用Equals
                                                                                                                              //註冊資金區間查詢
               .WhereIF(input.RegisterCapitalStart.HasValue, s => s.RegisterCapital >= input.RegisterCapitalStart.Value)
               .WhereIF(input.RegisterCapitalEnd.HasValue, s => s.RegisterCapital <= input.RegisterCapitalEnd.Value)
               //營業額區間查詢
               .WhereIF(input.TurnOverStart.HasValue, s => s.TurnOver >= input.TurnOverStart.Value)
               .WhereIF(input.TurnOverEnd.HasValue, s => s.TurnOver <= input.TurnOverEnd.Value)
                .WhereIF(!input.LicenseNo.IsNullOrWhiteSpace(), t => t.LicenseNo.Contains(input.LicenseNo)) //如需要精確匹配則用Equals
                .WhereIF(!input.Bank.IsNullOrWhiteSpace(), t => t.Bank.Contains(input.Bank)) //如需要精確匹配則用Equals
                .WhereIF(!input.BankAccount.IsNullOrWhiteSpace(), t => t.BankAccount.Contains(input.BankAccount)) //如需要精確匹配則用Equals
                .WhereIF(!input.LocalTaxNo.IsNullOrWhiteSpace(), t => t.LocalTaxNo.Contains(input.LocalTaxNo)) //如需要精確匹配則用Equals
                .WhereIF(!input.NationalTaxNo.IsNullOrWhiteSpace(), t => t.NationalTaxNo.Contains(input.NationalTaxNo)) //如需要精確匹配則用Equals
                .WhereIF(!input.LegalMan.IsNullOrWhiteSpace(), t => t.LegalMan.Contains(input.LegalMan)) //如需要精確匹配則用Equals
                .WhereIF(!input.LegalTelephone.IsNullOrWhiteSpace(), t => t.LegalTelephone.Contains(input.LegalTelephone)) //如需要精確匹配則用Equals
                .WhereIF(!input.LegalMobile.IsNullOrWhiteSpace(), t => t.LegalMobile.Contains(input.LegalMobile)) //如需要精確匹配則用Equals
                .WhereIF(!input.Source.IsNullOrWhiteSpace(), t => t.Source.Contains(input.Source)) //如需要精確匹配則用Equals
                .WhereIF(!input.WebSite.IsNullOrWhiteSpace(), t => t.WebSite.Contains(input.WebSite)) //如需要精確匹配則用Equals
                .WhereIF(!input.CompanyPictureGUID.IsNullOrWhiteSpace(), t => t.CompanyPictureGUID.Contains(input.CompanyPictureGUID)) //如需要精確匹配則用Equals
                .WhereIF(!input.CustomerType.IsNullOrWhiteSpace(), t => t.CustomerType.Contains(input.CustomerType)) //如需要精確匹配則用Equals
                .WhereIF(!input.Grade.IsNullOrWhiteSpace(), t => t.Grade.Contains(input.Grade)) //如需要精確匹配則用Equals
                .WhereIF(!input.CreditStatus.IsNullOrWhiteSpace(), t => t.CreditStatus.Contains(input.CreditStatus)) //如需要精確匹配則用Equals
                .WhereIF(!input.Importance.IsNullOrWhiteSpace(), t => t.Importance.Contains(input.Importance)) //如需要精確匹配則用Equals
                .WhereIF(input.IsPublic.HasValue, t => t.IsPublic == input.IsPublic) //如需要精確匹配則用Equals
                .WhereIF(input.Satisfaction.HasValue, t => t.Satisfaction == input.Satisfaction) //如需要精確匹配則用Equals
                .WhereIF(!input.Note.IsNullOrWhiteSpace(), t => t.Note.Contains(input.Note)) //如需要精確匹配則用Equals
                .WhereIF(input.TransactionCount.HasValue, t => t.TransactionCount == input.TransactionCount) //如需要精確匹配則用Equals
              
                //交易金額區間查詢
               .WhereIF(input.TransactionTotalStart.HasValue, s => s.TransactionTotal >= input.TransactionTotalStart.Value)
               .WhereIF(input.TransactionTotalEnd.HasValue, s => s.TransactionTotal <= input.TransactionTotalEnd.Value)
               //首次交易時間區間查詢
               .WhereIF(input.TransactionFirstDayStart.HasValue, s => s.TransactionFirstDay >= input.TransactionFirstDayStart.Value)
               .WhereIF(input.TransactionFirstDayEnd.HasValue, s => s.TransactionFirstDay <= input.TransactionFirstDayEnd.Value)
               //最近交易時間區間查詢
               .WhereIF(input.TransactionLastDayStart.HasValue, s => s.TransactionLastDay >= input.TransactionLastDayStart.Value)
               .WhereIF(input.TransactionLastDayEnd.HasValue, s => s.TransactionLastDay <= input.TransactionLastDayEnd.Value)
               //最近聯絡日期區間查詢
               .WhereIF(input.LastContactDateStart.HasValue, s => s.LastContactDate >= input.LastContactDateStart.Value)
               .WhereIF(input.LastContactDateEnd.HasValue, s => s.LastContactDate <= input.LastContactDateEnd.Value)
                                                                                                      
               //建立時間區間查詢
               .WhereIF(input.CreateTimeStart.HasValue, s => s.CreateTime >= input.CreateTimeStart.Value)
               .WhereIF(input.CreateTimeEnd.HasValue, s => s.CreateTime <= input.CreateTimeEnd.Value)   
               //編輯時間區間查詢
               .WhereIF(input.EditTimeStart.HasValue, s => s.EditTime >= input.EditTimeStart.Value)
               .WhereIF(input.EditTimeEnd.HasValue, s => s.EditTime <= input.EditTimeEnd.Value)

               .WhereIF(!input.Stage.IsNullOrWhiteSpace(), t => t.Stage.Contains(input.Stage)) //如需要精確匹配則用Equals
               .WhereIF(!input.Status.IsNullOrWhiteSpace(), s => s.Status == input.Status)
               .WhereIF(!input.Creator.IsNullOrWhiteSpace(), t => t.Creator.Contains(input.Creator)) //如需要精確匹配則用Equals
               .WhereIF(!input.Editor.IsNullOrWhiteSpace(), t => t.Editor.Contains(input.Editor)) //如需要精確匹配則用Equals
               .WhereIF(input.Deleted.HasValue, s => s.Deleted == input.Deleted)
               .WhereIF(!input.Dept_ID.IsNullOrWhiteSpace(), t => t.Dept_ID.Contains(input.Dept_ID)) //如需要精確匹配則用Equals
               .WhereIF(!input.Company_ID.IsNullOrWhiteSpace(), t => t.Company_ID.Contains(input.Company_ID)) //如需要精確匹配則用Equals
               .WhereIF(!input.MarkColor.IsNullOrWhiteSpace(), t => t.MarkColor.Contains(input.MarkColor)) //如需要精確匹配則用Equals
               .WhereIF(!input.ShareUsers.IsNullOrWhiteSpace(), t => t.ShareUsers.Contains(input.ShareUsers)) //如需要精確匹配則用Equals
               ;

            return query;
        }

有了這個豐富條件的處理，我們就可以在前端進行屬性賦值就可以了，簡單的呼叫後端通用的介面查詢即可。

//構建分頁的條件和查詢條件
pagerDto = new CustomerPagedDto(this.winGridViewPager1.PagerInfo)
{
    //新增所需條件
    NameOrCode = this.txtCustomerNo.Text.Trim(),
    Deleted = 0
};

查詢獲得介面資料處理如下程式碼所示。

var result = await BLLFactory<ICustomerService>.Instance.GetListAsync(pagerDto);
return result;

在分頁列表中展示獲得的記錄詳細資訊如下程式碼所示。

/// <summary>
/// 繫結列表資料
/// </summary>
private async void BindData()
{
    //entity
    this.winGridViewPager1.DisplayColumns = displayColumns;
    this.winGridViewPager1.ColumnNameAlias = await BLLFactory<ICustomerService>.Instance.GetColumnNameAlias();//欄位列顯示名稱跳脫

    //獲取分頁資料列表
    var result = await GetData();

    //設定所有記錄數和列表資料來源
    this.winGridViewPager1.PagerInfo.RecordCount = result.TotalCount; //需先於DataSource的賦值，更新分頁資訊
    this.winGridViewPager1.DataSource = result.Items;
    this.winGridViewPager1.PrintTitle = "客戶資訊列表";
}

 

3、對於多種屬性、狀態條件的統一處理

我在之前介紹過的CRM系統主介面中，關於客戶關係資訊的展示的時候，是通過一個複雜的樹形列表來承載不同屬性來進行快速的查詢，如下介面所示。

這些樹形列表的屬性資訊，在SqlSugar開發框架中，我們統一進行生成，首先定義一個通用的承載物件，如下類所示。

/// <summary>
/// 對CRM的業務資料進行統計的一個公共類
/// </summary>
public class CrmStaticsDto
{
    /// <summary>
    /// 節點顯示名稱
    /// </summary>
    public string Label { get; set; }

    /// <summary>
    /// 屬性名稱
    /// </summary>
    public string TypeName { get; set; }

    /// <summary>
    /// 數量
    /// </summary>
    public long Count { get; set; }

    /// <summary>
    /// 業務分類
    /// </summary>
    public string Category { get; set; }

    /// <summary>
    /// 記錄的日期開始
    /// </summary>
    public DateTime? DateStart { get; set; }
    /// <summary>
    /// 記錄的日期結束
    /// </summary>
    public DateTime? DateEnd { get; set; }

    /// <summary>
    /// 建立人資訊
    /// </summary>
    public CListItem Creator { get; set; }

    /// <summary>
    /// 子節點集合
    /// </summary>
    public List<CrmStaticsDto> children { get; set; } = new List<CrmStaticsDto>();
}

這個類似一個巢狀的集合，通過children進行新增更多的子集記錄。

後端提供一個獲取統計資訊的樹形列表的方法，如下定義所示。

        /// <summary>
        /// 獲取列表統計資訊
        /// </summary>
        /// <returns></returns>
        public async Task<List<CrmStaticsDto>> GetStatics(string compnayId)
        {
           ................
        }

但我們為它新增各種屬性的時候，設定相關的節點文字、類別資訊即可。

    //所有記錄
    var allNode = new CrmStaticsDto()
    {
        Label = "所有記錄"
    };
    list.Add(allNode);

    var propertyNode = new CrmStaticsDto()
    {
        Label = "客戶屬性分類"
    };
    list.Add(propertyNode);


    var typeName = "客戶狀態";
    var count = await baseQuery.Clone().CountAsync();//Clone()避免進行多次查詢時，可能會出現結果不正確的問題
    var statusNode = new CrmStaticsDto()
    {
        Label = $"{typeName}({count})",
        Count = count,
        TypeName = typeName
    };
    var dict = await dictDataService.FindByDictType(typeName);
    foreach (var info in dict)
    {
        var value = info.Value;
        var subCount = baseQuery.Clone().Where(s => s.Status == value).Count();
        statusNode.children.Add(new CrmStaticsDto()
        {
            Label = $"{info.Name}({subCount})",
            Count = subCount,
            Category = info.Value,
            TypeName = typeName
        });
    }
    propertyNode.children.Add(statusNode);

這樣我們在前端的WInform介面中展示樹形列表的時候，就會變得非常簡單，通過一個遞迴的函數就可以新增相關的節點資訊了，如下程式碼所示。

private async void InitTree()
{
    this.treeView1.BeginUpdate();
    this.treeView1.Nodes.Clear();

    //獲取所有的統計列表
    var staticsList = await BLLFactory<ICustomerService>.Instance.GetStatics(this.SelectedCompanyID);
    await AddTreeData(staticsList, null);

    //this.treeView1.ExpandAll();
    this.treeView1.EndUpdate();
}

private async Task AddTreeData(List<CrmStaticsDto> staticsList, TreeNode parentNode = null)
{
    var i = 0;
    if (staticsList != null)
    {
        foreach (var info in staticsList)
        {
            var node = new TreeNode(info.Label, i, i);
            node.Tag = info;
            node.Text = info.Label;

            await AddTreeData(info.children, node);

            if (parentNode == null)
            {
                this.treeView1.Nodes.Add(node); //如果是頂級處理，則treeView1節點加入
            }
            else
            {
                parentNode.Nodes.Add(node); //如果是遞迴的，則加到父節點上
            }
        }
    }
}

以上就是對聯合多個表進行查詢以及樹形列表的條件展示的處理思路，系統能夠給大家一些參考思路。