ANTLR4入门(三):使用maven ANTLR4插件(antlr4-maven-plugin)执行语法解析生成器

已于 2024-01-05 16:44:34 修改
阅读量5k 收藏 11
点赞数 2
分类专栏： ANTLR 开发工具 文章标签： maven antlr4 plugin pom.xml
于 2022-12-19 16:49:58 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/10km/article/details/128372265
版权
本文介绍了如何在Maven项目中配置ANTLR4Maven插件，通过在pom.xml中设置相关参数，自动生成ANTLR4语法文件的解析器代码。作者分享了遇到的困难，包括插件参数设计的混乱，并给出了完整的配置示例。此外，还提供了ANTLR命令行选项的参考链接以及项目的源代码仓库地址。
摘要由CSDN通过智能技术生成

在上篇博客《ANTLR4入门(二):图示说明eclipse安装Antlr4IDE插件的过程》，我费半天劲装好了Eclise的AntlrIDE插件，简单的创建一个ANTLR 4 工程，感受了一下AntlrIDE插件提供的语法高亮的便利性。及语法文件(.g4)自动生成解析器代码的过程
在这里插入图片描述
然而热乎劲儿过后，我发现这个插件对于入门学习或许有用，除了语法高亮和语法测试比较方便外，但它只是实现了与Eclipse IDE的集成，对于基于maven构建的工程需要另外的集成方式。
在maven管理的项目中，项目编译可以在命令行进行并不一定依赖Eclipse等IDE环境。所以在maven项目中需要使用ANTL4 Maven插件(antlr4-maven-plugin)来实现语法文件到解析器代码的生成。

本文以示例说明如何在项目pom.xml中通过使用ANTLR 4 Maven 插件,来完成语法文件(.g4)自动生成解析器代码，

为了学习ANTLR4插件的使用，我创建了一个antlr4-demo项目，完整的代码放在码云仓库：https://gitee.com/l0km/antlr4-demo.git 供参考

ANTLR 工具命令行选项

在之前的博客《ANTLR4入门(一):Windows安装antlr4命令行环境》,我们知道通过命令行就能执行解析器代码自动生成。如下是命令行执行 antlr-4.11.1-complete.jar显示的命令行参数说明：

D:\os.package\devtools\antlr4>antlr4.bat
ANTLR Parser Generator  Version 4.11.1
 -o ___              specify output directory where all output is generated(指定所有的生成文件的输出位置) 
 -lib ___            specify location of grammars, tokens files(指定语法和tokens)文件的位置
 -atn                generate rule augmented transition network diagrams(生成规则增强转移网络图)
 -encoding ___       specify grammar file encoding; e.g., euc-jp(指定语法文件的编码,例如：utf-8)
 -message-format ___ specify output style for messages in antlr, gnu, vs2005(指定消息的输出风格:antlr/gun/vs2005)
 -long-messages      show exception details when available for errors and warnings(显示详细异常信息)
 -listener           generate parse tree listener (default)(生成语法分析树侦听器,默认)
 -no-listener        don't generate parse tree listener(不生成语法分析树节点侦听器)
 -visitor            generate parse tree visitor(生成语法分析树节点访问器)
 -no-visitor         don't generate parse tree visitor (default)(不生成解析树节点访问器,默认)
 -package ___        specify a package/namespace for the generated code(指定生成代码的包名/命名空间)
 -depend             generate file dependencies(生成文件依赖)
 -D<option>=value    set/override a grammar-level option(以Key=Value形式设定/覆盖一个语法级的选项)
 -Werror             treat warnings as errors(将警告当做错误处理)
 -XdbgST             launch StringTemplate visualizer on generated code(对生成的代码启动StringTemplate可视化器)
 -XdbgSTWait         wait for STViz to close before continuing
 -Xforce-atn         use the ATN simulator for all predictions(对所有的预测启动ATN模拟器)
 -Xlog               dump lots of logging info to antlr-timestamp.log(将详细日志保存为antlr-timestamp.log)
 -Xexact-output-dir  all output goes into -o dir regardless of paths/package(所有输出写入-o dir指定的位置，忽略路径和包)

关于命令行的详细说明参见：https://github.com/antlr/antlr4/blob/master/doc/tool-options.md

