Wie zu analysieren OData $filter mit regulären Ausdrücken in C#?

Hallo ich Frage mich, was der beste Ansatz wäre, zu analysieren OData $filter-string in C#, zum Beispiel

/API/Organisationen?$filter="name-eq 'Facebook' oder name-eq 'Twitter' und Abonnenten gt '30'"

Zurückkehren sollten alle Organisationen, die einen Namen von Facebook oder Twitter und die mehr als 30 Teilnehmer. Ich habe recherchiert, einiges aber nicht finden können, von Lösungen, die sich nicht umkreisen, WCF. Ich dachte, der Verwendung von Regex und gruppieren Sie Sie, damit ich eine Liste
der Filter-Klassen so, dass:

Filter
    Resource: Name
    Operator: Eq
    Value: Facebook
Filter
    Resource: Name
    Operator: Eq
    Value: Twitter
Filter
    Resource: Subscribers
    Operator: gt
    Value: 30

aber ich bin ratlos, wie Sie zu behandeln ANDs /ORs.

Erwägen Sie die Verwendung einer eigentlichen parser toolkit und arbeiten aus der Skillung, nicht zu stolpern, um mit einem Bündel von REs. Die Doku fand ich die Erwähnung eines "normativen OData-Spezifikation" mit einer Grammatik für den filter Ausdruck.

InformationsquelleAutor Nick Spicer | 2014-01-30

c#odata regex

Überprüfen Sie diese regex mit den Fahnen ich und x.

(?<Filter>
 (?<Resource>.+?)\s+
 (?<Operator>eq|ne|gt|ge|lt|le|add|sub|mul|div|mod)\s+
 '?(?<Value>.+?)'?
)
(?:
    \s*$
   |\s+(?:or|and|not)\s+
)

Demo

http://regexhero.net/tester/?id=0a26931f-aaa3-4fa0-9fc9-1a67d34c16b3

Beispielcode

string strRegex = @"(?<Filter>" + 
"\n" + @"     (?<Resource>.+?)\s+" + 
"\n" + @"     (?<Operator>eq|ne|gt|ge|lt|le|add|sub|mul|div|mod)\s+" + 
"\n" + @"     '?(?<Value>.+?)'?" + 
"\n" + @")" + 
"\n" + @"(?:" + 
"\n" + @"    \s*$" + 
"\n" + @"   |\s+(?:or|and|not)\s+" + 
"\n" + @")" + 
"\n";
Regex myRegex = new Regex(strRegex, RegexOptions.IgnoreCase | RegexOptions.IgnorePatternWhitespace);
string strTargetString = @"name eq 'Facebook' or name eq 'Twitter' and subscribers gt '30'";
string strReplace = @"Filter >> ${Filter}" + "\n" + @"   Resource : ${Resource}" + "\n" + @"   Operator : ${Operator}" + "\n" + @"   Value    : ${Value}" + "\n\n";

return myRegex.Replace(strTargetString, strReplace);

- Ausgang

Filter >> name eq 'Facebook'
   Resource : name
   Operator : eq
   Value    : Facebook

Filter >> name eq 'Twitter'
   Resource : name
   Operator : eq
   Value    : Twitter

Filter >> subscribers gt '30'
   Resource : subscribers
   Operator : gt
   Value    : 30

Diskussion

Damit haben Sie Großbuchstaben für Ressourcen-und-operator wird ein MatchEvaluator.
Die Gruppierung mit ( und ) werden allerdings nicht unterstützt wird. Lassen Sie Kommentar, wenn Sie möchten, dass die regex-zu unterstützen.

Vielen Dank für die durchdachte Antwort, ich habe noch die UND/ODER-problem, aber das gibt mir ein bisschen mehr Vertrauen in die Fähigkeit der Regex, um sicher split die Zeichenfolge.
Du bist willkommen 😉
Könntest du noch die Gruppierung mit ( und ) ? Dank
Ich Verstand nicht die Frage. Sollten Sie eine weitere Frage stellen, für die Dinge zu erklären...
Sorry ich war nicht klar. Am Ende Ihrer Antwort sagen Sie, dass die Verwendung von Klammern ist nicht unterstützt durch die regex oben, aber einen Kommentar hinterlassen, wenn Sie wollen, dass es zur Unterstützung der parens. Ich Frage mich, wenn Sie hatte noch die änderung oder habe ich das falsch verstanden?

