用字串表示式執行引擎消除掉if else if

2023-07-16 18:00:37

背景

最近我搞了個微信機器人,@機器人 xxx 這樣來傳送命令

能拿到的資訊有,訊息內容,訊息傳送人,訊息所在的群id等

需要根據訊息內容或者訊息傳送群id等不同的條件組合來決定走哪個處理邏輯。

簡單來說的話,就用很多if else if


if(model.context.StartsWith("命令1") && model.from == "群1"){
   // 處理命令1 對應的邏輯 
}else if(xxxx){
   // 處理命令2 對應的邏輯 
}else if(yyyy){
   // 處理命令3 對應的邏輯
}

可以用工廠模式,根據動態條件來返回我們要的Command範例。

但也會在工廠裡面寫很多if else if

這樣的形式,雖然可以實現,但是會造成程式碼很長後面很難維護。

優雅的實現

現代化應用都是基於DI容器來管理類,怎麼優雅的實現呢?

這裡使用AutofacDI容器,配合打註解的方式(類似java的spring框架) 來完成註冊,然後採用 本框架的ExpressionEngine來進行找到符合條件的Action。

效果如下:


// 繼承BaseRobotAction抽象類實現Do方法
[RobotAction("Context.StartsWith(\"Command1\") AND From == \"123\"")]
public class Command1 : BaseRobotAction
{
    public override Task Do(HttpContext context, VxRobotVm model)
    {
        Console.WriteLine($"{model.From} : {model.Context}");
        return Task.CompletedTask;
    }
}

// 繼承BaseRobotAction抽象類實現Do方法
[RobotAction("Context.StartsWith(\"Command2\") OR From == \"234\"")]
public class Command2 : BaseRobotAction
{
    public override Task Do(HttpContext context, VxRobotVm model)
    {
        Console.WriteLine($"{model.From} : {model.Context}");
        return Task.CompletedTask;
    }
}

這樣我們的action上可以打上自定義的RobotAction註解來定義該類的執行條件

這個RobotAction註解是這樣的。這裡是藉助我封裝的Autofac.Annotation庫(https://github.com/yuzd/Autofac.Annotation)來完成的

完成一個自定義裝配註解很簡單,打上[Component]即可,如果想要重寫Compnent內屬性

採用AliasFor完成覆蓋


/// <summary>
/// 自定義註解
/// </summary>
[Component]
public class RobotAction : Attribute
{

    /// <summary>
    /// 預設註冊到容器為IRobotAction型別
    /// </summary>
    [AliasFor(typeof(Component), "Services")]
    public Type[] Services { get; set; } = new[] { typeof(IRobotAction) };
    
    public RobotAction(string expression)
    {
        Expression = expression;
    }

    /// <summary>
    /// 容器中拿此類的時候執行的方法
    /// </summary>
    [AliasFor(typeof(Component), "InitMethod")]

    public string InitMethod { get; set; } = nameof(BaseRobotAction.Init);
    
    /// <summary>
    /// 表示式
    /// </summary>
    public string Expression { get; set; }
}

封裝好了之後,下面就是呼叫處就固定如下,後面想要新增一種Action,只需要按照上面的方式新增一個Action類,打上RobotAction配上表示式條件即可。



// 讀取post body
var robotMsg = await ReadBodyAsync<VxRobotVm>(context.Request.Body);
// 從容器中拿到表示式引擎
var engine = context.RequestServices.GetAutofacRoot().Resolve<ExpressionEngine>();
// 從容器中拿到註冊為robotAction的所有範例
var actions = context.RequestServices.GetAutofacRoot().Resolve<IEnumerable<IRobotAction>>();
foreach (var action in actions)
{
    // 由於設定了InitMethod方法,容器中獲取的時候會觸發走InitMethod方法,拿到當前的實上打的RobotAction註解
    var robotActionAttr = action.getRobotActionAttr();
    if (!engine.Execute(robotActionAttr.Expression, robotMsg).IsSuccess) continue;
    // 找到滿足條件的action
    await action.DoAction(context,robotMsg);
    break;
}

程式碼總體不超過200行,詳細請移步

  • Demo:https://github.com/yuzd/FastExpressionEngine/tree/master/Demo

字串表示式執行引擎 NUGET

開源地址:https://github.com/yuzd/FastExpressionEngine

Install-Package FastExpressionEngine

Document

 var bre = new ExpressionEngine();
 dynamic datas = new ExpandoObject();
 datas.count = 1;
 datas.name = "avqqq";
 var inputs = new dynamic[]
 {
  datas
 };

 var resultList =
  bre.Execute("count < 3 AND name.Contains(\"av\") AND name.StartsWith(\"av\")", inputs);

 var resultListIsSuccess = resultList.IsSuccess;
  • 專案參考 https://github.com/microsoft/RulesEngine
  • 表示式編譯採用:https://github.com/dadhi/FastExpressionCompiler
  • 快取採用LRU預設1000size:https://github.com/bitfaster/BitFaster.Caching