maven - 使用 maven antlr4 插件从其他工件生成语法

Question

我想使用 antlr4 为语法生成一个 java parser api。我意识到其他人可能对语法部分感兴趣，所以我想将 maven 中的解析器工件与语法工件分开。

我几乎已经完成了所有工作，问题似乎是它使用正确的包生成 *.java 文件，但将它们放在代表不同包的目录中。

我有一个带有父模块和两个模块的多模块 Maven 项目；语法和解析器。语法生成一个包含以下内容的简单 jar：

META-INF/
META-INF/MANIFEST.MF
org/
org/boazglean/
org/boazglean/dabar/
org/boazglean/dabar/grammer/
org/boazglean/dabar/grammer/DabarLexer.g4
org/boazglean/dabar/grammer/DabarParser.g4
META-INF/maven/
META-INF/maven/org.boazglean.dabar/
META-INF/maven/org.boazglean.dabar/grammer/
META-INF/maven/org.boazglean.dabar/grammer/pom.xml
META-INF/maven/org.boazglean.dabar/grammer/pom.properties

现在我想生成一个解析器 jar，包中有一堆解析器类org.boazglean.dabar.parser。这是我使用的 pom 配置：

<plugin>
    <groupId>org.antlr</groupId>
    <artifactId>antlr4-maven-plugin</artifactId>
    <version>4.0</version>
    <executions>
        <execution>
            <goals>
                <goal>antlr4</goal>
            </goals>
            <configuration>
                <sourceDirectory>${antlr.dir}</sourceDirectory>
                <listener>true</listener>
                <visitor>true</visitor>
                <arguments>
                    <argument>-package</argument>
                    <argument>org.boazglean.dabar.parser</argument>
                </arguments>
            </configuration>
        </execution>
    </executions>
</plugin>
<plugin>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
        <execution>
            <id>extract-grammer</id>
            <phase>initialize</phase>
            <goals>
                <goal>unpack-dependencies</goal>
            </goals>
            <configuration>
                <includeArtifactIds>grammer</includeArtifactIds>
                <outputDirectory>${antlr.dir}</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

现在的问题是生成的源代码出现在错误的目录中（但它们确实有正确的包）。

head -n 2 parser/target/generated-sources/antlr4/org/boazglean/dabar/grammer/DabarLexer.java 

// Generated from org/boazglean/dabar/grammer/DabarLexer.g4 by ANTLR 4.0
package org.boazglean.dabar.parser;

我是否遗漏了一些我应该用来配置 antlr4 的命令？

Answer 1

1. 制作语法文件夹结构/src/main/antlr4/org/nimy/antlr4/xml/xxxx.g4

2. 在 pom.xml 中

<plugin>
    <groupId>org.antlr</groupId>
    <artifactId>antlr4-maven-plugin</artifactId>
    <version>4.1</version>
    <configuration>
        <listener>true</listener>
        <visitor>true</visitor>
        <arguments>
            <argument>-package</argument>
        </arguments>
    </configuration>
    <executions>
        <execution>
            <id>antlr-generate</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>antlr4</goal>
            </goals>
        </execution>
    </executions>
</plugin>

3. 包中生成Java代码：包org.nimy.antlr4.xml

github上的antlt4 maven插件源代码。尝试阅读它并获得配置项目的方法。antlr4 源代码

Answer 2

对于语法项目。文件夹结构应如下所示：

ls -R grammar/
grammar/:
pom.xml  src

grammar/src:
main  test

grammar/src/main:
resources

grammar/src/main/resources:
org

grammar/src/main/resources/org:
boazglean

grammar/src/main/resources/org/boazglean:
dabar

grammar/src/main/resources/org/boazglean/dabar:
grammar

grammar/src/main/resources/org/boazglean/dabar/grammar:
DabarLexer.g4  DabarParser.g4

现在，当您构建此项目时，您将拥有一个结构如下的 jar：

jar -tf grammar/target/grammar-1.0-SNAPSHOT.jar 
META-INF/
META-INF/MANIFEST.MF
org/
org/boazglean/
org/boazglean/dabar/
org/boazglean/dabar/grammar/
org/boazglean/dabar/grammar/DabarParser.g4
org/boazglean/dabar/grammar/DabarLexer.g4
META-INF/maven/
META-INF/maven/org.boazglean.dabar/
META-INF/maven/org.boazglean.dabar/grammar/
META-INF/maven/org.boazglean.dabar/grammar/pom.xml
META-INF/maven/org.boazglean.dabar/grammar/pom.properties

现在为解析器项目。它将使用 org.boazglean.dabar.grammar 中的语法并在 org.boazglean.dabar.parser 中生成解析器

对于解析器项目。文件夹结构应如下所示：

ls -R parser/
parser/:
pom.xml  src

parser/src:
test

parser/src/test:
java

parser/src/test/java:
org

parser/src/test/java/org:
boazglean

parser/src/test/java/org/boazglean:
dabar

parser/src/test/java/org/boazglean/dabar:
parser

parser/src/test/java/org/boazglean/dabar/parser:
DabarLexerTest.java

现在繁重的工作在 pom.xml 中供以后使用：

