用字符串表达式执行引擎消除掉if else if

妖狐艹你老母 2024-03-17 21:13 48阅读 0赞

### 背景 ###

最近我搞了个微信机器人，@机器人 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

--------------------

如果您觉得阅读本文对您有帮助，请点一下“推荐”按钮，您的“推荐”将是我最大的写作动力！欢迎各位转载，转载文章之后须在文章页面明显位置给出作者和原文连接，谢谢。