還在拼冗長的WhereIf嗎？100行代碼解放這個操作

来源:https://www.cnblogs.com/fanshaoO/p/18233291
-Advertisement-
Play Games

通常我們在做一些數據過濾的操作的時候，經常需要做一些判斷再進行是否要對其進行條件過濾。 普通做法 最原始的做法我們是先通過If()判斷是否需要進行數據過濾，然後再對數據源使用Where來過濾數據。 示例如下： if(!string.IsNullOrWhiteSpace(str)) { query = ...


通常我們在做一些數據過濾的操作的時候，經常需要做一些判斷再進行是否要對其進行條件過濾。

普通做法

最原始的做法我們是先通過If()判斷是否需要進行數據過濾，然後再對數據源使用Where來過濾數據。
示例如下：

if(!string.IsNullOrWhiteSpace(str))
{
    query = query.Where(a => a == str);
}

封裝WhereIf做法

進階一些的就把普通做法的代碼封裝成一個擴展方法，WhereIf指代一個名稱，也可以有其他名稱，本質是一樣的。
示例如下：

public static IQueryable<T> WhereIf<T>([NotNull] this IQueryable<T> query, bool condition, Expression<Func<T, int, bool>> predicate)
{
    return condition
        ? query.Where(predicate)
        : query;
}

使用方式：

query.WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str);

封裝WhereIf做法相比普通做法，已經可以減少我們代碼的很多If塊了，看起來也優雅一些。
但是如果查詢條件增多的話，我們依舊需要寫很多WhereIf，就會有這種現象：

query
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str)
      .WhereIf(!string.IsNullOrWhiteSpace(str), a => a == str);

條件一但增多很多的話，這樣一來代碼看起來就又不夠優雅了~

這時候就想，如果只用一個Where傳進去一個對象，自動解析條件進行數據過濾，是不是就很棒呢~

WhereObj做法

想法來了，那就動手實現一下。

首先我們需要考慮如何對對象的屬性進行標記來獲取我們作為條件過濾的對應屬性。那就得加一個Attribute，這裡實現一個CompareAttribute，用於對對象的屬性進行標記。

[AttributeUsage(AttributeTargets.Property)]
public class CompareAttribute : Attribute
{
    public CompareAttribute(CompareType compareType)
    {
        CompareType = compareType;
    }

    public CompareAttribute(CompareType compareType, string compareProperty) : this(compareType)
    {
        CompareProperty = compareProperty;
    }

    public CompareType CompareType { get; set; }

    public CompareSite CompareSite { get; set; } = CompareSite.LEFT;

    public string? CompareProperty { get; set; }
}

public enum CompareType
{
    Equal,
    NotEqual,
    GreaterThan,
    GreaterThanOrEqual,
    LessThan,
    LessThanOrEqual,
    Contains,
    StartsWith,
    EndsWith,
    IsNull,
    IsNotNull
}

public enum CompareSite
{
    RIGHT,
    LEFT
}

這裡CompareType表示要進行比較的操作，很簡單，一目瞭然。
CompareSite則表示在進行比較的時候比較的數據處於比較符左邊還是右邊，在CompareAttribute給與預設值在左邊，表示比較的源數據處於左邊。比如Contains操作，有時候是判斷源字元串是否包含子字元串，此時應該是sourceStr.Contains(str),有時候是判斷源字元串是否在某個集合字元串中則是ListString.Contains(sourceStr)。
CompareProperty則表示比較的屬性名稱，空的話則直接使用對象名稱，如果有值則優先使用。

Attribute搞定了，接下來則實現我們的WhereObj
這裡由於需要動態的拼接表達式，這裡使用了DynamicExpresso.Core庫來進行動態表達式生成。
先上代碼：

namespace System.Linq;

