.NET RulesEngine（規則引擎）

2021 年 4 月 29 日
筆記
.NET, .NET 5

一次偶然的機會，讓我拿出RulesEngine去完成一個業務，對於業務來說主要是完成一個可伸縮性（不確定的類型，以及不確定的條件，條件的變動可能是持續增加修改的）的業務判斷。比如說完成一個成就系統，管理員可創建，對於成就來說有一次性解鎖、日常、周常式，還有隨時重置，每次達成都觸發的，面對着成就任務的增加，那對於程序員來說，如果每次都去增加修改這些成就任務簡直是太頭疼了。好了，對此大家應該有一個簡單的了解了，那跟着筆者往下走，我們看看如何在.NET中使用非常少的代碼去完成一個簡單的動態邏輯處理。

RulesEngine 概述

RulesEngine是Microsoft推出的一個規則引擎項目，用於系統中抽象出的業務邏輯/規則/策略。在我們開發的過程中，避免不了的是跟這種反反覆復的業務邏輯進行處理，而對於這種動態的規則來說的話，它是比較優雅的一種方式，使用我們減少了對我們代碼或者說項目的修改。

如何使用

目前我們可以通過nuget的形式進行引入該庫，如下所示：

dotnet add package RulesEngine

對於規則的配置來說，大家可以直接通過類型化參數，筆者主要是為了大家可以清晰的明白，所以用JSON化配置來做演示。

//反序列化Json格式規則字符串
var workflowRules = JsonConvert.DeserializeObject<List<WorkflowRules>>(rulesStr);
 var rulesEngine = new RulesEngine.RulesEngine(workflowRules.ToArray());

 //定義規則
            var rulesStr = @"[{
                    ""WorkflowName"": ""UserInputWorkflow"",
                    ""Rules"": [
                      {
                        ""RuleName"": ""CheckAge"",
                        ""ErrorMessage"": ""年齡必須大於18歲."",
                        ""ErrorType"": ""Error"",
                        ""RuleExpressionType"": ""LambdaExpression"",
                        ""Expression"": ""Age > 18""
                      },
                       {
                        ""RuleName"": ""CheckIDNoIsEmpty"",
                        ""ErrorMessage"": ""身份證號不可以為空."",
                         ""ErrorType"": ""Error"",
                        ""RuleExpressionType"": ""LambdaExpression"",
                        ""Expression"": ""IdNo != null""
                      }
                    ]
                  }] ";

如上所示我們定義了規則信息，對於該信息，對於規則信息筆者默認存儲的還是JSON數據，當然大家可以進行存儲如下內容，將如下數據結構拆分存儲到數據庫中。

屬性	描述
RuleName	規則名稱
Properties	規則屬性，獲取或設置規則的自定義屬性或者標記
Operator	操作符
ErrorMessage	錯誤消息
Enabled	獲取和設置規則是否已啟用
RuleExpressionType	規則表達式類型，默認為LambdaExpression，當然目前只有這麼一個
WorkflowRulesToInJect	注入工作流程規則
Rules	規則
LocalParams	本地參數
Expression	表達樹
Actions
SuccessEvent	完成事件，默認為規則名稱

我們來看一下該代碼產生的結果，對於該內容筆者創建了一個類，如下所示：

   public class UserInput
        {
            public string IdNo { get; set; }
            public int Age { get; set; }
        }

static async Task Main(string[] args)
        {
            var userInput = new UserInput
            {
                IdNo = null,
                Age = 18
            };

            //反序列化Json格式規則字符串
            var workflowRules = JsonConvert.DeserializeObject<List<WorkflowRules>>(rulesStr);
            
            var rulesEngine = new RulesEngine.RulesEngine(workflowRules.ToArray());

            List<RuleResultTree> resultList = await rulesEngine.ExecuteAllRulesAsync("UserInputWorkflow", userInput);
            foreach (var item in resultList)
            {               
                 Console.WriteLine("驗證成功：{0}，消息：{1}",item.IsSuccess,item.ExceptionMessage);
            }

            Console.ReadLine();

        }

輸出結果如下所示：

驗證成功：False，消息：年齡必須大於18歲.
驗證成功：False，消息：身份證號不可以為空.

返回結構resultList如下所示：

 { "Rule":{ "RuleName":"CheckNestedSimpleProp","Properties":null,"Operator":null,"ErrorMessage":"年齡必須大於18歲.",
                "ErrorType":"Error","RuleExpressionType":"LambdaExpression","WorkflowRulesToInject":null,"Rules":null,"LocalParams":null,"Expression":"Age > 18","Actions":null,"SuccessEvent":null},"IsSuccess":false,"ChildResults":null,"Inputs":{ "input1":{ "IdNo":null,"Age":18} },
                "ActionResult":{ "Output":null,"Exception":null},"ExceptionMessage":"年齡必須大於18歲.","RuleEvaluatedParams":[]}

表達樹內使用擴展方法

上面相信大家對於規則引擎的使用，有了一個簡單的了解，下面我們再來一個進階版內容。

比如我覺得通過輸入的年齡不準確，我想通過身份證號去計算年齡，那麼我該如何操作，正常的情況下，我們會通過擴展方法，然後將身份證號參數進行傳遞給處理程序，處理程序計算完成後，會返回給我們年齡，而在這個裏面我們該如何操作呢？我們往下看。

