ルールエンジンの実装方法

以下を格納するdbテーブルがあります。

RuleID  objectProperty ComparisonOperator  TargetValue
1       age            'greater_than'             15
2       username       'equal'             'some_name'
3       tags           'hasAtLeastOne'     'some_tag some_tag2'

これらのルールのコレクションがあるとしましょう：

List<Rule> rules = db.GetRules();

今、私はユーザーのインスタンスも持っています：

User user = db.GetUser(....);

これらのルールをループして、ロジックを適用して比較を実行するにはどうすればよいですか？

if(user.age > 15)

if(user.username == "some_name")

'age'や 'user_name'などのオブジェクトのプロパティは、比較演算子 'great_than'および 'equal'とともにテーブルに格納されているため、これをどのように実行できますか？

C＃は静的に型付けされた言語であるため、次に進む方法がわかりません。

このスニペットは、ルールを（Expression treesを使用して）高速実行可能コードにコンパイルし、複雑なスイッチステートメントを必要としません。

（編集：ジェネリックメソッドを使用した完全な作業例）

public Func<User, bool> CompileRule(Rule r)
{
    var paramUser = Expression.Parameter(typeof(User));
    Expression expr = BuildExpr(r, paramUser);
    // build a lambda function User->bool and compile it
    return Expression.Lambda<Func<User, bool>>(expr, paramUser).Compile();
}

その後、次のように書くことができます：

List<Rule> rules = new List<Rule> {
    new Rule ("Age", "GreaterThan", "20"),
    new Rule ( "Name", "Equal", "John"),
    new Rule ( "Tags", "Contains", "C#" )
};

// compile the rules once
var compiledRules = rules.Select(r => CompileRule(r)).ToList();

public bool MatchesAllRules(User user)
{
    return compiledRules.All(rule => rule(user));
}

BuildExprの実装は次のとおりです。

Expression BuildExpr(Rule r, ParameterExpression param)
{
    var left = MemberExpression.Property(param, r.MemberName);
    var tProp = typeof(User).GetProperty(r.MemberName).PropertyType;
    ExpressionType tBinary;
    // is the operator a known .NET operator?
    if (ExpressionType.TryParse(r.Operator, out tBinary)) {
        var right = Expression.Constant(Convert.ChangeType(r.TargetValue, tProp));
        // use a binary operation, e.g. 'Equal' -> 'u.Age == 15'
        return Expression.MakeBinary(tBinary, left, right);
    } else {
        var method = tProp.GetMethod(r.Operator);
        var tParam = method.GetParameters()[0].ParameterType;
        var right = Expression.Constant(Convert.ChangeType(r.TargetValue, tParam));
        // use a method call, e.g. 'Contains' -> 'u.Tags.Contains(some_tag)'
        return Expression.Call(left, method, right);
    }
}

「greater_than」などの代わりに「GreaterThan」を使用したことに注意してください。「GreaterThan」は演算子の.NET名であるため、追加のマッピングは必要ありません。

カスタム名が必要な場合は、非常に単純な辞書を作成し、ルールをコンパイルする前にすべての演算子を翻訳するだけです。

var nameMap = new Dictionary<string, string> {
    { "greater_than", "GreaterThan" },
    { "hasAtLeastOne", "Contains" }
};

このコードでは、簡単にするためにタイプUserを使用しています。Userをジェネリック型Tに置き換えて、ジェネリックルールコンパイラを作成できます。任意のタイプのオブジェクト用のを作成できます。また、コードは不明なオペレーター名などのエラーを処理する必要があります。

Reflection.Emitを使用すると、Expression Tree APIが導入される前でも、オンザフライでコードを生成できました。LambdaExpression.Compile（）メソッドはReflection.Emitを内部で使用します（これはILSpyを使用して確認できます）。

そのままコンパイルして作業を行うコードを以下に示します。基本的に2つの辞書を使用します。1つは演算子名からブール関数へのマッピングを含み、もう1つはユーザータイプのプロパティ名からプロパティゲッターの呼び出しに使用されるPropertyInfosへのマップを含みます（パブリックの場合）。Userインスタンスと、テーブルの3つの値を静的なApplyメソッドに渡します。

