本文主要面向初学者介绍Antlr4,一款常用语词法语法解析器生成的第三方工具包。全文主要回答几个问题:
- 1、antlr的是什么?
- 2、antlr的功能有哪些,如何使用?
- 3、在公司中使用antlr案例?
不知道各位是如何关注到antlr,笔者是因为硕士阶段需要写SQL解析器才渐渐了解到它。后来发现它在大数据中非常实用,尤其在SQL方面。
Terence Parr的The Definitive Antlr 4 Reference
1、antlr的是什么?
它是一个非常强大的文本及二进制文件的解析、翻译和处理的工具。大家熟悉的Hive和Spark使用antlr生成词法语法解析器、Twitter使用antlr来解析用户输入的查询内容,Oracle把antlr的功能内嵌在SQL 开发IDE中,NetBeans IDE使用antlr解析C++语言,也有公司使用antlr来从文件中抽取信息。
其实antlr原则上应该是领域特定语言(DSL)开发工具,不仅适用于SQL,还可以用于其他自定义语言。
以上都是很官方的说明,antlr到底是什么,该怎么用,下面举2个简单例子,一个是简化SQL解析器,一个是翻译器。antlr的使用从写文法文件开始,文件后缀是g4.
####2、antlr的功能及使用
1)简易SQL解析器g4文法文件
这里创建一个SqlExample.g4的文件
grammar SqlExample:
fragment A_ : 'a' | 'A';
fragment B_ : 'b' | 'B';
fragment C_ : 'c' | 'C';
fragment D_ : 'd' | 'D';
fragment E_ : 'e' | 'E';
fragment F_ : 'f' | 'F';
fragment G_ : 'g' | 'G';
fragment H_ : 'h' | 'H';
fragment I_ : 'i' | 'I';
fragment J_ : 'j' | 'J';
fragment K_ : 'k' | 'K';
fragment L_ : 'l' | 'L';
fragment M_ : 'm' | 'M';
fragment N_ : 'n' | 'N';
fragment O_ : 'o' | 'O';
fragment P_ : 'p' | 'P';
fragment Q_ : 'q' | 'Q';
fragment R_ : 'r' | 'R';
fragment S_ : 's' | 'S';
fragment T_ : 't' | 'T';
fragment U_ : 'u' | 'U';
fragment V_ : 'v' | 'V';
fragment W_ : 'w' | 'W';
fragment X_ : 'x' | 'X';
fragment Y_ : 'y' | 'Y';
fragment Z_ : 'z' | 'Z';
keyword
: TRUE
| FALSE
| NOT
// ....
;
SEMI : ';' ;
DOT : '.' ;
COMMA : ',' ;
ASTERISK: '*' ;
CREATE: C_ R_ E_ A_ T_ E_ ;
DATABASE: D_ A_ T_ A_ B_ A_ S_ E_ ;
SCHEMA: S_ C_ H_ E_ M_ A_ ;
IF: I_ F_ ;
NOT: N_ O_ T_ ;
EXISTS: E_ X_ I_ S_ T_ S_ ;
TRUE: T_ R_ U_ E_ ;
FALSE: F_ A_ L_ S_ E_ ;
ID:
( 'A'..'Z' | 'a'..'z' | '_' | '$' | '0'..'9' )+
;
root_statement:
data_definition_statements
(SEMI)?
;
data_definition_statements:
create_statement
;
create_statement:
create_database_statement
;
create_database_statement:
CREATE (DATABASE | SCHEMA) (IF NOT EXISTS)? database_name
;
database_name: ID
| keyword
;
对该文法文件使用Intellij IDE的antlr4插件运行文法文件,输入:create database online; 则出现生成如下语法树的图:
从图中可以看出该DDL的建表SQL语句被解析后的语法树形状。
g4文法文件通过antlr工具生成lexer词法解析器和parser语法解析器以及visitor和listener的java文件或其他语言文件(支持多语言)。
lexer是对语句进行词法分析,把SQL切分为不同的token,
就可以对语句中的重要信息进行处理。
以下是个人开源的高效SQL解析器的g4文法文件,供大家学习参考:https://github.com/BruceXu1991/UniformSQLParser
补充:本人实验的版本是Antlr 4.5.3,对于IDEA的ANTLR v4 grammar plugin是1.8.2;在新版本IDEA可能会出现bug导致执行异常。