當編寫應用程式時，經常性需要花費大量的時間與精力處理業務邏輯，往往業務邏輯的變化需要重構或者增加大量程式碼，對開發測試人員很不友好。
之前在這篇文章說過，可以使用指令碼引擎來將我們需要經常變化的程式碼進行動態編譯執行，自由度非常大，不過對應的需要資源也多。如果只是針對非常具體業務邏輯的變化，可以嘗試使用RulesEngine對程式進行操作。
下文使用了官方示例且部分內容翻譯自說明文件
簡介
RulesEngine是微軟推出的規則引擎，規則引擎在很多企業開發中有所應用，是處理經常變動需求的一種優雅的方法。個人任務，規則引擎適用於以下的一些場景：
- 輸入輸出型別數量比較固定，但是執行邏輯經常變化；
- switch條件經常變化，複雜switch語句的替代；
- 會變動的，具有多種條件或者規則的業務邏輯；
- 規則自由度不要求特別高的場景。（這種情況建議使用指令碼引擎）
RulesEngine的規則使用JSON進行儲存，通過lambda表示式方式表述規則（Rules）。
安裝很方便，直接使用nuget進行安裝：
install-pacakge RulesEngine
規則定義
需要有Rules，有WorkflowName，然後還有一些屬性。
[
{
"WorkflowName": "Discount",
"Rules": [
{
"RuleName": "GiveDiscount10",
"SuccessEvent": "10",
"ErrorMessage": "One or more adjust rules failed.",
"ErrorType": "Error",
"RuleExpressionType": "LambdaExpression",
"Expression": "input1.country == \"india\" AND input1.loyalityFactor <= 2 AND input1.totalPurchasesToDate >= 5000 AND input2.totalOrders > 2 AND input3.noOfVisitsPerMonth > 2"
}
]
}
]
除了標準的
RuleExpressionType，還可以通過定義Rules巢狀多個條件，下面是Or邏輯。
{
"RuleName": "GiveDiscount30NestedOrExample",
"SuccessEvent": "30",
"ErrorMessage": "One or more adjust rules failed.",
"ErrorType": "Error",
"Operator": "OrElse",
"Rules":[
{
"RuleName": "IsLoyalAndHasGoodSpend",
"ErrorMessage": "One or more adjust rules failed.",
"ErrorType": "Error",
"RuleExpressionType": "LambdaExpression",
"Expression": "input1.loyalityFactor > 3 AND input1.totalPurchasesToDate >= 50000 AND input1.totalPurchasesToDate <= 100000"
},
{
"RuleName": "OrHasHighNumberOfTotalOrders",
"ErrorMessage": "One or more adjust rules failed.",
"ErrorType": "Error",
"RuleExpressionType": "LambdaExpression",
"Expression": "input2.totalOrders > 15"
}
]
}
示例
可以從官方的程式碼庫中下載示例，定義了上述規則，就可以直接開始用了。示例描述了這麼一個應用場景：
根據不同的客戶屬性，提供不同的折扣。由於銷售的情況變化較快，提供折扣的規則也需要經常變動。因此比較適用於規則引擎。
public void Run()
{
Console.WriteLine($"Running {nameof(BasicDemo)}....");
//建立輸入
var basicInfo = "{\"name\": \"hello\",\"email\": \"abcy@xyz.com\",\"creditHistory\": \"good\",\"country\": \"canada\",\"loyalityFactor\": 3,\"totalPurchasesToDate\": 10000}";
var orderInfo = "{\"totalOrders\": 5,\"recurringItems\": 2}";
var telemetryInfo = "{\"noOfVisitsPerMonth\": 10,\"percentageOfBuyingToVisit\": 15}";
var converter = new ExpandoObjectConverter();
dynamic input1 = JsonConvert.DeserializeObject<ExpandoObject>(basicInfo, converter);
dynamic input2 = JsonConvert.DeserializeObject<ExpandoObject>(orderInfo, converter);
dynamic input3 = JsonConvert.DeserializeObject<ExpandoObject>(telemetryInfo, converter);
var inputs = new dynamic[]
{
input1,
input2,
input3
};
//載入規則
var files = Directory.GetFiles(Directory.GetCurrentDirectory(), "Discount.json", SearchOption.AllDirectories);
if (files == null || files.Length == 0)
throw new Exception("Rules not found.");
var fileData = File.ReadAllText(files[0]);
var workflowRules = JsonConvert.DeserializeObject<List<WorkflowRules>>(fileData);
//初始化規則引擎
var bre = new RulesEngine.RulesEngine(workflowRules.ToArray(), null);
string discountOffered = "No discount offered.";
//執行規則
List<RuleResultTree> resultList = bre.ExecuteAllRulesAsync("Discount", inputs).Result;
//處理結果
resultList.OnSuccess((eventName) => {
discountOffered = $"Discount offered is {eventName} % over MRP.";
});
resultList.OnFail(() => {
discountOffered = "The user is not eligible for any discount.";
});
Console.WriteLine(discountOffered);
}
輸入
輸入一般來說是IEnumerable<dynamic>或者是匿名型別，上面例項展示的是由json反序列化形成的dynamic型別，對於程式生成的資料，使用匿名型別更加方便。
var nestedInput = new {
SimpleProp = "simpleProp",
NestedProp = new {
SimpleProp = "nestedSimpleProp",
ListProp = new List<ListItem>
{
new ListItem
{
Id = 1,
Value = "first"
},
new ListItem
{
Id = 2,
Value = "second"
}
}
}
};
名稱空間
和指令碼引擎一樣，預設規則引擎只能訪問System的名稱空間。如果需要使用到稍微複雜一些的型別，可以自己定義型別或者函式。比如定義一個這樣的函式：
public static class Utils
{
public static bool CheckContains(string check, string valList)
{
if (String.IsNullOrEmpty(check) || String.IsNullOrEmpty(valList))
return false;
var list = valList.Split(',').ToList();
return list.Contains(check);
}
}
需要使用的時候，先將類傳遞給RulesEngine：
var reSettingsWithCustomTypes = new ReSettings { CustomTypes = new Type[] { typeof(Utils) } };
var engine = new RulesEngine.RulesEngine(workflowRules.ToArray(), null, reSettingsWithCustomTypes);
然後就可以直接在表示式中使用了。
"Expression": "Utils.CheckContains(input1.country, \"india,usa,canada,France\") == true"
規則引數
預設情況下，規則的輸入使用的是類似input1 input2這樣的形式，如果想直觀一點，可以使用RuleParameter來進行封裝具體的引數型別。
RuleParameter ruleParameter = new RuleParameter("NIP", nestedInput);
var resultList = bre.ExecuteAllRulesAsync(workflow.WorkflowName, ruleParameter).Result;
本地變數
如果表示式比較複雜的情況下，可以使用本地變數來進行分段處理，這對除錯來說會比較方便。
本地變數的關鍵字為localParams，可以將中間的內容簡單理解成var name = expression
{
"name": "allow_access_if_all_mandatory_trainings_are_done_or_access_isSecure",
"errorMessage": "Please complete all your training(s) to get access to this content or access it from a secure domain/location.",
"errorType": "Error",
"localParams": [
{
"name": "completedSecurityTrainings",
"expression": "MasterSecurityComplainceTrainings.Where(Status.Equals(\"Completed\", StringComparison.InvariantCultureIgnoreCase))"
},
{
"name": "completedProjectTrainings",
"expression": "MasterProjectComplainceTrainings.Where(Status.Equals(\"Completed\", StringComparison.InvariantCultureIgnoreCase))"
},
{
"name": "isRequestAccessSecured",
"expression": "UserRequestDetails.Location.Country == \"India\" ? ((UserRequestDetails.Location.City == \"Bangalore\" && UserRequestDetails.Domain=\"xxxx\")? true : false):false"
}
],
"expression": "(completedSecurityTrainings.Any() && completedProjectTrainings.Any()) || isRequestAccessSecured "
}
總結
使用規則引擎，可以將經常變動的業務邏輯獨立摘出來，為我們編寫動態、可擴充的程式提供了很大的便利。RulesEngine這個東西提供的API也比較簡潔，上手非常簡單。