class User
{
    public int Age { get; set; }
    public string UserName { get; set; }
}

class Operator
{
    private static Dictionary<string, Func<object, object, bool>> s_operators;
    private static Dictionary<string, PropertyInfo> s_properties;
    static Operator()
    {
        s_operators = new Dictionary<string, Func<object, object, bool>>();
        s_operators["greater_than"] = new Func<object, object, bool>(s_opGreaterThan);
        s_operators["equal"] = new Func<object, object, bool>(s_opEqual);

        s_properties = typeof(User).GetProperties().ToDictionary(propInfo => propInfo.Name);
    }

    public static bool Apply(User user, string op, string prop, object target)
    {
        return s_operators[op](GetPropValue(user, prop), target);
    }

    private static object GetPropValue(User user, string prop)
    {
        PropertyInfo propInfo = s_properties[prop];
        return propInfo.GetGetMethod(false).Invoke(user, null);
    }

    #region Operators

    static bool s_opGreaterThan(object o1, object o2)
    {
        if (o1 == null || o2 == null || o1.GetType() != o2.GetType() || !(o1 is IComparable))
            return false;
        return (o1 as IComparable).CompareTo(o2) > 0;
    }

    static bool s_opEqual(object o1, object o2)
    {
        return o1 == o2;
    }

    //etc.

    #endregion

    public static void Main(string[] args)
    {
        User user = new User() { Age = 16, UserName = "John" };
        Console.WriteLine(Operator.Apply(user, "greater_than", "Age", 15));
        Console.WriteLine(Operator.Apply(user, "greater_than", "Age", 17));
        Console.WriteLine(Operator.Apply(user, "equal", "UserName", "John"));
        Console.WriteLine(Operator.Apply(user, "equal", "UserName", "Bob"));
    }
}

質問で概説したのとは異なるアプローチを取るルールエンジンを作成しましたが、現在のアプローチよりもはるかに柔軟であると思います。

現在のアプローチは単一のエンティティ「ユーザー」に焦点を当てているようで、永続的なルールは「プロパティ名」、「演算子」、および「値」を識別します。私のパターンでは、代わりに、述語（Func <T、bool>）のC＃コードをデータベースの「式」列に格納します。現在の設計では、コード生成を使用して、データベースから「ルール」にクエリを実行し、それぞれが「テスト」メソッドを持つ「ルール」タイプでアセンブリをコンパイルしています。次に、各ルールを実装するインターフェースのシグネチャを示します。

public interface IDataRule<TEntity> 
{
    /// <summary>
    /// Evaluates the validity of a rule given an instance of an entity
    /// </summary>
    /// <param name="entity">Entity to evaluate</param>
    /// <returns>result of the evaluation</returns>
    bool Test(TEntity entity);
    /// <summary>
    /// The unique indentifier for a rule.
    /// </summary>
     int RuleId { get; set; }
    /// <summary>
    /// Common name of the rule, not unique
    /// </summary>
     string RuleName { get; set; }
    /// <summary>
    /// Indicates the message used to notify the user if the rule fails
    /// </summary>
     string ValidationMessage { get; set; }   
     /// <summary>
     /// indicator of whether the rule is enabled or not
     /// </summary>
     bool IsEnabled { get; set; }
    /// <summary>
    /// Represents the order in which a rule should be executed relative to other rules
    /// </summary>
     int SortOrder { get; set; }
}

「式」は、アプリケーションが最初に実行されるときに「テスト」メソッドの本体としてコンパイルされます。ご覧のとおり、テーブルの他の列もルールのファーストクラスのプロパティとして表示されているため、開発者はユーザーに失敗または成功の通知を受け取る方法を柔軟に作成できます。

インメモリアセンブリの生成は、アプリケーション中に1回だけ発生し、ルールを評価するときにリフレクションを使用する必要がないため、パフォーマンスが向上します。プロパティ名のスペルが間違っているなどの場合、アセンブリは正しく生成されないため、実行時に式がチェックされます。

インメモリアセンブリを作成するメカニズムは次のとおりです。

