Antlr4 - 自定义SparkSQL解析

> Antlr4 是一个强大的解析器的生成器,可以用来读取、处理、执行或翻译结构化文本,ANTLR可以从语法上来生成一个可以构建和遍历解析树的解析器,最出名的Spark计算引擎2.x就是用它来解析SQL的,是一个牛到没朋友的家伙。

## IDEA测试

**IDEA语法分析插件**

下载 [antlr-v4-grammar-plugin](https://plugins.jetbrains.com/files/7358/53413/antlr-intellij-plugin-v4-1.9.zip?updateId=53413&pluginId=7358&family=intellij)

**插件安装**

![antlr-v4-grammar分析插件](https://upload-images.jianshu.io/upload_images/9028759-457ee4fc07b39404.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

g4语法文件使用的是sparkSQL的 [SqlBase.g4](https://github.com/apache/spark/blob/v2.3.1/sql/catalyst/src/main/antlr4/org/apache/spark/sql/catalyst/parser/SqlBase.g4) 文件进行改造的 [ArcSql.g4 ](https://raw.githubusercontent.com/dounine/arc/370dc33ff42cca73e2a01ee2156b5627ba086d95/src/main/resources/ArcSQL.g4)

**右键选中 multiStatement 进行测试**

![antlr4](https://upload-images.jianshu.io/upload_images/9028759-80259a5ed33eb5ac.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

**测试SQL语法树**

![antlr4-SQL-测试](https://upload-images.jianshu.io/upload_images/9028759-6187e0ff854daedd.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

**生成解析配置**

![antlr4-生成解析代码](https://upload-images.jianshu.io/upload_images/9028759-f6023f2df44d1d32.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

1. 右键`ArcSQL.g4`文件,在下拉选项`Configure ANTLR`即可出来。

2. 第一个`Output directory...`要写上输出代码的路径。

3. 比如把它放到当前项目的antlr4的包中`/dounine/github/arc/src/main/scala/com/dounine/arc/antlr4`

4. 右键`ArcSQL.g4`文件,选中`Generate ANTLR Recognizer`即可生成

5. 会生成如下几个文件

```

ArcSQL.interp

ArcSQL.tokens

ArcSQLBaseListener

ArcSQLBaseVisitor

ArcSQLLexer

ArcSQLLexer.interp

ArcSQLLexer.tokens

ArcSQLListener

ArcSQLParser

ArcSQLVisitor

```

## 代码测试

依赖

```

compile group: 'org.antlr', name: 'antlr4', version: '4.7.2'

```

被动模式(树解析到节点了通知)

```

val loadLexer = new ArcSQLLexer(CharStreams.fromString(

      """

        select toUp(name) from log;

      """))

val tokens = new CommonTokenStream(loadLexer)

val parser = new ArcSQLParser(tokens)

val ctx = parser.multiStatement()

val listener = new ArcSQLBaseListener() {

      override def exitQuerySpecification(ctx: ArcSQLParser.QuerySpecificationContext): Unit = {

        val input = ctx.start.getTokenSource.asInstanceOf[ArcSQLLexer]._input

        val start = ctx.start.getStartIndex

        val stop = ctx.stop.getStopIndex

        val interval = new Interval(start, stop)

        val sqlText = input.getText(interval)

        println("表名 => " + ctx.tableAlias().strictIdentifier().getText)

        println("完整SQL =>" + sqlText)

      }

    }

ParseTreeWalker.DEFAULT.walk(listener, ctx)

```

输出(在`ctx`中还有很多关于sql树信息)

```

表名 => log

完整SQL =>select toUp(name) from log

```

主动模式(主动去要数据)

```

val vistor = new ArcSQLBaseVisitor[Unit] {

      override def visitQuerySpecification(ctx: QuerySpecificationContext): Unit = {

        val input = ctx.start.getTokenSource.asInstanceOf[ArcSQLLexer]._input

        val start = ctx.start.getStartIndex

        val stop = ctx.stop.getStopIndex

        val interval = new Interval(start, stop)

        val sqlText = input.getText(interval)

        println("表名 => " + ctx.tableAlias().strictIdentifier().getText)

        println("完整SQL =>" + sqlText)

      }

}

vistor.visit(ctx)

```

---

![](https://upload-images.jianshu.io/upload_images/9028759-07315bb8dadcd082.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容

  • > Antlr4 是一个强大的解析器的生成器,可以用来读取、处理、执行或翻译结构化文本,ANTLR可以从语法上来生...
    kikiki4阅读 149评论 0 3
  • > Antlr4 是一个强大的解析器的生成器,可以用来读取、处理、执行或翻译结构化文本,ANTLR可以从语法上来生...
    kikiki4阅读 156评论 0 1
  • > Antlr4 是一个强大的解析器的生成器,可以用来读取、处理、执行或翻译结构化文本,ANTLR可以从语法上来生...
    kikiki4阅读 59评论 0 2
  • > Antlr4 是一个强大的解析器的生成器,可以用来读取、处理、执行或翻译结构化文本,ANTLR可以从语法上来生...
    kikiki4阅读 104评论 0 1
  • > Antlr4 是一个强大的解析器的生成器,可以用来读取、处理、执行或翻译结构化文本,ANTLR可以从语法上来生...
    kikiki4阅读 210评论 0 4