ANTLR 4 Mave 插件(org.antlr:antlr4-maven-plugin)本身也有一些参数定义，从插件执行和命令行执行最终都运行相同的程序。所以这两个体系提供的参数有重合。命令行参数也可以通过插件的arguments参数来指定
关于插件的参数说明参见 ：《ANTLR 4 Maven plugin》

说实话，这个Maven插件写的质量不怎么样，参数设计有些混乱，我是经过很长时间尝试才让插件运行正常，如下是插件设置的完整内容，详细说明参见pom.xml中的注释：

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.gitee.l0km</groupId>
	<artifactId>antlr4-demo</artifactId>
	<version>0.0.0-SNAPSHOT</version>
	<packaging>jar</packaging>
	<name>antlr4-demo</name>
	<url>https://gitee.com/l0km/antlr4-demo</url>
	<properties>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<!-- ANTLR 4 从4.10 版本后最低要求的JDK版本升到了11，所以如果还想在JDK8下运行行ANTLR4可以只能使用4.9.3 -->
		<antlr4.vesion>4.9.3</antlr4.vesion>
		<!-- <antlr4.vesion>4.11.1</antlr4.vesion> -->
		<!-- 定义antlr4插件输出生成代码的位置-->
		<antlr4.dir>${project.build.directory}/generated-sources/antlr4</antlr4.dir>
		<!--  
			如果希望将antlr4生成的代码加入git版本控制,
			就不能将antlr4.dir定义在${project.build.directory}文件夹下，如下定义在src文件夹中  -->
		<!--<antlr4.dir>${basedir}/src/antlr4/java</antlr4.dir>-->
		<!-- surefire 插件 跳过测试 -->
		<skipTests>true</skipTests>
	</properties>
	<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.13.1</version>
			<scope>test</scope>
		</dependency>
		<!-- 增加antlr4 运行时库依赖 -->
		<dependency>
			<groupId>org.antlr</groupId>
			<artifactId>antlr4-runtime</artifactId>
			<version>${antlr4.vesion}</version>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<!-- 	执行插件 antlr4:antlr4,根据语法文件(.g4)生成解析器(java)代码
					完整说明参见 antlr4-maven-plugin 官方文档：
					https://www.antlr.org/api/maven-plugin/latest/plugin-info.html
					也可以命令行执行 mvn antlr4:help -Ddetail=true -Dgoal=antlr4 查看在线说明
			-->
			<plugin>
				<groupId>org.antlr</groupId>
				<artifactId>antlr4-maven-plugin</artifactId>
				<version>${antlr4.vesion}</version>
				<executions>
					<execution>
						<goals>
							<goal>antlr4</goal>
						</goals>
						<configuration>
							<arguments>
								<!-- 命令行参数 -package ${package} 定义生成java代码的包名-->
								<argument>-package</argument>
								<argument>com.gitee.l0km.parser</argument>
								<!-- 输出生成的Java源码文件位置
									   这里的输出文件夹定义一定要与上面 -package 定义的包名匹配
								 -->
								<argument>-o</argument>
								<argument>${antlr4.dir}/com/gitee/l0km/parser</argument>
							</arguments>
							<!-- 指定语法文件的编码方式,默认utf-8 -->
							<!--<inputEncoding>utf-8</inputEncoding>-->
							<!-- ANTLR 语法文件(.g4) 所在位置-->
							<sourceDirectory>${basedir}/src/main/java/com/gitee/l0km/parser</sourceDirectory>
							<!-- 生成语法树侦听器(Listener)代码,默认为true -->
							<listener>true</listener>
							<!-- 生成语法树访问器(Visitor)代码,默认为false-->
							<visitor>true</visitor>
						</configuration>
					</execution>
				</executions>
			</plugin>
		</plugins>
	</build>
</project>
  • 不建议使用插件的　outputDirectory参数指定输出文件夹。如上pom.xml，使用命令行参数 -o 代替。
  • 因为所有的解析代码器都可以由语法文件生成，所以ANTLR4一般将生成的解析器代码视为中间文件，所以在本例中，也是一样，将生成的解析器代码放在了target文件夹，也就是没有保存，如果希望保存，那就换个文件夹不要指向target。

Maven执行

在antlr4-demo下执行mvn install,如下即可看到antlr4-maven-plugin的执行输出