<properties>
    <antlr.grammar.dir>${project.build.directory}/grammar/</antlr.grammar.dir>
    <antlr.parser.dir>${project.build.directory}/generated-sources/antlr/</antlr.parser.dir>
</properties>

首先，我们需要从语法 jar 中提取语法。这允许 antlr 运行它。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <executions>
        <execution>
            <id>extract-grammar</id>
            <phase>initialize</phase>
            <goals>
                <goal>unpack-dependencies</goal>
            </goals>
            <configuration>
                <includeArtifactIds>grammar</includeArtifactIds>
                <outputDirectory>${antlr.grammar.dir}</outputDirectory>
            </configuration>
        </execution>
    </executions>
</plugin>

现在已经下载了语法，我们可以生成解析器。为此，我们需要将 antlr 指向不是包的根目录 (${antlr.grammar.dir})，而是指向包的顶部 ${antlr.grammar.dir}/org/boazglean/dabar/grammar / 同样，我们必须不在包的根目录 ${project.build.directory}/generated-sources/antlr/ 生成 java 文件，而是在包的顶部 ${project.build.directory}/生成源/antlr/org/boazglean/dabar/parser。为了使其与项目的 groupId 和 artifactId 保持一致，我们将使用 build helper 插件生成一些新属性，以通过替换所有 '.' 来使用。在 groupId 中使用 '/' 形成路径。

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>build-helper-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>antlr.grammar.package.dir</id>
            <goals>
                <goal>regex-property</goal>
            </goals>
            <configuration>
                <name>antlr.grammar.package.dir</name>
                <regex>\.</regex>
                <value>${antlr.grammar.dir}/${project.groupId}/grammar</value>
                <replacement>/</replacement>
            </configuration>
        </execution>
        <execution>
            <id>antlr.parser.package.dir</id>
            <goals>
                <goal>regex-property</goal>
            </goals>
            <configuration>
                <name>antlr.parser.package.dir</name>
                <regex>\.</regex>
                <value>${antlr.parser.dir}/${project.groupId}/${project.artifactId}</value>
                <replacement>/</replacement>
            </configuration>
        </execution>
    </executions>
</plugin>

现在我们有两个新属性；antlr.grammar.package.dir、antlr.parser.package.dir 为我们提供了 antlr 所需的正确路径。现在我们可以调用 antlr

<plugin>
    <groupId>org.antlr</groupId>
    <artifactId>antlr4-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>generate-antlr-sources</id>
            <goals>
                <goal>antlr4</goal>
            </goals>
            <configuration>
                <sourceDirectory>${antlr.grammar.package.dir}</sourceDirectory>
                <listener>true</listener>
                <visitor>true</visitor>
                <outputDirectory>${antlr.parser.package.dir}</outputDirectory>
                <arguments>
                    <argument>-package</argument>
                    <argument>${project.groupId}.${project.artifactId}</argument>
                </arguments>
            </configuration>
        </execution>
    </executions>
</plugin>

最后一件事，antlr 生成非常有用的令牌文件。但此时它们不会进入您的 parser.jar。因此，我们将其添加为资源。我们不想添加位于令牌文件旁边的 java 文件，因此我们将在资源中添加一个排除项：

<resource>
    <directory>${antlr.parser.dir}</directory>
    <includes>
        <include>**/*.tokens</include>
    </includes>
</resource>

现在您可以构建，您的测试将能够使用 antlr 生成的解析器，您的解析器 jar 将如下所示：

jar -tf parser/target/parser-1.0-SNAPSHOT.jar 
META-INF/
META-INF/MANIFEST.MF
org/
org/boazglean/
org/boazglean/dabar/
org/boazglean/dabar/parser/
org/boazglean/dabar/parser/DabarLexer.tokens
org/boazglean/dabar/parser/DabarParser.tokens
org/boazglean/dabar/parser/DabarLexer.class
org/boazglean/dabar/parser/DabarParserListener.class
org/boazglean/dabar/parser/DabarParser$ProgramContext.class
org/boazglean/dabar/parser/DabarParser$PhraseContext.class
org/boazglean/dabar/parser/DabarParser$CallContext.class
org/boazglean/dabar/parser/DabarParser$PassContext.class
org/boazglean/dabar/parser/DabarParser$ReferenceContext.class
org/boazglean/dabar/parser/DabarParser$SentenceContext.class
org/boazglean/dabar/parser/DabarParser$CompoundContext.class
org/boazglean/dabar/parser/DabarParser$BlockContext.class
org/boazglean/dabar/parser/DabarParser.class
org/boazglean/dabar/parser/DabarParserBaseVisitor.class
org/boazglean/dabar/parser/DabarParserVisitor.class
org/boazglean/dabar/parser/DabarParserBaseListener.class
META-INF/maven/
META-INF/maven/org.boazglean.dabar/
META-INF/maven/org.boazglean.dabar/parser/
META-INF/maven/org.boazglean.dabar/parser/pom.xml
META-INF/maven/org.boazglean.dabar/parser/pom.properties

成功。

Answer 3

这看起来正在做它应该做的事情。事实上，您甚至不需要-package在 pom.xml 中指定参数，因为它是根据项目中 .g4 文件的位置自动确定的。

编辑：

如果您希望将输出文件放置在 中org/boazglean/dabar/parser，那么您还需要将输入文件放置在该路径下。