InformationsquelleAutor Stephan

13

In .NET, dort gibt es eine Bibliothek zur Verfügung, die dies für Sie tun. Schreiben Sie Ihre eigene regex Gefahr läuft, fehlen einige edge-Fall.

NuGet, bringen Microsoft.Daten.OData. Dann können Sie tun:
```
using Microsoft.Data.OData.Query;

var result = ODataUriParser.ParseFilter(
  "name eq 'Facebook' or name eq 'Twitter' and subscribers gt 30",
  model,
  type);
```
result hier wird in form eines AST repräsentiert die filter-Klausel.

(Um die model und type Eingänge, könnten Sie analysieren Ihre $Metadaten-Datei mit etwas wie:
```
using Microsoft.Data.Edm;
using Microsoft.Data.Edm.Csdl;

IEdmModel model = EdmxReader.Parse(new XmlTextReader(/*stream of your $metadata file*/));
IEdmEntityType type = model.FindType("organisation");
```
)

Jen, kannst du oder jemand anderes erklären, wie generieren eines EDM-dynamisch? Die erste Idee, die ich habe ist die Erzeugung einer mit der spiegelung, aber die IEdmModel hat eine Tonne der Mitglieder umzusetzen und ich bin der Hoffnung, um zu vermeiden, dass zu lernen, was jeder einzelne tut.
Gibt es eine Möglichkeit, nur die download-Quelle von C++ ohne Verwendung von nuGet? Gibt es ein source-repository für die Microsoft.Daten.OData überall?
Nur ein Hinweis: Diese Lösung verwendet Odata-V 3.0. (Microsoft.Data.OData). Die neueren OData-V 4.0 erfordert Microsoft.OData.Core

InformationsquelleAutor Jen S

Gebäude auf, was Jen S sagt, kannst du die traverse AST Baum, der zurückgegeben wird, durch die FilterClause.

Zum Beispiel können Sie abrufen, die FilterClause von der Steuerung s-Abfrage-Optionen:

public IQueryable<ModelObject> GetModelObjects(ODataQueryOptions<ModelObject> queryOptions)        
    {
        var filterClause = queryOptions.Filter.FilterClause;

Können Sie dann durchqueren die daraus resultierenden AST Baum mit code wie dem folgenden (ausgeliehen von dieser Artikel):

var values = new Dictionary<string, object>();
TryNodeValue(queryOptions.Filter.FilterClause.Expression, values);

Die Funktion, die aufgerufen wird, etwa so:

public void TryNodeValue(SingleValueNode node, IDictionary<string, object> values)
    {
        if (node is BinaryOperatorNode )
        {
            var bon = (BinaryOperatorNode)node;
            var left = bon.Left;
            var right = bon.Right;

            if (left is ConvertNode)
            {
                var convLeft = ((ConvertNode)left).Source;

                if (convLeft is SingleValuePropertyAccessNode && right is ConstantNode)
                    ProcessConvertNode((SingleValuePropertyAccessNode)convLeft, right, bon.OperatorKind, values);
                else
                    TryNodeValue(((ConvertNode)left).Source, values);                    
            }

            if (left is BinaryOperatorNode)
            {
                TryNodeValue(left, values);
            }

            if (right is BinaryOperatorNode)
            {
                TryNodeValue(right, values);
            }

            if (right is ConvertNode)
            {
                TryNodeValue(((ConvertNode)right).Source, values);                  
            }

            if (left is SingleValuePropertyAccessNode && right is ConstantNode)
            {
                ProcessConvertNode((SingleValuePropertyAccessNode)left, right, bon.OperatorKind, values);
            }
        }
    }

    public void ProcessConvertNode(SingleValuePropertyAccessNode left, SingleValueNode right, BinaryOperatorKind opKind, IDictionary<string, object> values)
    {            
        if (left is SingleValuePropertyAccessNode && right is ConstantNode)
        {
            var p = (SingleValuePropertyAccessNode)left;

            if (opKind == BinaryOperatorKind.Equal)
            {
                var value = ((ConstantNode)right).Value;
                values.Add(p.Property.Name, value);
            }
        }
    }

Können Sie dann gehen Sie durch die Liste, Wörterbuch und abrufen Ihrer Werte:

 if (values != null && values.Count() > 0)
        {
            //iterate through the filters and assign variables as required
            foreach (var kvp in values)
            {
                switch (kvp.Key.ToUpper())
                {
                    case "COL1":
                        col1 = kvp.Value.ToString();
                        break;
                    case "COL2":
                        col2 = kvp.Value.ToString();
                        break;
                    case "COL3":
                        col3 = Convert.ToInt32(kvp.Value);
                        break;
                    default: break;
                }
            }
        }

Diesem Beispiel ist Recht simpel, es werden nur Konten für die "eq" - Bewertungen, aber für meine Zwecke war es gut. YMMV. 😉

Nicht die Antwort, die war gefragt, aber eine bessere Antwort für die meisten von uns.

InformationsquelleAutor Stinky Buffalo

Ich denke, Sie sollen travserse den AST mit der Schnittstelle, die mit dem Besucher-Muster.

Denken, dass Sie diese Klasse repräsentiert einen filter

public class FilterValue
{
    public string ComparisonOperator { get; set; }
    public string Value { get; set; }
    public string FieldName { get; set; }
    public string LogicalOperator { get; set; }
}

So, wie wir "extrahieren" - Filter, die mit dem OData-Parameter, um Ihre Klasse?

Sowie die FilterClause Objekt ein Expression-Eigenschaft, die eine SingleValueNode wich erbt von einer QueryNode. Der QueryNode haben, die Accept-Methode der QueryNodeVisitor.

    public virtual T Accept<T>(QueryNodeVisitor<T> visitor);

Rechts, so müssen Sie implementieren Ihre eigenen QueryNodeVisitor und tun Sie Ihre Sachen. Unten ist eine nicht fertige Beispiel (I dont überschreiben alle möglichen Besucher).

public class MyVisitor<TSource> : QueryNodeVisitor<TSource>
    where TSource: class
{ 
    List<FilterValue> filterValueList = new List<FilterValue>();
    FilterValue current = new FilterValue();
    public override TSource Visit(BinaryOperatorNode nodeIn)
    {
        if(nodeIn.OperatorKind == Microsoft.Data.OData.Query.BinaryOperatorKind.And 
            || nodeIn.OperatorKind == Microsoft.Data.OData.Query.BinaryOperatorKind.Or)
        {
            current.LogicalOperator = nodeIn.OperatorKind.ToString();
        }
        else
        {
            current.ComparisonOperator = nodeIn.OperatorKind.ToString();
        }
        nodeIn.Right.Accept(this);
        nodeIn.Left.Accept(this);
        return null;
    }
    public override TSource Visit(SingleValuePropertyAccessNode nodeIn)
    {
        current.FieldName = nodeIn.Property.Name;
        //We are finished, add current to collection.
        filterValueList.Add(current);
        //Reset current
        current = new FilterValue();
        return null;
    }

    public override TSource Visit(ConstantNode nodeIn)
    {
        current.Value = nodeIn.LiteralText;
        return null;
    }

}

Dann, Feuer frei 🙂

MyVisitor<object> visitor = new MyVisitor<object>();
options.Filter.FilterClause.Expression.Accept(visitor);

Wenn es durchquert hat den Baum Ihre

visitor.filterValueList

enthalten sollte der Filter in Ihrem gewünschten format. Ich bin sicher, dass mehr Arbeit erforderlich ist, aber wenn Sie können diese Rollen denke ich, kann man es herausfinden.

Tolle Sachen, die man, danke!
Nur ein Hinweis: Wenn Sie mithilfe von Odata-V4.0, wie ich es Tue, müssen Sie Microsoft.OData.Core.UriParser.TreeNodeKinds.BinaryOperatorKind.And statt
Vielen Dank für die real-life-Beispiel! Aber warum return current as TSource? Ist dies retunr von jedem überall nutzen? Ich versuchte wieder null in mein überschrieben Besuchen (...) - Methoden, und es funktionierte auch. Gibt es eine ausführliche Hilfe zum überschreiben von diesen besuchen? Ich habe es nicht geschafft, Google es aus, diese Antwort scheint zu sein, die nur googlable-source-Implementierung QueryNodeVisitor
Ich weiß es eigentlich nicht. Aber die Unterschrift sagt return T und so machte ich es, dass.
Sie können wählen Sie den Typ T zu werden, so etwas wie List<FilterValue> wenn Sie wollen, und dann müssen Sie nicht haben, um Zugang zu den inneren filterValueList direkt.

InformationsquelleAutor PvPlatten

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.