• DBからルールを読み込む
• StringBuilderといくつかの文字列連結を使用して、ルールとfor-eachを反復処理し、IDataRuleから継承するクラスを表すTextを書き込みます
• CodeDOMを使用してコンパイルする- 詳細

ほとんどの場合、このコードはプロパティの実装とコンストラクタでの値の初期化であるため、これは実際には非常に単純です。それ以外に、他の唯一のコードは式です。
注：CodeDOMの制限により、式は.NET 2.0（ラムダやその他のC＃3.0機能なし）でなければならないという制限があります。

以下はそのためのサンプルコードです。

sb.AppendLine(string.Format("\tpublic class {0} : SomeCompany.ComponentModel.IDataRule<{1}>", className, typeName));
            sb.AppendLine("\t{");
            sb.AppendLine("\t\tprivate int _ruleId = -1;");
            sb.AppendLine("\t\tprivate string _ruleName = \"\";");
            sb.AppendLine("\t\tprivate string _ruleType = \"\";");
            sb.AppendLine("\t\tprivate string _validationMessage = \"\";");
            /// ... 
            sb.AppendLine("\t\tprivate bool _isenabled= false;");
            // constructor
            sb.AppendLine(string.Format("\t\tpublic {0}()", className));
            sb.AppendLine("\t\t{");
            sb.AppendLine(string.Format("\t\t\tRuleId = {0};", ruleId));
            sb.AppendLine(string.Format("\t\t\tRuleName = \"{0}\";", ruleName.TrimEnd()));
            sb.AppendLine(string.Format("\t\t\tRuleType = \"{0}\";", ruleType.TrimEnd()));                
            sb.AppendLine(string.Format("\t\t\tValidationMessage = \"{0}\";", validationMessage.TrimEnd()));
            // ...
            sb.AppendLine(string.Format("\t\t\tSortOrder = {0};", sortOrder));                

            sb.AppendLine("\t\t}");
            // properties
            sb.AppendLine("\t\tpublic int RuleId { get { return _ruleId; } set { _ruleId = value; } }");
            sb.AppendLine("\t\tpublic string RuleName { get { return _ruleName; } set { _ruleName = value; } }");
            sb.AppendLine("\t\tpublic string RuleType { get { return _ruleType; } set { _ruleType = value; } }");

            /// ... more properties -- omitted

            sb.AppendLine(string.Format("\t\tpublic bool Test({0} entity) ", typeName));
            sb.AppendLine("\t\t{");
            // #############################################################
            // NOTE: This is where the expression from the DB Column becomes
            // the body of the Test Method, such as: return "entity.Prop1 < 5"
            // #############################################################
            sb.AppendLine(string.Format("\t\t\treturn {0};", expressionText.TrimEnd()));
            sb.AppendLine("\t\t}");  // close method
            sb.AppendLine("\t}"); // close Class

これ以外に、ICollection>を実装した「DataRuleCollection」というクラスを作成しました。これにより、「TestAll」機能と、特定のルールを名前で実行するためのインデクサーを作成できました。これらの2つのメソッドの実装は次のとおりです。

    /// <summary>
    /// Indexer which enables accessing rules in the collection by name
    /// </summary>
    /// <param name="ruleName">a rule name</param>
    /// <returns>an instance of a data rule or null if the rule was not found.</returns>
    public IDataRule<TEntity, bool> this[string ruleName]
    {
        get { return Contains(ruleName) ? list[ruleName] : null; }
    }
    // in this case the implementation of the Rules Collection is: 
    // DataRulesCollection<IDataRule<User>> and that generic flows through to the rule.
    // there are also some supporting concepts here not otherwise outlined, such as a "FailedRules" IList
    public bool TestAllRules(User target) 
    {
        rules.FailedRules.Clear();
        var result = true;

        foreach (var rule in rules.Where(x => x.IsEnabled)) 
        {

            result = rule.Test(target);
            if (!result)
            {

                rules.FailedRules.Add(rule);
            }
        }

        return (rules.FailedRules.Count == 0);
    }

その他のコード：コード生成に関連するコードのリクエストがありました。以下に含めた「RulesAssemblyGenerator」というクラスに機能をカプセル化しました。

