Maven多模块项目：子模块无法读取兄弟模块的JPA元模型

问题场景 #

我有一个包含两个兄弟模块的Maven多模块项目：

• Project A：配置了JPA元模型生成，pom.xml构建配置如下：

<build>
    <finalName>${project.artifactId}</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.7.0</version>
            <configuration>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.hibernate</groupId>
                        <artifactId>hibernate-jpamodelgen</artifactId>
                        <version>${version.hibernate-jpamodelgen}</version>
                    </path>
                </annotationProcessorPaths>
                <source>1.8</source>
                <target>1.8</target>
                <compilerArgument>-proc:none</compilerArgument>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.bsc.maven</groupId>
            <artifactId>maven-processor-plugin</artifactId>
            <version>5.0-jdk8</version>
            <executions>
                <execution>
                    <id>process</id>
                    <goals>
                        <goal>process</goal>
                    </goals>
                    <phase>generate-sources</phase>
                    <configuration>
                        <processors>
                            <processor>org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor</processor>
                        </processors>
                        <outputDirectory>target/generated-sources/annotations</outputDirectory>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>org.hibernate</groupId>
                    <artifactId>hibernate-jpamodelgen</artifactId>
                    <version>1.2.0.Final</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

• Project B：作为Project A的兄弟模块，依赖Project A，pom.xml依赖配置如下：

<dependency>
    <groupId>com.acme</groupId>
    <artifactId>project-a</artifactId>
    <scope>provided</scope>
</dependency>

Project B需要读取Project A生成的元模型类，但编译时提示找不到符号：

[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] /C:/workspace/parent-project/project-b/src/main/java/com/acme/SomeClassUsingMetamodel.java: cannot find symbol
symbol:   class MetamodelClass_
location: package com.acme.project-b.model.someentity

问题原因 #

1. 元模型类未被打包到Project A的Jar中：maven-processor-plugin生成的元模型类默认存放在target/generated-sources/annotations目录，但该目录未被Maven标记为源码目录，因此编译时不会将这些类包含到最终的Jar包中，导致Project B依赖时无法访问。
2. 依赖版本不一致：Project A中maven-compiler-plugin使用的hibernate-jpamodelgen版本是变量${version.hibernate-jpamodelgen}，但maven-processor-plugin依赖中硬编码了1.2.0.Final，可能引发版本冲突。
3. 依赖Scope可能不合理：provided scope表示依赖仅在编译和测试阶段可用，且不会被打包到最终产物中，如果Project A的Jar未提前构建并被正确识别，可能导致编译时无法找到依赖类。

解决方案 #

1. 将生成的元模型目录标记为源码目录 #

使用build-helper-maven-plugin将target/generated-sources/annotations添加到Project A的源码目录中，确保元模型类被编译并打包到Jar中：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>build-helper-maven-plugin</artifactId>
    <version>3.3.0</version>
    <executions>
        <execution>
            <id>add-source</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>add-source</goal>
            </goals>
            <configuration>
                <sources>
                    <source>target/generated-sources/annotations</source>
                </sources>
            </configuration>
        </execution>
    </executions>
</plugin>

2. 统一hibernate-jpamodelgen版本 #

修改Project A的maven-processor-plugin依赖，使用统一的版本变量，避免版本冲突：

<dependencies>
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-jpamodelgen</artifactId>
        <version>${version.hibernate-jpamodelgen}</version>
    </dependency>
</dependencies>

3. 调整依赖Scope（按需） #

如果Project B在运行时也需要Project A的Jar，将依赖Scope改为compile；如果确实是provided场景，确保Project A已经提前构建完成，且在编译Project B时能正确找到其Jar包：

<dependency>
    <groupId>com.acme</groupId>
    <artifactId>project-a</artifactId>
    <scope>compile</scope>
</dependency>

4. 确保模块构建顺序 #

在父项目的pom.xml中显式指定模块构建顺序，确保Project A先于Project B构建：

<modules>
    <module>project-a</module>
    <module>project-b</module>
</modules>

验证步骤 #

1. 执行mvn clean install构建父项目，确保Project A的Jar包含元模型类。
2. 单独编译Project B，检查是否还存在找不到元模型类的错误。

内容的提问来源于stack exchange，提问作者fco