在C#中使用Irony实现SQL语句的解析

By | 2019年7月11日

在上一篇博文中,我介绍了LOGO语言的C#实现,在该项目中,我使用了.NET下的语法解析框架:Irony。Irony框架最开始的时候是由Roman Ivantsov发布在codeplex上的一个开源项目,它使用MIT协议开源。由于2017年的时候,微软关闭了codeplex服务,为了让这个优秀的项目能够继续为人所用,我将其复制到了我的Github账号下,并将其移植到NET Standard 2.0,地址是:https://github.com/daxnet/irony。于是,Irony目前可以在.NET Core下使用了。事实上,Github中有很多Irony的版本,但大多数都不支持.NET Core。

不仅如此,我还在Azure DevOps上配置了持续集成,因此,你可以通过NuGet很方便地使用Irony。Irony相关的NuGet包有两个,你需要在你的项目中同时安装以下两个NuGet包:

Install-Package Irony.NetCore -Version 1.1.11
Install-Package Irony.Interpreter.NetCore -Version 1.1.11

接下来,我介绍一下如何用Irony实现一个语法解析器,我们以SQL语句为例进行介绍。

定义语法

所有使用Irony框架的语法定义,都必须继承于Grammar类,并加上Language特性。以下就是我定义的一个SQL语句的语法,我称之为“Mini SQL”,因为它目前只支持SELECT语句,而且不支持WHERE子句。

[Language("Mini SQL", "1.0", "A SQL Sample")]
public class MiniSqlGrammar : Grammar
{
    public MiniSqlGrammar()
        : base(false)
    {
        var identifier = new IdentifierTerminal("Identifier");
        var table = new NonTerminal("table");
        var fields = new NonTerminal("fields");
        var sql_statement = new NonTerminal("SQL");

        table.Rule = identifier;
        fields.Rule = "*" | MakePlusRule(fields, ToTerm(","), identifier);

        sql_statement.Rule = "SELECT" + fields + "FROM" + table;

        Root = sql_statement;
    }
}

代码非常简单,也很容易理解,它可以使用人类比较容易读懂的语法定义规则进行语法定义。这里简单介绍一下上面的代码:

  • Language特性用于描述我们自定义的语法
  • 语法类需要继承于Grammar类
  • 基类构造函数的false参数表示我们的语言是大小写不敏感的
  • 所有的程序语言标识符都可以用IdentifierTerminal进行定义,Irony已经自带了标识符的识别逻辑,非常简单
  • table是一个标识符
  • fields可以是*,也可以是由一些标识符通过逗号分隔的一个列表
  • SQL语句由四个部分组成:SELECT关键字、fields字段列表、FROM关键字以及table数据表名
  • Root=sql_statement表示语言的解析入口就是SQL语句

编译通过后,我们就可以使用这个语法进行SELECT语句的解析了。

语法测试

Irony有一个非常不错的功能,就是它提供一个用户界面,用来测试我们定义的语法。这个用户界面是一个Windows Forms的应用程序,我也将其发布到我的Github账号下,地址是:https://github.com/daxnet/irony-explorer。下载以后编译执行GrammarExplorer项目,就可以打开这个测试界面。在测试界面中,打开包含有自定义语法的.NET DLL,就可以将其添加到Grammar Explorer中。例如,下图展示了我用Grammar Explorer测试上面的SQL语法的界面效果:

image

在Grammar Explorer中,你可以看到我们自定义语法是否存在错误,还可以使用一个具有代码着色功能的编辑器进行测试,点击Parse按钮,即可生成语法解析树。

语句解析

使用Irony进行语法解析的基本步骤是:

  1. 基于语法(Grammar)定义,创建语言数据(Language Data)
  2. 基于语言数据,产生解析器(Parser)
  3. 使用解析器,解析输入的字符串,生成语法树
  4. 遍历语法树,执行相应的程序逻辑

下面的代码展示了这一过程:

sealed class SqlParser
{
    private static readonly LanguageData languageData = new LanguageData(new MiniSqlGrammar());
    private static readonly Parser parser = new Parser(languageData);
    private readonly List<string> parsedFields = new List<string>();

    public void Execute(string command)
    {
        var tree = parser.Parse(command);
        if (tree.HasErrors())
        {
            return;
        }

        ParseTree(tree.Root);
    }

    private void ParseTree(ParseTreeNode node)
    {
        switch (node.Term.Name)
        {
            case "SQL":
                foreach (var child in node.ChildNodes)
                {
                    ParseTree(child);
                }
                break;
            case "fields":
                foreach (var child in node.ChildNodes)
                {
                    parsedFields.Add(child.Token.Text);
                }
                break;
            case "table":
                ParsedTable = node.ChildNodes[0].Token.Text;
                break;
        }
    }

    public IEnumerable<string> ParsedFields => parsedFields;
    public string ParsedTable { get; private set; }
}

SqlParser会基于我们自定义的语法类,生成一个Irony的Parser对象,然后使用Parse方法来解析传入的SQL语句,并产生语法解析树。之后,就可以根据树状结构来解析语句中的每一个部分,并执行相应的操作。

获得解析结果

最后,就是使用这个SqlParser类来解析SQL语句并得到结果。代码如下:

static void Main(string[] args)
{
    var sqlParser = new SqlParser();
    sqlParser.Execute("SELECT firstName, LastName FROM tbl_students");

    Console.WriteLine($"获得的数据表: {sqlParser.ParsedTable}");
    Console.WriteLine("获得的字段:");
    foreach (var field in sqlParser.ParsedFields)
    {
        Console.WriteLine(field);
    }
}

代码很简单:调用SqlParser的Execute方法来解析给定的SQL语句,解析结果会分别保存在SqlParser的ParsedTable和ParsedFields两个属性中,上面的控制台程序只需要输出这两个结果就行了。在实际应用中,可以通过ParsedTable来获取某一种类型的对象列表,然后通过ParsedFields来投影列表中每个对象的属性,从而得到基于C#的一系列对象来执行SQL查询的效果。

本案例执行结果如下:

image

总结

本文简要介绍了.NET语法解析框架Irony的使用,并通过SQL语句解析的案例,介绍了Irony使用的一些技巧与步骤。就SQL语句而言,它的定义还是相对比较复杂的,不可能单靠一篇博客就能完全覆盖所有内容,也是因为这个原因,本文也没有涉及WHERE子句的设计,但Irony框架是完全可以做到这一点的。事实上,在Irony Explorer项目中,就有一个IronyExplorer.Samples的工程,其中包含了很多编程语言语法定义的案例代码,比如Java、C#、SQL等,有兴趣的可以参考。Irony框架本身已经帮我们做了很多工作,比如大小写敏感的特性,比如运算符优先级的定义,比如标识符、整数、小数、正负数的定义,再比如块注释与行注释的处理等等。在我用C#实现LOGO语言时,基本上也是按照上面所述步骤进行编写和测试,因此,我就不再另起篇幅来介绍LOGO语言的语法定义了。

Print Friendly, PDF & Email
(总访问量:192;当日访问量:1)

发表评论

电子邮件地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据