namespace Xxx.Services.Utils
    {
        public static class RulesAssemblyGenerator
        {
            static List<string> EntityTypesLoaded = new List<string>();

            public static void Execute(string typeName, string scriptCode)
            {
                if (EntityTypesLoaded.Contains(typeName)) { return; } 
                // only allow the assembly to load once per entityType per execution session
                Compile(new CSharpCodeProvider(), scriptCode);
                EntityTypesLoaded.Add(typeName);
            }
            private static void Compile(CodeDom.CodeDomProvider provider, string source)
            {
                var param = new CodeDom.CompilerParameters()
                {
                    GenerateExecutable = false,
                    IncludeDebugInformation = false,
                    GenerateInMemory = true
                };
                var path = System.Reflection.Assembly.GetExecutingAssembly().Location;
                var root_Dir = System.IO.Path.Combine(System.AppDomain.CurrentDomain.BaseDirectory, "Bin");
                param.ReferencedAssemblies.Add(path);
                // Note: This dependencies list are included as assembly reference and they should list out all dependencies
                // That you may reference in your Rules or that your entity depends on.
                // some assembly names were changed... clearly.
                var dependencies = new string[] { "yyyyyy.dll", "xxxxxx.dll", "NHibernate.dll", "ABC.Helper.Rules.dll" };
                foreach (var dependency in dependencies)
                {
                    var assemblypath = System.IO.Path.Combine(root_Dir, dependency);
                    param.ReferencedAssemblies.Add(assemblypath);
                }
                // reference .NET basics for C# 2.0 and C#3.0
                param.ReferencedAssemblies.Add(@"C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\System.dll");
                param.ReferencedAssemblies.Add(@"C:\Program Files\Reference Assemblies\Microsoft\Framework\v3.5\System.Core.dll");
                var compileResults = provider.CompileAssemblyFromSource(param, source);
                var output = compileResults.Output;
                if (compileResults.Errors.Count != 0)
                {
                    CodeDom.CompilerErrorCollection es = compileResults.Errors;
                    var edList = new List<DataRuleLoadExceptionDetails>();
                    foreach (CodeDom.CompilerError s in es)
                        edList.Add(new DataRuleLoadExceptionDetails() { Message = s.ErrorText, LineNumber = s.Line });
                    var rde = new RuleDefinitionException(source, edList.ToArray());
                    throw rde;
                }
            }
        }
    }

もしあれば、他の更なるコードのサンプルについての質問やコメントやリクエストは、私に知らせてください。

リフレクションは、最も用途の広い答えです。3つのデータ列があり、それらを異なる方法で処理する必要があります。

1. フィールド名。リフレクションは、コード化されたフィールド名から値を取得する方法です。

2. 比較演算子。これらの数は限られているはずなので、caseステートメントはそれらを最も簡単に処理できるはずです。特に、それらの一部（の1つ以上を持っている）は少し複雑です。

3. 比較値。これらがすべてまっすぐな値であれば、これは簡単ですが、複数のエントリを分割する必要があります。ただし、フィールド名の場合もリフレクションを使用できます。

私は次のようなアプローチを取るでしょう：

    var value = user.GetType().GetProperty("age").GetValue(user, null);
    //Thank you Rick! Saves me remembering it;
    switch(rule.ComparisonOperator)
        case "equals":
             return EqualComparison(value, rule.CompareTo)
        case "is_one_or_more_of"
             return IsInComparison(value, rule.CompareTo)

などなど

比較のためのオプションを追加する柔軟性を提供します。また、Comparisonメソッド内で、必要に応じて任意の型検証をコーディングし、必要なだけ複雑にすることもできます。CompareToを別の行への再帰的呼び出しとして、またはフィールド値として評価するオプションもここにあります。これは次のように実行できます。

             return IsInComparison(value, EvaluateComparison(rule.CompareTo))

それはすべて、将来の可能性にかかっています。

少数のプロパティと演算子しかない場合、抵抗を最小限に抑えるには、次のような特別なケースとしてすべてのチェックをコーディングするだけです。

