使用hibernate-jpamodelgen生成外部Jar中JPA元模型失败求解决办法

我之前也碰到过一模一样的情况——hibernate-jpamodelgen默认只会扫描你项目src目录下的实体类，对于依赖Jar里的实体确实不会自动处理。下面是几个经过验证的可行方案，你可以根据自己的场景选择：

方案一：用maven-processor-plugin显式指定扫描外部Jar #

这是最直接的解决方式，通过maven-processor-plugin控制注解处理器的扫描范围，把包含外部实体的Jar加入处理器的classpath中。

在你的pom.xml里添加如下配置：

<build>
    <plugins>
        <!-- 配置JPA元模型处理器 -->
        <plugin>
            <groupId>org.bsc.maven</groupId>
            <artifactId>maven-processor-plugin</artifactId>
            <version>3.3.3</version>
            <executions>
                <execution>
                    <id>generate-jpa-metamodel</id>
                    <goals>
                        <goal>process</goal>
                    </goals>
                    <phase>generate-sources</phase>
                    <configuration>
                        <!-- 指定Hibernate的元模型处理器 -->
                        <processors>
                            <processor>org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor</processor>
                        </processors>
                        <!-- 允许覆盖处理器的classpath -->
                        <overridableClasspath>true</overridableClasspath>
                        <!-- 添加外部实体Jar到处理器路径 -->
                        <additionalClasspathElements>
                            <additionalClasspathElement>
                                <!-- 替换成你的外部Jar坐标对应的本地路径，或者用Maven依赖插件先解压 -->
                                ${settings.localRepository}/com/yourgroup/SomeOtherEntities/1.0/SomeOtherEntities-1.0.jar
                            </additionalClasspathElement>
                        </additionalClasspathElements>
                        <!-- 指定元模型生成的输出目录 -->
                        <outputDirectory>${project.build.directory}/generated-sources/jpamodelgen</outputDirectory>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>org.hibernate</groupId>
                    <artifactId>hibernate-jpamodelgen</artifactId>
                    <version>5.2.12.Final</version>
                </dependency>
            </dependencies>
        </plugin>
        <!-- 把生成的元模型目录加入源码路径，让IDE能识别 -->
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
                <execution>
                    <id>add-generated-source</id>
                    <phase>generate-sources</phase>
                    <goals>
                        <goal>add-source</goal>
                    </goals>
                    <configuration>
                        <sources>
                            <source>${project.build.directory}/generated-sources/jpamodelgen</source>
                        </sources>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

如果不想硬编码Jar路径，还可以先用maven-dependency-plugin把外部Jar解压到本地目录，再让处理器扫描解压后的class文件：

<!-- 先解压外部实体Jar -->
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>3.6.0</version>
    <executions>
        <execution>
            <id>unpack-external-entities</id>
            <phase>generate-sources</phase>
            <goals>
                <goal>unpack</goal>
            </goals>
            <configuration>
                <artifactItems>
                    <artifactItem>
                        <groupId>com.yourgroup</groupId>
                        <artifactId>SomeOtherEntities</artifactId>
                        <version>1.0</version>
                        <outputDirectory>${project.build.directory}/unpacked-entities</outputDirectory>
                    </artifactItem>
                </artifactItems>
            </configuration>
        </execution>
    </executions>
</plugin>

然后把maven-processor-plugin里的additionalClasspathElement替换成解压目录：

<additionalClasspathElement>${project.build.directory}/unpacked-entities</additionalClasspathElement>

方案二：将外部实体Jar转为项目子模块（若有权限修改源码） #

如果你能拿到外部实体Jar的源码，直接把它作为子模块加入你的项目结构中，这样hibernate-jpamodelgen就能自动扫描到这些实体类。这种方式适合长期维护的场景，避免每次Jar版本更新都要调整处理器配置。

方案三：手动生成元模型打包成Jar（一次性场景） #

如果外部实体Jar的结构比较稳定，你可以单独建一个小项目，引入这个Jar和hibernate-jpamodelgen，手动生成元模型类，然后把生成的类打包成Jar，再作为依赖引入到主项目中。这种方式适合不需要频繁更新外部实体的场景。

验证方式 #

配置完成后，执行mvn clean generate-sources，查看target/generated-sources/jpamodelgen目录下是否生成了外部实体对应的元模型类（命名规则是原实体类名加下划线，比如User_）。如果IDE没自动识别，手动把这个目录添加到IDE的源码路径即可。

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