.NET RulesEngine（規(guī)則引擎）的使用詳解

更新時(shí)間：2021年05月03日 12:35:57 作者：HueiFeng

這篇文章主要介紹了.NET RulesEngine（規(guī)則引擎）的使用詳解，幫助大家更好的理解和學(xué)習(xí)使用.net技術(shù)，感興趣的朋友可以了解下

一次偶然的機(jī)會(huì)，讓我拿出RulesEngine去完成一個(gè)業(yè)務(wù)，對(duì)于業(yè)務(wù)來(lái)說(shuō)主要是完成一個(gè)可伸縮性（不確定的類型，以及不確定的條件，條件的變動(dòng)可能是持續(xù)增加修改的）的業(yè)務(wù)判斷。比如說(shuō)完成一個(gè)成就系統(tǒng)，管理員可創(chuàng)建，對(duì)于成就來(lái)說(shuō)有一次性解鎖、日常、周常式，還有隨時(shí)重置，每次達(dá)成都觸發(fā)的，面對(duì)著成就任務(wù)的增加，那對(duì)于程序員來(lái)說(shuō)，如果每次都去增加修改這些成就任務(wù)簡(jiǎn)直是太頭疼了。好了，對(duì)此大家應(yīng)該有一個(gè)簡(jiǎn)單的了解了，那跟著筆者往下走，我們看看如何在.NET中使用非常少的代碼去完成一個(gè)簡(jiǎn)單的動(dòng)態(tài)邏輯處理。

RulesEngine 概述

RulesEngine是Microsoft推出的一個(gè)規(guī)則引擎項(xiàng)目，用于系統(tǒng)中抽象出的業(yè)務(wù)邏輯/規(guī)則/策略。在我們開(kāi)發(fā)的過(guò)程中，避免不了的是跟這種反反復(fù)復(fù)的業(yè)務(wù)邏輯進(jìn)行處理，而對(duì)于這種動(dòng)態(tài)的規(guī)則來(lái)說(shuō)的話，它是比較優(yōu)雅的一種方式，使用我們減少了對(duì)我們代碼或者說(shuō)項(xiàng)目的修改。

如何使用

目前我們可以通過(guò)nuget的形式進(jìn)行引入該庫(kù)，如下所示：

dotnet add package RulesEngine

對(duì)于規(guī)則的配置來(lái)說(shuō)，大家可以直接通過(guò)類型化參數(shù)，筆者主要是為了大家可以清晰的明白，所以用JSON化配置來(lái)做演示。

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

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

如上所示我們定義了規(guī)則信息，對(duì)于該信息，對(duì)于規(guī)則信息筆者默認(rèn)存儲(chǔ)的還是JSON數(shù)據(jù)，當(dāng)然大家可以進(jìn)行存儲(chǔ)如下內(nèi)容，將如下數(shù)據(jù)結(jié)構(gòu)拆分存儲(chǔ)到數(shù)據(jù)庫(kù)中。

屬性	描述
RuleName	規(guī)則名稱
Properties	規(guī)則屬性，獲取或設(shè)置規(guī)則的自定義屬性或者標(biāo)記
Operator	操作符
ErrorMessage	錯(cuò)誤消息
Enabled	獲取和設(shè)置規(guī)則是否已啟用
RuleExpressionType	規(guī)則表達(dá)式類型，默認(rèn)為L(zhǎng)ambdaExpression，當(dāng)然目前只有這么一個(gè)
WorkflowRulesToInJect	注入工作流程規(guī)則
Rules	規(guī)則
LocalParams	本地參數(shù)
Expression	表達(dá)樹(shù)
Actions
SuccessEvent	完成事件，默認(rèn)為規(guī)則名稱

我們來(lái)看一下該代碼產(chǎn)生的結(jié)果，對(duì)于該內(nèi)容筆者創(chuàng)建了一個(gè)類，如下所示：

   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格式規(guī)則字符串
            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("驗(yàn)證成功：{0}，消息：{1}",item.IsSuccess,item.ExceptionMessage);
            }

            Console.ReadLine();

        }