public bool ApplyRules(List<Rule> rules, User user)
{
    foreach (var rule in rules)
    {
        IComparable value = null;
        object limit = null;
        if (rule.objectProperty == "age")
        {
            value = user.age;
            limit = Convert.ToInt32(rule.TargetValue);
        }
        else if (rule.objectProperty == "username")
        {
            value = user.username;
            limit = rule.TargetValue;
        }
        else
            throw new InvalidOperationException("invalid property");

        int result = value.CompareTo(limit);

        if (rule.ComparisonOperator == "equal")
        {
            if (!(result == 0)) return false;
        }
        else if (rule.ComparisonOperator == "greater_than")
        {
            if (!(result > 0)) return false;
        }
        else
            throw new InvalidOperationException("invalid operator");
    }
    return true;
}

プロパティがたくさんある場合は、テーブル駆動のアプローチの方が適しています。その場合Dictionary、たとえば、に一致するデリゲートにプロパティ名をマップするstatic を作成しますFunc<User, object>。

コンパイル時にプロパティの名前がわからない場合、または各プロパティの特殊なケースを避けてテーブルアプローチを使用したくない場合は、リフレクションを使用してプロパティを取得できます。例えば：

var value = user.GetType().GetProperty("age").GetValue(user, null);

ただし、TargetValueはおそらくなのでstring、必要に応じてルールテーブルから型変換を行うように注意する必要があります。

拡張メソッドを使用したデータ型指向のアプローチはどうですか？

public static class RoleExtension
{
    public static bool Match(this Role role, object obj )
    {
        var property = obj.GetType().GetProperty(role.objectProperty);
        if (property.PropertyType == typeof(int))
        {
            return ApplyIntOperation(role, (int)property.GetValue(obj, null));
        }
        if (property.PropertyType == typeof(string))
        {
            return ApplyStringOperation(role, (string)property.GetValue(obj, null));
        }
        if (property.PropertyType.GetInterface("IEnumerable<string>",false) != null)
        {
            return ApplyListOperation(role, (IEnumerable<string>)property.GetValue(obj, null));
        }
        throw new InvalidOperationException("Unknown PropertyType");
    }

    private static bool ApplyIntOperation(Role role, int value)
    {
        var targetValue = Convert.ToInt32(role.TargetValue);
        switch (role.ComparisonOperator)
        {
            case "greater_than":
                return value > targetValue;
            case "equal":
                return value == targetValue;
            //...
            default:
                throw new InvalidOperationException("Unknown ComparisonOperator");
        }
    }

    private static bool ApplyStringOperation(Role role, string value)
    {
        //...
        throw new InvalidOperationException("Unknown ComparisonOperator");
    }

    private static bool ApplyListOperation(Role role, IEnumerable<string> value)
    {
        var targetValues = role.TargetValue.Split(' ');
        switch (role.ComparisonOperator)
        {
            case "hasAtLeastOne":
                return value.Any(v => targetValues.Contains(v));
                //...
        }
        throw new InvalidOperationException("Unknown ComparisonOperator");
    }
}

あなたがこのようにエバポレートできるより：

var myResults = users.Where(u => roles.All(r => r.Match(u)));

「ルールエンジンを実装するには（C＃で）」という質問に答える最も明白な方法は、特定のルールセットを順番に実行することですが、これは一般に単純な実装と見なされます（機能しないことを意味するわけではありません） :-)

あなたの問題は「一連のルールを順番に実行する方法」のようであり、ラムダ/式ツリー（マーティンの答え）が確かに最もエレガントな方法であるので、あなたの場合、それはあなたの場合「十分」に思えます最近のC＃バージョンが装備されています。

ただし、より高度なシナリオについては、実際には多くの商用ルールエンジンシステムに実装されているReteアルゴリズムへのリンクと、C＃でのそのアルゴリズムの実装であるNRulerへの別のリンクがあります。

マーティンの答えはかなり良かった。私は実際に彼と同じ考えを持つルールエンジンを作成しました。そして、それがほとんど同じであることに驚きました。多少改善するために彼のコードの一部を含めました。より複雑なルールを処理するために作成しましたが。

あなたはYare.NETを見ることができます

またはNugetでダウンロードする

ワークフロールールエンジンの使用についてはどうですか？

ワークフローなしでWindowsワークフロールールを実行できます。GuyBursteinのブログを参照してください。http：//blogs.microsoft.co.il/blogs/bursteg/archive/2006/10/11/RuleExecutionWithoutWorkflow.aspx

