1. windows上安装antlr4（code generation target为Java）

晓之木初

已于 2023-03-06 01:18:32 修改

阅读量2.3k

点赞数 5

分类专栏： ANTLR 文章标签： antlr4

于 2022-07-10 17:24:42 首次发布

本文链接：https://blog.csdn.net/u014454538/article/details/125706726

版权

ANTLR 专栏收录该内容

10 篇文章

订阅专栏

1. 絮絮叨叨

读研时，需要基于不同的应用（大数据组件）比较HDFS改造后的性能，当时有使用到Impala
当时，导师给我推荐了ANTLR（ANother Tool for Language Recognition），说这个东西很有趣，可以研究研究
可是自己心浮气躁，一看介绍就怂了：词法解析、语法解析？那不是编译原理吗？本科时《编译原理》自己考的不错，但也离不开老师的仁慈和临时抱佛脚啊。

ANTLR (ANother Tool for Language Recognition) is a powerful parser generator for reading, processing, executing, or translating structured text or binary files. It’s widely used to build languages, tools, and frameworks. From a grammar, ANTLR generates a parser that can build and walk parse trees.
现在由于工作原因，接触的大数据组件很多都使用ANTLR定义SQL的解析规则，不得不静下心来，重新学习ANTLR
目前使用的ANTLR版本已经是4.x，因此ANTLR一般又叫antlr4

2. windows上安装antlr4

2.1 选择合适的antlr4安装包

本人使用的开发语言主要是Java，因此本文或者后续的文章都会使用Java作为目标语言code generation target

安装antlr4前，需要检查自己的Java版本，如果低版本的Java却安装高版本的antlr4，使用时会报错：

Execute has been compiled by a more recent version of the Java Runtime (class file version 55.0), 
this version of the Java Runtime only recognizes class file versions up to 52.0

class文件的version与Java的对应关系，可以参考记录了class file version与JDK版本对应关系的博客

下载最新的jar包

如果windows上安装的是Java 11，则可以下载最新的jar包
具体做法：antlr4的官方下载页面，点击红框中的链接，可以下载最新的jar包

下载历史jar包

本人的Java version为1.8，因此只能下载旧版本的antlr4
具体做法：antlr4的官方下载页面的最底部，点击download，进入下载列表，选择合适的jar包 —— 本人选择的是antlr-4.8-complete.jar

2.2 安装anltr4

将下载的jar放在一个合适的目录，本人将其放到了D:\antlr4
修改系统环境变量CLASSPATH，在尾部添加如下内容
```
;D:\antlr4\antlr-4.8-complete.jar
```
修改系统环境变量Path，新建一个antlr4的entry，内容为jar包所在的目录，以便系统可以自动执行D:\antlr4\目录下的bat文件
```
D:\antlr4\
```
在D:\antlr4\目录，新建antlr4.bat文件，用于编译.g4文件，生成各种.java文件
```
java org.antlr.v4.Tool %*
```
在D:\antlr4\目录下，新建grun.bat文件，从而可以基于TestRig测试工具、在不创建主程序的情况下测试文法
```
java org.antlr.v4.gui.TestRig %*
```
最终，D:\antlr4\目录存在以下文件
打开命令提示符，执行antlr4命令，将有如下输出：
执行grun命令，输出如下：

2.3 一些说明

bat文件的创建

在windows中，右键 —> 新建 —> 文本文档，将生成以.txt结尾的文本文档
需要修改文件扩展名，才能得到想要的文件
所以，笔者一般都是使用类似vscode的文本编辑器创建不同扩展名的文件，然后移动到目标目录

grun.bat文件的内容

在参考文档Setting up ANTLR4 on Windows中，grun.bat文件的内容如下：
```
java org.antlr.v4.runtime.misc.TestRig %*
```
在执行grun命令时，会有Warning提示：

3. antlr4的简单使用

3.1 antlr4命令编译.g4文件

参考官方文档中的A First Example，编写一个简单的Hello.g4文件，用于识别类似hello xxx的语法

// Define a grammar called Hello
grammar Hello;
r  : 'hello' ID ;         // match keyword hello followed by an identifier
ID : [a-z]+ ;             // match lower-case identifiers
WS : [ \t\r\n]+ -> skip ; // skip spaces, tabs, newlines

注意： .g4文件的文件名应与grammar xxx一致，因此该.g4文件名为Hello.g4
进入Hello.g4所在的目录，使用antlr4命令编译Hello.g4
```
d:
cd antlr4\file
antlr4 Hello.g4
```
在file/目录，将生成很多以Hello开头的.java文件
使用javac编译生成的Java文件
```
javac Hello*.java
```

3.2 grun命令测试rule

使用grun命令，测试Hello语法

windows中，使用ctrl + Z表示EOF（^Z）
linux、mac中ctrl + D表示EOF（^D）

# Hello为语法名，r为规parser rule（语法解析规则），-tree：以 LISP 表示法打印分析树
grun Hello r -tree

执行结果如下：
此外，还可以通过可视化的树形结构展示语法分析树
```
grun Hello r -gui
```
最终将弹出一个Java图形化界面，展示语法分析树
博客《antlr4 简明教程 —— 入门》，还提到了使用-tokens选项打印词法分析生成的token（单词）
```
grun Hello r -tokens
```
执行结果如下：