輸出結(jié)果如下所示：

驗(yàn)證成功：False，消息：年齡必須大于18歲.
驗(yàn)證成功：False，消息：身份證號(hào)不可以為空.

返回結(jié)構(gòu)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":[]}

表達(dá)樹(shù)內(nèi)使用擴(kuò)展方法

上面相信大家對(duì)于規(guī)則引擎的使用，有了一個(gè)簡(jiǎn)單的了解，下面我們?cè)賮?lái)一個(gè)進(jìn)階版內(nèi)容。

比如我覺(jué)得通過(guò)輸入的年齡不準(zhǔn)確，我想通過(guò)身份證號(hào)去計(jì)算年齡，那么我該如何操作，正常的情況下，我們會(huì)通過(guò)擴(kuò)展方法，然后將身份證號(hào)參數(shù)進(jìn)行傳遞給處理程序，處理程序計(jì)算完成后，會(huì)返回給我們年齡，而在這個(gè)里面我們?cè)撊绾尾僮髂?？我們往下看?/p>

通過(guò)ReSettings進(jìn)行增加自定義類型，將擴(kuò)展方法，因?yàn)樗鼈兯苁褂玫姆椒▋H限于[System namespace]，所以我們需要將自定義類進(jìn)行添加到設(shè)置中。

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

修改如下內(nèi)容：

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"": ""身份證號(hào)不可以為空."",
                         ""ErrorType"": ""Error"",
                        ""RuleExpressionType"": ""LambdaExpression"",
                        ""Expression"": ""IdNo != null""
                      }
                    ]
                  }] ";

輸出結(jié)果如下所示：

驗(yàn)證成功：False，消息：年齡必須小于18歲.
驗(yàn)證成功：True，消息：

多對(duì)象組合條件

下面我們修改了一下之前的規(guī)則內(nèi)容，同時(shí)又增加了一個(gè)類ListItem，我們將內(nèi)容賦值之后，進(jìn)行創(chuàng)建一個(gè)匿名類型，里面兩個(gè)屬性，user和items，最后通過(guò)我們的多條件組合進(jìn)行邏輯判斷。

            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"}
                }
            };

輸出結(jié)果如下所示：

驗(yàn)證成功：False，消息：Value值不是second.

如何實(shí)現(xiàn)的？

對(duì)于這個(gè)，我們?cè)摳鶕?jù)現(xiàn)象去看原理，對(duì)于內(nèi)部的動(dòng)態(tài)樹(shù)其實(shí)是使用了System.Linq.Dynamic.Core,RulesEngine是建立在該庫(kù)之上，進(jìn)行抽象出來(lái)的，為我們提供了一個(gè)規(guī)則引擎，那我們來(lái)試一下System.Linq.Dynamic.Core。

我們先查詢集合數(shù)據(jù)，編輯一個(gè)條件字符串，如下所示：

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


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

輸出結(jié)果：

Id：1,Value: first

那我們?cè)倏纯慈绻峭ㄟ^(guò)表達(dá)樹(shù)，我們是如何進(jìn)行實(shí)現(xiàn)的，如下所示：

            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);
        }
    }

正常來(lái)說(shuō)是如上這種的，我們進(jìn)行條件的拼接，相信大家可以通過(guò)這種的一個(gè)條件進(jìn)行一個(gè)思考，確定什么樣的適合自己。

如果使用動(dòng)態(tài)查詢形式如下所示：

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

成功失敗事件

因?yàn)閷?duì)于邏輯驗(yàn)證來(lái)說(shuō)，我們既然要這樣做，肯定需要知道到底成功了還是失敗了。而這個(gè)我們不僅可以通過(guò)對(duì)象的IsSuccess還可以通過(guò)兩個(gè)事件進(jìn)行得到邏輯驗(yàn)證的失敗與成功，如下所示：

            var discountOffered = "";

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


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