プログラムでルールを作成するには、Stephen KaufmanのWebLogを参照してください。

http://blogs.msdn.com/b/skaufman/archive/2006/05/15/programmatically-create-windows-workflow-rules.aspx

ルールの実装を追加したり、ルールの間に、RuleExpressionクラスを追加したり、リーフであるツリーのルートを表すことができます。

public class RuleExpression
{
    public NodeOperator NodeOperator { get; set; }
    public List<RuleExpression> Expressions { get; set; }
    public Rule Rule { get; set; }

    public RuleExpression()
    {

    }
    public RuleExpression(Rule rule)
    {
        NodeOperator = NodeOperator.Leaf;
        Rule = rule;
    }

    public RuleExpression(NodeOperator nodeOperator, List<RuleExpression> expressions, Rule rule)
    {
        this.NodeOperator = nodeOperator;
        this.Expressions = expressions;
        this.Rule = rule;
    }
}


public enum NodeOperator
{
    And,
    Or,
    Leaf
}

ruleExpressionを1つにコンパイルする別のクラスがあります Func<T, bool>:

 public static Func<T, bool> CompileRuleExpression<T>(RuleExpression ruleExpression)
    {
        //Input parameter
        var genericType = Expression.Parameter(typeof(T));
        var binaryExpression = RuleExpressionToOneExpression<T>(ruleExpression, genericType);
        var lambdaFunc = Expression.Lambda<Func<T, bool>>(binaryExpression, genericType);
        return lambdaFunc.Compile();
    }

    private static Expression RuleExpressionToOneExpression<T>(RuleExpression ruleExpression, ParameterExpression genericType)
    {
        if (ruleExpression == null)
        {
            throw new ArgumentNullException();
        }
        Expression finalExpression;
        //check if node is leaf
        if (ruleExpression.NodeOperator == NodeOperator.Leaf)
        {
            return RuleToExpression<T>(ruleExpression.Rule, genericType);
        }
        //check if node is NodeOperator.And
        if (ruleExpression.NodeOperator.Equals(NodeOperator.And))
        {
            finalExpression = Expression.Constant(true);
            ruleExpression.Expressions.ForEach(expression =>
            {
                finalExpression = Expression.AndAlso(finalExpression, expression.NodeOperator.Equals(NodeOperator.Leaf) ? 
                    RuleToExpression<T>(expression.Rule, genericType) :
                    RuleExpressionToOneExpression<T>(expression, genericType));
            });
            return finalExpression;
        }
        //check if node is NodeOperator.Or
        else
        {
            finalExpression = Expression.Constant(false);
            ruleExpression.Expressions.ForEach(expression =>
            {
                finalExpression = Expression.Or(finalExpression, expression.NodeOperator.Equals(NodeOperator.Leaf) ?
                    RuleToExpression<T>(expression.Rule, genericType) :
                    RuleExpressionToOneExpression<T>(expression, genericType));
            });
            return finalExpression;

        }      
    }      

    public static BinaryExpression RuleToExpression<T>(Rule rule, ParameterExpression genericType)
    {
        try
        {
            Expression value = null;
            //Get Comparison property
            var key = Expression.Property(genericType, rule.ComparisonPredicate);
            Type propertyType = typeof(T).GetProperty(rule.ComparisonPredicate).PropertyType;
            //convert case is it DateTimeOffset property
            if (propertyType == typeof(DateTimeOffset))
            {
                var converter = TypeDescriptor.GetConverter(propertyType);
                value = Expression.Constant((DateTimeOffset)converter.ConvertFromString(rule.ComparisonValue));
            }
            else
            {
                value = Expression.Constant(Convert.ChangeType(rule.ComparisonValue, propertyType));
            }
            BinaryExpression binaryExpression = Expression.MakeBinary(rule.ComparisonOperator, key, value);
            return binaryExpression;
        }
        catch (FormatException)
        {
            throw new Exception("Exception in RuleToExpression trying to convert rule Comparison Value");
        }
        catch (Exception e)
        {
            throw new Exception(e.Message);
        }

    }