通過ReSettings進行增加自定義類型，將擴展方法，因為它們所能使用的方法僅限於[System namespace]，所以我們需要將自定義類進行添加到設置中。

   private static readonly ReSettings reSettings = new ReSettings
        {
            CustomTypes = new[] { typeof(IdCardUtil) }
        };

修改如下內容：

 var rulesEngine = new RulesEngine.RulesEngine(workflowRules.ToArray(), null, reSettings: reSettings);

var rulesStr = @"[{
                    ""WorkflowName"": ""UserInputWorkflow"",
                    ""Rules"": [
                      {
                        ""RuleName"": ""CheckNestedSimpleProp"",
                        ""ErrorMessage"": ""年齡必須小於18歲."",
                        ""ErrorType"": ""Error"",
                        ""RuleExpressionType"": ""LambdaExpression"",
                        ""Expression"": ""IdNo.GetAgeByIdCard() < 18""
                      },
                       {
                        ""RuleName"": ""CheckNestedSimpleProp1"",
                        ""ErrorMessage"": ""身份證號不可以為空."",
                         ""ErrorType"": ""Error"",
                        ""RuleExpressionType"": ""LambdaExpression"",
                        ""Expression"": ""IdNo != null""
                      }
                    ]
                  }] ";

輸出結果如下所示：

驗證成功：False，消息：年齡必須小於18歲.
驗證成功：True，消息：

多對象組合條件

下面我們修改了一下之前的規則內容，同時又增加了一個類ListItem，我們將內容賦值之後，進行創建一個匿名類型，裏面兩個屬性，user和items，最後通過我們的多條件組合進行邏輯判斷。

            var rulesStr = @"[{
                    ""WorkflowName"": ""UserInputWorkflow"",
                    ""Rules"": [
                      {
                        ""RuleName"": ""CheckNestedSimpleProp"",
                        ""ErrorMessage"": ""Value值不是second."",
                        ""ErrorType"": ""Error"",
                        ""RuleExpressionType"": ""LambdaExpression"",
                        ""Expression"": ""user.UserId==1 && items[0].Value==second""
                      }
                    ]
                  }] ";


            var userInput = new UserInput
            {
                UserId = 1,
                IdNo = "11010519491230002X",
                Age = 18
            };
            var input = new
            {
                user = userInput,
                items = new List<ListItem>()
                {
                    new ListItem{ Id=1,Value="first"},
                    new ListItem{ Id=2,Value="second"}
                }
            };

輸出結果如下所示：

驗證成功：False，消息：Value值不是second.

如何實現的？

對於這個，我們該根據現象去看原理，對於內部的動態樹其實是使用了System.Linq.Dynamic.Core,RulesEngine是建立在該庫之上，進行抽象出來的，為我們提供了一個規則引擎，那我們來試一下System.Linq.Dynamic.Core。

我們先查詢集合數據，編輯一個條件字符串，如下所示：

var items = input.items.AsQueryable().Where("Id == 1").ToList();


foreach (var item in items)
{
    Console.WriteLine($"Id：{item.Id},Value: {item.Value}");
}

輸出結果：

Id：1,Value: first

那我們再看看如果是通過表達樹，我們是如何進行實現的，如下所示：

            Expression<Func<ListItem, bool>> predicate = x => x.Id == 1;
            //輸入條件如下
            var inputItem = new ListItem
            {
                Id = 1,
                Value = "second"
            };

            if (inputItem.Id !=null)
            {
                predicate = predicate.And(x=>x.Id==inputItem.Id);
            }

            if (inputItem.Id != null)
            {
                predicate = predicate.And(x => x.Value == inputItem.Value);
            }
            
    public static class PredicateBuilder
    {
        public static Expression<Func<T, bool>> And<T>(this Expression<Func<T, bool>> expr1,
                                                            Expression<Func<T, bool>> expr2)
        {
            var invokedExpr = Expression.Invoke(expr2, expr1.Parameters.Cast<Expression>());
            return Expression.Lambda<Func<T, bool>>
                  (Expression.And(expr1.Body, invokedExpr), expr1.Parameters);
        }
    }

正常來說是如上這種的，我們進行條件的拼接，相信大家可以通過這種的一個條件進行一個思考，確定什麼樣的適合自己。

如果使用動態查詢形式如下所示：

var items = input.items.AsQueryable().Where("Id ==@0  && Value==@1",inputItem.Id,inputItem.Value).ToList();

成功失敗事件

因為對於邏輯驗證來說，我們既然要這樣做，肯定需要知道到底成功了還是失敗了。而這個我們不僅可以通過對象的IsSuccess還可以通過兩個事件進行得到邏輯驗證的失敗與成功，如下所示：

            var discountOffered = "";

            resultList.OnSuccess((eventName) =>
            {
                discountOffered = $"成功事件:{eventName}.";
            });


            resultList.OnFail(() =>
            {
                discountOffered = "失敗事件.";
            });

總結

有興趣的話可以看一下System.Linq.Dynamic.Core，因為關於動態表達樹解析還是使用的這個項目去做的。另外項目地址在RulesEngine

//github.com/hueifeng/BlogSample/tree/master/src/RulesEngineDemo

Tags: .NET .NET 5