public static class WhereExtensions
{
    public static IQueryable<T> WhereObj<T>(this IQueryable<T> queryable, object parameterObject)
    {
        var interpreter = new Interpreter();
        interpreter = interpreter.SetVariable("o", parameterObject);
        var properties = parameterObject.GetType().GetProperties().Where(p => p.CustomAttributes.Any(a=>a.AttributeType == typeof(CompareAttribute)));
        var whereExpression = new StringBuilder();
        foreach (var property in properties)
        {
            if(property.GetValue(parameterObject) == null)
            {
                continue;
            }

            var compareAttribute = property.GetCustomAttribute<CompareAttribute>();

            var propertyName = compareAttribute!.CompareProperty ?? property.Name;

            if (typeof(T).GetProperty(propertyName) == null)
            {
                continue;
            }

            if (whereExpression.Length > 0)
            {
                whereExpression.Append(" && ");
            }

            whereExpression.Append(BuildCompareExpression(propertyName, property, compareAttribute.CompareType, compareAttribute.CompareSite));
        }

        if(whereExpression.Length > 0)
        {
            return queryable.Where(interpreter.ParseAsExpression<Func<T, bool>>(whereExpression.ToString(), "q"));
        }
        return queryable;
    }
    public static IEnumerable<T> WhereObj<T>(this IEnumerable<T> enumerable, object parameterObject)
    {
        var interpreter = new Interpreter();
        interpreter = interpreter.SetVariable("o", parameterObject);
        var properties = parameterObject.GetType().GetProperties().Where(p => p.CustomAttributes.Any(a=>a.AttributeType == typeof(CompareAttribute)));
        var whereExpression = new StringBuilder();
        foreach (var property in properties)
        {
            if(property.GetValue(parameterObject) == null)
            {
                continue;
            }

            var compareAttribute = property.GetCustomAttribute<CompareAttribute>();

            var propertyName = compareAttribute!.CompareProperty ?? property.Name;

            if (typeof(T).GetProperty(propertyName) == null)
            {
                continue;
            }

            if (whereExpression.Length > 0)
            {
                whereExpression.Append(" && ");
            }

            whereExpression.Append(BuildCompareExpression(propertyName, property, compareAttribute.CompareType, compareAttribute.CompareSite));
        }

        if(whereExpression.Length > 0)
        {
            return enumerable.Where(interpreter.ParseAsExpression<Func<T, bool>>(whereExpression.ToString(), "q").Compile());
        }
        return enumerable;
    }

    private static string BuildCompareExpression(string propertyName, PropertyInfo propertyInfo, CompareType compareType, CompareSite compareSite)
    {
        var source = $"q.{propertyName}";
        var target = $"o.{propertyInfo.Name}";
        return compareType switch
        {
            CompareType.Equal => compareSite == CompareSite.LEFT ? $"{source} == {target}" : $"{target} == {source}",
            CompareType.NotEqual => compareSite == CompareSite.LEFT ? $"{source} != {target}" : $"{target} != {source}",
            CompareType.GreaterThan => compareSite == CompareSite.LEFT ? $"{source} < {target}" : $"{target} > {source}",
            CompareType.GreaterThanOrEqual => compareSite == CompareSite.LEFT ? $"{source} <= {target}" : $"{target} >= {source}",
            CompareType.LessThan => compareSite == CompareSite.LEFT ? $"{source} > {target}" : $"{target} < {source}",
            CompareType.LessThanOrEqual => compareSite == CompareSite.LEFT ? $"{source} >= {target}" : $"{target} <= {source}",
            CompareType.Contains => compareSite == CompareSite.LEFT ? $"{source}.Contains({target})" : $"{target}.Contains({source})",
            CompareType.StartsWith => compareSite == CompareSite.LEFT ? $"{source}.StartsWith({target})" : $"{target}.StartsWith({source})",
            CompareType.EndsWith => compareSite == CompareSite.LEFT ? $"{source}.EndsWith({target})" : $"{target}.EndsWith({source})",
            CompareType.IsNull => $"{source} == null",
            CompareType.IsNotNull => $"{source} != null",
            _ => throw new NotSupportedException()
        };
    }
}

代碼對IEnumerable和IQueryable都進行了擴展，總共行數100行。
在WhereObj中，我們傳入一個parameterObject，然後獲取對象的所有加了CompareAttribute的屬性。
然後進行迴圈拼接條件。在迴圈中我們先判斷屬性是否有值，有值才會添加表達式。所以建議條件屬性都為可空類型。

if(property.GetValue(parameterObject) == null)
{
    continue;
}

然後獲取屬性的CompareAttribute， 先指定條件屬性名稱，在判斷屬性是否在源對象存在，如果不存在則不處理。

if (typeof(T).GetProperty(propertyName) == null)
{
    continue;
}

最後就是根據CompareType來動態生成拼接的表達式了。
BuildCompareExpression方法根據CompareType和CompareSite動態拼接表達式字元串，然後使用Interpreter.ParseAsExpression<Func<T, bool>>轉換成我們的表達式類型。就完成啦。

測試效果

搞一個Customer類和CustomerFilter，再搞一個數據。