guyadong@guyadong-PC MINGW64 /j/antlr4-demo (master)
$ mvn install
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.gitee.l0km:antlr4-demo >---------------------
[INFO] Building antlr4-demo 0.0.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- antlr4-maven-plugin:4.9.3:antlr4 (default) @ antlr4-demo ---
[INFO] ANTLR 4: Processing source directory J:\antlr4-demo\src\main\java\com\gitee\l0km\parser
[INFO] Processing grammar: Hello.g4
[INFO]
[INFO] --- build-helper-maven-plugin:3.0.0:add-source (add-source) @ antlr4-demo ---
[INFO] Source directory: J:\antlr4-demo\target\antlr4-generated\java added.
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ antlr4-demo ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory J:\antlr4-demo\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ antlr4-demo ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 7 source files to J:\antlr4-demo\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ antlr4-demo ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory J:\antlr4-demo\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ antlr4-demo ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to J:\antlr4-demo\target\test-classes
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ antlr4-demo ---
[INFO] Tests are skipped.
[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ antlr4-demo ---
[INFO] Building jar: J:\antlr4-demo\target\antlr4-demo-0.0.0-SNAPSHOT.jar
[INFO]
[INFO] --- maven-install-plugin:2.4:install (default-install) @ antlr4-demo ---
[INFO] Installing J:\antlr4-demo\target\antlr4-demo-0.0.0-SNAPSHOT.jar to J:\maven_repository\com\gitee\l0km\antlr4-demo\0.0.0-SNAPSHOT\antlr4-demo-0.0.0-SNAPSHOT.jar
[INFO] Installing J:\antlr4-demo\pom.xml to J:\maven_repository\com\gitee\l0km\antlr4-demo\0.0.0-SNAPSHOT\antlr4-demo-0.0.0-SNAPSHOT.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  2.002 s
[INFO] Finished at: 2022-12-19T16:39:35+08:00
[INFO] ------------------------------------------------------------------------

Java 8下执行

ANTLR 4 从4.10 版本后最低要求的JDK版本升到了Java 11，所以如果在Java 8上运行ANTLR4只能使用4.9.3以下的版本。
如果希望在不改变自己的当前默认JDK版本的情况使用最新的ANTLR4版本，建议使用如下脚本来执行mvn命令
mvn11.bat – 使用Java 11执行MAVEN命令

@ECHO OFF
SETLOCAL
SET JAVA_HOME=C:\Program Files\Java\jdk-11.0.11
SET PATH=%JAVA_HOME%\bin;%PATH%
mvn %*
ENDLOCAL

SETLOCAL/ENDLOCAL指令之间SET定义/修复的环境变量都只作用于当前脚本,不会影响系统的环境变量

代码结构

用Eclipse打开antlr4-demo，显示的项目结构如下：
在这里插入图片描述

完整的代码放在码云仓库：https://gitee.com/l0km/antlr4-demo.git

参考资料

《ANTLR 4 Maven plugin》
《ANTLR 工具命令行选项》

ANTLR4系列文章

《ANTLR4入门(一):Windows安装antlr4命令行环境》
《ANTLR4入门(二):图示说明eclipse Antlr4IDE插件的安装及语法测试过程》
《ANTLR4入门(三):使用maven ANTLR4插件(antlr4-maven-plugin)执行语法解析生成器》
《ANTLR4入门(四):在线语法调试塈Maven项目中使用语法调试工具TestRig》

10km
关注
专栏目录
血缘分析工具（一）之idea中使用antrl4插件和g4文件
沣东八旗的博客
03-18 573
1、idea安装antrl4的插件 2、g4文件的下载和使用 3、如成Visitor和Listener何生 4、如何调试适配无法解析的sql
antlr-maven-plugin-2.1.jar.zip
07-17
标签:antlr-maven-plugin-2.1.jar.zip,antlr,maven,plugin,2.1,jar.zip包下载,依赖包
ANTLR4 使用教程
gitblog_01054的博客
08-08 654
ANTLR4 使用教程 antlr4ANTLR (ANother Tool for Language Recognition) is a powerful parser generator for reading, processing, executing, or translating structured text or binary files.项目地址:https://gitcode....
antlr4 简单实用入门——(一)
诸葛子房的博客
12-28 1万+
Antlr4 简介 简介 Antlr4 是一款强大的语法生成器工具，可用于读取、处理、执行和翻译结构化的文本或二进制文件。基本上是当前 Java 语言中使用最为广泛的语法生成器工具。Twitter搜索使用ANTLR进行语法分析，每天处理超过20亿次查询；Hadoop生态系统中的Hive、Pig、数据仓库和分析系统所使用的语言都用到了ANTLR；Lex Machina将ANTLR用于分析法律文本；Oracle公司在SQL开发者IDE和迁移工具中使用了ANTLR；NetBeans公司的IDE使用ANTLR来
Antlr4 快速入门 - 编写语法解析器
BASK2312的博客
12-07 5437
Antlr全称(ANother Tool for Language Recognition)，Antlr4是一款强大的语法分析器生成工具，推特，Haddop，Oracle等各大知名公司在用到了Antlr来构建自己的语言处理类项目。一门语言的正式描述称为语法(grammar)，Antlr可以为语言生成一个词法分析器，并且自动建立语法分析树，也能自动生成树的遍历器，然后我们就可以访问树的节点，执行自定义业务逻辑代码。本文主要是介绍Antlr4的使用，因此不过多的介绍其特性和各种使用方式，以简单的Demo来了解下
二、创建ANTLR4的maven项目
hweinifengkuang的博客
05-01 3700
待更新。。。
antlr4-maven-plugin简单学习
lucyLee的博客
03-11 1267
antlr4-maven-plugin的简单学习，包括配置项信息、在开源组件中的使用，以及不同版本对JDK的版本要求
ANTLR v4 IntelliJ 插件使用教程
最新发布
gitblog_01001的博客
08-25 539
ANTLR v4 IntelliJ 插件使用教程 intellij-plugin-v4An IntelliJ plugin for ANTLR v4项目地址:https://gitcode.com/gh_mirrors/in/intellij-plugin-v4 项目介绍 ANTLR (ANother Tool for Language Recognition) 是一个强大的解析器生成器，用于读...
Gradle 1.12用户指南翻译——第四十章. ANTLR 插件
weixin_33851604的博客
08-31 108
本文由CSDN博客万一博主翻译，其他章节的翻译请参见： http://blog.csdn.net/column/details/gradle-translation.html 翻译项目请关注Github上的地址： https://github.com/msdx/gradledoc 本文翻译所在分支： https://github.com...
antlr4-maven-plugin-4.1-sources.jar
03-08
官方版本，亲测可用
antlr4-maven-plugin-4.1.jar
03-08
官方版本，亲测可用
antlr4-maven-plugin-4.0.jar
03-08
官方版本，亲测可用
Antlr4指南
02-22
Antlr4指南 权威介绍 学习教程
ANTLR4-Plugins-for-NetBeans：用于ANTLR 4的NetBeans插件，可将ANTLR语法文件集成到标准NetBeans项目（基于Ant或基于Maven）中
02-04
用于ANTLR 4的NetBeans插件，可以将ANTLR语法文件集成到标准NetBeans项目（基于Ant或基于Maven）中。 您可以在查阅ANTLR文档。 可以在同一网站上恢复ANTLR运行时和完整发行版（但插件1.0中包含版本4.5.3，插件1.1中...
antlr4-maven-plugin-4.0-rc-1.jar
03-08
官方版本，亲测可用
Antlr4入门（一）IDEA中Antlr的安装与使用
qq_37771475的博客
05-27 1万+
Antlr (ANother Tool for Language Recognition) 是一款强大的语法分析器生成工具，可用于读取、处理、执行和翻译结构化的文本或者二进制文件。它被广泛应用于学术领域和工业生产实践，是众多语言、工具和框架的基石。我们可以使用Antlr来开发DSL（Domain Specific Language，领域特定语言），或者一些实用工具，比如配置文件读取器、遗留代码转换器和Json解析器等等。 作为Antlr入门的第一章，我们的目标是大体上知道Antlr能做什么。为此，我们.
Antlr4入门（安装、配置、简单实例）
热门推荐
qq_41957824的博客
05-29 1万+
Antlr4安装、配置、简单实例 2020.5.28 仅本人初次使用Antlr4的经历分享 目前所知有3种使用Antlr4的方式： 通过命令行使用； 在Eclipse中安装Antlr4插件；（个人不推荐，原因：antlr4插件下载也有许多问题） 在Intellij IDEA中安装Antlr4插件。 本文仅分享第一种方式。 什么是Antlr4？ ​ Antlr4 (ANother Tool for Language Recognition)， 是一个强大的跨语言语法解析器，可以用来读取、处理、执行或
Antlr4简介
zhanglehes的专栏
09-02 1374
简介 通过Antlr4可以定义一种新的语言或者规则。它是跨语言的。 一个简单例子如下： // Tokens MUL: '*'; DIV: '/'; ADD: '+'; SUB: '-'; NUMBER: [0-9]+; WHITESPACE: [ \r\n\t]+ -> skip; // Rules start : expression EOF; expression : expression op=('*'|'/') expression # MulDiv | express
org.antlr.v4.runtime.*依赖的maven
08-30
### 回答1： org.antlr.v4.runtime.* 的 Maven 依赖如下: ``` <dependency> <groupId>org.antlr</groupId> <artifactId>antlr4</artifactId> <version>4.8</version> </dependency> ``` 需要注意的是,请确保使用最新版本，因为ANTLR版本在不断更新。 ### 回答2： org.antlr.v4.runtime是一个Java库，它是ANTLR（ANother Tool for Language Recognition）工具的一部分。ANTLR是一个用于构建语言识别工具的框架，通过使用ANTLR工具，我们可以定义自己的语言规则，并生成相应的词法分析器和语法分析器。 为了在我们的Java项目中使用org.antlr.v4.runtime库，我们可以使用Maven来管理它的依赖。Maven是一个流行的项目管理工具，它可以帮助我们自动地下载和引入项目所需的外部库。 要在Maven中引入org.antlr.v4.runtime库，我们需要在项目的pom.xml文件中添加相应的依赖项。以下是一个示例的pom.xml文件片段，演示了如何添加org.antlr.v4.runtime依赖： <dependencies> <dependency> <groupId>org.antlr</groupId> <artifactId>antlr4-runtime</artifactId> <version>4.9.2</version> </dependency> </dependencies> 在这个示例中，我们指定了用于org.antlr.v4.runtime库的依赖项。groupId是组织的唯一标识符，artifactId是库的唯一标识符，version是库的版本号。你可以根据实际情况调整这些值来匹配你所使用的org.antlr.v4.runtime库的版本。 当我们执行Maven构建时，Maven将根据这个pom.xml文件自动下载org.antlr.v4.runtime库及其所需的任何其他依赖项，并将它们添加到项目的类路径中，以便我们可以在我们的代码中使用这个库。 总之，通过使用Maven，我们可以轻松地将org.antlr.v4.runtime库添加到我们的Java项目中，以便我们可以使用ANTLR工具来进行语言识别和分析。 ### 回答3： org.antlr.v4.runtime.*是一个在Maven项目中常见的依赖项。Maven是一个用于构建和管理Java项目的工具，它使用pom.xml配置文件来管理项目的依赖项。 antlr是一种非常流行的语法解析器生成工具，它可以根据预定义的语法规则生成相应的解析器。org.antlr.v4.runtime.*是ANTLR版本4的Java运行时库的包名。这个包包含了ANTLR的运行时环境和必需的类，用于解析和处理由ANTLR生成的解析树。 如果想在Maven项目中使用org.antlr.v4.runtime.*依赖，需要在pom.xml文件中添加相应的配置。在<dependencies>标签下，添加以下内容： ``` <dependency> <groupId>org.antlr</groupId> <artifactId>antlr4-runtime</artifactId> <version>4.8</version> </dependency> ``` 这个配置会告诉Maven去下载并导入org.antlr.v4.runtime.*的相关依赖，包括antlr4-runtime库及其相关的依赖项。 一旦配置完成，Maven会自动从中央仓库或其他配置的仓库下载这些依赖，并将其添加到项目的classpath中。这样，就可以在项目中使用org.antlr.v4.runtime.*提供的类和功能了。 总之，org.antlr.v4.runtime.*是一个Maven项目中常见的依赖项，用于解析和处理由ANTLR生成的解析树。通过在pom.xml中添加相应的依赖配置，就可以使用这些类和功能，并让Maven帮助我们管理这些依赖。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

10km

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值