namespace Test
{
    public class Customer
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public char Gender { get; set; }
    }
    public class CustomerFilter
    {
        [Compare(CompareType.StartsWith)]
        public string? Name { get; set; }
        [Compare(CompareType.Contains, "Name", CompareSite = CompareSite.RIGHT)]
        public List<string>? Names { get; set; }
        [Compare(CompareType.GreaterThan)]
        public int? Age { get; set; }
        [Compare(CompareType.Equal)]
        public char? Gender { get; set; }
    }

    public class T
    {
        public static IEnumerable<Customer> customers = (new List<Customer> {
            new Customer() { Name = "David", Age = 31, Gender = 'M' },
            new Customer() { Name = "Mary", Age = 29, Gender = 'F' },
            new Customer() { Name = "Jack", Age = 2, Gender = 'M' },
            new Customer() { Name = "Marta", Age = 1, Gender = 'F' },
            new Customer() { Name = "Moses", Age = 120, Gender = 'M' },
            }).AsEnumerable();
    }

}

測試代碼

T.customers.WhereObj(new CustomerFilter() 
{
    //Name = "M",
    Names = ["Mary", "Jack"],
    //Age = 20,
    //Gender = 'M'
})
    .ToList().ForEach(c => Console.WriteLine(c.Name));


可以看到正常執行。
這樣我們在應對條件很多的數據過濾的時候，就可以只用一個WhereObj就可以代替很多個WhereIf的拼接了。同時，在添加新條件的時候我們也無需修改其他業務代碼。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Python中os.walk()模塊
    隨著軟體項目進入“維護模式”，對可讀性和編碼標準的要求很容易落空（甚至從一開始就沒有建立過那些標準）。然而，在代碼庫中保持一致的代碼風格和測試標準能夠顯著減輕維護的壓力，也能確保新的開發者能夠快速瞭解項目的情況，同時能更好地全程保持應用程式的質量。 使用外部庫來檢查代碼的質量不失為保護項目未來可維護 ...
  • 使用Wesky.Net.Opentools庫，一行代碼實現自動解析實體類summary註釋信息（可用於數據實體文檔的快速實現）
    使用前，需要對你的項目勾選輸出api文檔文件。 引用Wesky.Net.OpenTools包，保持1.0.11版本或以上。 為了方便，我直接在昨天的演示基礎上，繼續給實體類添加註釋。 昨天的演示文章可參考： C#/.NET一行代碼把實體類類型轉換為Json數據字元串 https://mp.weixi ...
  • 【WPF】Dispatcher 與消息迴圈
    這一期的話題有點深奧，不過按照老周一向的作風，儘量講一些人鬼都能懂的知識。 咱們先來整個小活開開胃，這個小活其實老周在 N 年前寫過水文的，常閱讀老周水文的伙伴可能還記得。通常，咱們按照正常思路構建的應用程式，第一個啟動的線程為主線程，而且還是 UI 線程（當然，WPF 預設會創建輔助線程。這都是運 ...
  • QShop商城-線上支付-微信支付
    1，背景 工作流思想在上世紀60年代就有人提出過；70年代就有人開始嘗試，但是由於當時許多的限制，工作流一直沒有成功的被實現；80年代才出現第一批成功的工作流系統；90年代工作流技術走向了第一個發展高峰期；90年代後至今工作流出現了很多版本，但是主旨還是不變的，為了使我們的工作變得更加高效。 通俗點 ...
  • 記一次 .NET某工控視覺自動化系統 卡死分析
    一：背景 1. 講故事 今天分享的dump是訓練營里一位學員的，從一個啥也不會到現在分析的有模有樣，真的是看他成長起來的，調試技術學會了就是真真實實自己的，話不多說，上windbg說話。 二：WinDbg 分析 1. 為什麼會卡死 這位學員是從事工控大類下的視覺自動化，也是目前.NET的主戰場，這個 ...
  • C#.Net築基-String字元串超全總結 [深度好文]
    字元串是日常編碼中最常用的引用類型了，可能沒有之一，加上字元串的不可變性、駐留性，很容易產生性能問題，因此必須全面瞭解一下。 ...
  • 使用Wesky.Net.Opentools庫,一行代碼實現實體類類型轉換為Json格式字元串
    安裝1.0.10以及以上版本的 Wesky.Net.OpenTools 包 包內，該功能的核心代碼如下： 自定義屬性： 實體類JSON模式生成器： 使用方式：引用上面的1.0.10版本或以上的包。如果實體類有特殊需求，例如映射為其他名稱，可以用OpenJson屬性來實現。實體類對象案例如下： 上面實 ...
  • .NET 中使用 OpenTelemetry Traces 追蹤應用程式
    上一次我們講了 OpenTelemetry Logs。今天繼續來說說 OpenTelemetry Traces。 在今天的微服務和雲原生環境中，理解和監控系統的行為變得越來越重要。在當下我們實現一個功能可能需要調用了 N 個方法，涉及到 N 個服務。方法之間的調用如蜘蛛網一樣。分散式追蹤這個時候就至 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類