Hibernate Maven 插件 hbm2java 实战基于 H2 Sakila 数据库逆向生成无注解 POJO 实体【免费下载链接】hibernate-ormIdiomatic persistence for Java and relational databases项目地址: https://gitcode.com/GitHub_Trending/hi/hibernate-orm导读本文以 Hibernate ORM 仓库中hbm2java目标的无注解no-annotations示例为骨架完整讲解如何借助 Hibernate Maven 插件org.hibernate.orm:hibernate-maven-plugin从运行中的数据库反向生成 Java 实体源码。示例以 H2 内存数据库中的 Sakila 示例库为目标通过一行 Maven 命令即可在generate-sources阶段产出不含任何 JPA 注解的纯 POJO 类。读完本文你将掌握 hbm2java 目标的完整配置方式、ejb3false等关键参数的含义与底层作用以及如何复现、验证这一逆向工程流程。一、示例概览从数据库到 Java 源码的单命令逆向hbm2java是 Hibernate Maven 插件提供的一个 MojoMaven 插件目标其职责是从现有数据库生成 Java JPA 实体。本示例所在的目录为 tooling/hibernate-maven-plugin/src/intTest/resources/hbm2java/no-annotations它隶属于插件自身的集成测试intTest资源作用是验证当关闭注解输出时插件能否基于真实数据库连接完成逆向并生成纯 POJO。其README.md给出的核心使用步骤非常简洁完整引用如下安装 Apache Maven运行 H2 Sakila 数据库在该示例目录的命令行窗口中执行mvn generate-sources -Dh2.version${h2.version} -Dhibernate.version${hibernate.version}其中${h2.version}与${hibernate.version}为 Maven 属性占位符实际运行时应替换为具体版本号例如-Dh2.version2.3.232 -Dhibernate.version6.6.0.Final以当时可用的发布版本为准。这两个属性会被注入示例pom.xml中的依赖与插件版本声明确保示例使用与当前 Hibernate ORM 构建相匹配的插件版本。二、示例工程结构剖析该示例虽然体积小但麻雀虽小五脏俱全其文件布局反映了 Hibernate Maven 插件逆向工程的标准输入约定hbm2java/no-annotations/ ├── README.md # 运行说明本文主题文档 ├── pom.xml # Maven 构建配置声明插件与 H2 依赖 └── src/main/ └── resources/ └── hibernate.properties # 数据库连接与默认 catalog/schema 配置2.1 连接配置文件 hibernate.properties插件执行逆向时会读取src/main/resources/hibernate.properties该路径正是 AbstractGenerationMojo 中propertyFile参数的默认值${project.basedir}/src/main/resources/hibernate.properties从中获取 JDBC 连接信息。示例内容如下hibernate.connection.driver_classorg.h2.Driver hibernate.connection.urljdbc:h2:tcp://localhost/./sakila hibernate.connection.usernamesa hibernate.default_catalogSAKILA hibernate.default_schemaPUBLIC各配置项含义配置项值作用hibernate.connection.driver_classorg.h2.DriverJDBC 驱动类这里使用 H2 数据库驱动hibernate.connection.urljdbc:h2:tcp://localhost/./sakilaTCP 方式连接本机已启动的 Sakila 数据库服务hibernate.connection.usernamesa数据库用户名H2 默认用户hibernate.default_catalogSAKILA指定默认 catalog逆向时限定在该 catalog 下读取表结构hibernate.default_schemaPUBLIC指定默认 schema确保表定位准确注意连接串采用tcp://服务器模式而非mem:内存模式这正对应 README 中Have H2 Sakila database running这一前置条件——Hibernate Tools 的逆向引擎通过 JDBCDatabaseMetaData读取实时数据库元数据因此必须先启动数据库实例。2.2 插件声明 pom.xml示例的pom.xml是理解 hbm2java 用法的关键核心片段如下dependencies dependency groupIdcom.h2database/groupId artifactIdh2/artifactId version${h2.version}/version /dependency /dependencies build plugins plugin groupIdorg.hibernate.orm/groupId artifactIdhibernate-maven-plugin/artifactId version${hibernate.version}/version executions execution idEntity generation/id phasegenerate-sources/phase goals goalhbm2java/goal /goals /execution /executions configuration ejb3false/ejb3 /configuration /plugin /plugins /build要点解读依赖 H2 驱动逆向需要连接数据库因此把com.h2database:h2作为项目依赖加入插件在运行时通过项目运行时 classpath 加载 JDBC 驱动目标绑定生命周期hbm2java目标被绑定到generate-sources阶段这样执行mvn generate-sources或任何包含该阶段的完整构建时即自动触发代码生成ejb3false/ejb3是本示例的灵魂配置它显式关闭 JPA 注解输出让生成的实体成为纯 POJO——这正是本示例与 jpa-default 等默认示例的核心差异点。三、ejb3 参数控制注解生成的开关在 GenerateJavaMojo 中ejb3参数被声明为/** Code will contain JPA features, e.g. using annotations from jakarta.persistence * and org.hibernate.annotations. */ Parameter(defaultValue true) private boolean ejb3;即默认值true生成的代码包含 JPA 特性例如使用jakarta.persistence与org.hibernate.annotations下的注解对应 jpa-default 示例的默认行为设为false本示例的做法关闭注解输出生成无注解的普通 Java 类字段、getter/setter 直接与数据库列对应类本身不标注Entity。该参数最终被传入底层导出器Exporter属性pojoExporter.getProperties().setProperty(ejb3, String.valueOf(ejb3));从源码调用链看hbm2java目标通过 ExporterFactory.createExporter(ExporterType.JAVA) 创建 POJO 导出器并依次写入元数据描述符、目标输出目录outputDirectory默认${project.build.directory}/generated-sources/、可选模板路径templatePath以及ejb3、jdk5两个布尔属性随后调用pojoExporter.start()执行导出。可以说ejb3与jdk5是决定生成什么风格代码的两个最直接开关。四、hbm2java 目标完整参数清单综合 GenerateJavaMojo 与其父类 AbstractGenerationMojo 的声明hbm2java目标支持的全部配置参数如下参数默认值说明ejb3true生成代码是否包含 JPA 注解jakarta.persistence与org.hibernate.annotations。设为false即输出纯 POJO对应本示例jdk5true生成代码是否使用 JDK 5 语法如泛型与静态导入outputDirectory${project.build.directory}/generated-sources/生成实体的输出目录templatePath无用户自定义模板的查找路径可覆盖默认 POJO 模板packageName无为映射类创建时使用的默认包名revengFile无逆向工程配置文件如hibernate.reveng.xmlrevengStrategy无自定义逆向工程策略类全名可扩展DefaultReverseEngineeringStrategy以调整类命名或类型映射detectManyToManytrue纯多对多连接表主键仅含两个指向实体表的外键且无其他列是否映射为多对多detectOneToOnetrue每个外键是否生成一对一关联detectOptimisticLocktrue名为VERSION或TIMESTAMP且类型合适的列是否映射为version/timestamp乐观锁createCollectionForForeignKeytrue每个外键是否映射一个集合属性createManyToOneForForeignKeytrue每个外键是否生成多对一关联其中关联检测类参数detectManyToMany、detectOneToOne等在setupReverseEngineeringStrategy()中通过RevengSettings写入逆向策略见 AbstractGenerationMojo。若需更精细地控制表/列/类型的映射行为可自定义revengStrategy或使用revengFile提供逆向工程规则。此外AbstractGenerationMojo.execute()展示了完整执行流程源码位置基于项目运行时 classpath 构造导出用类加载器保证能加载 H2 驱动等依赖依据revengStrategy与revengFile创建逆向策略RevengStrategy并应用关联检测设置检查propertyFile默认src/main/resources/hibernate.properties是否存在——若缺失则直接中止并打印Property file ... cannot be found, aborting...存在则加载属性文件构造 JDBC 元数据描述符MetadataDescriptorFactory.createReverseEngineeringDescriptor调用子类即GenerateJavaMojo的executeExporter完成实际导出。五、运行前提与完整执行步骤5.1 前置条件按示例 README复现前需满足Apache Maven 已安装且mvn在 PATH 中可用H2 Sakila 数据库正在运行监听本地jdbc:h2:tcp://localhost/./sakila。Sakila 是经典的电影租赁示例数据库表如film、actor、category、rental等Hibernate 官方提供了其 H2 移植版本示例的逆向结果即来自该库的表结构元数据。5.2 执行命令在 no-annotations 目录下执行mvn generate-sources -Dh2.version${h2.version} -Dhibernate.version${hibernate.version}命令分解mvn generate-sources触发绑定在generate-sources阶段的hbm2java目标-Dh2.version...指定 H2 驱动依赖版本被pom.xml中的${h2.version}引用-Dhibernate.version...指定hibernate-maven-plugin插件版本被pom.xml中的${hibernate.version}引用。执行成功后插件会打印类似Starting POJO export to directory: ...、Finished GenerateJavaMojo!的日志对应 GenerateJavaMojo.executeExporter 中的getLog()输出生成的无注解 POJO 类默认输出到target/generated-sources/目录随后可被compile阶段正常编译。5.3 验证方式与同族示例对照仓库的集成测试目录还提供了多个 hbm2java 对照示例便于验证不同参数组合的效果hbm2java/jpa-default不写任何configuration使用ejb3true默认值生成带 JPA 注解的实体hbm2java/use-generics验证jdk5true时泛型集合的输出hbm2java/no-generics对照关闭泛型的输出hbm2java/output-directory演示通过-Doutput.dir./generated-classes自定义输出目录hbm2java/template-path演示templatePath自定义模板内置templates/pojo/Pojo.ftl。将本示例生成的纯 POJO 与jpa-default生成的注解实体对比即可直观理解ejb3开关对代码风格的影响。5.4 自动化集成测试支撑从插件自身的集成测试基类 AbstractMavenTestIT 可以看到这些示例目录并非摆设测试通过内嵌MavenCli在示例目录中真实执行 Maven 构建runMaven(workingDirectory, goals...)源码位置并以退出码 0 断言构建成功。这证明README.md中给出的命令是经过 CI 实际验证、可重复执行的真实流程。六、常见问题与注意事项Property file ... cannot be found, aborting...插件未找到src/main/resources/hibernate.properties请确认该文件存在且路径正确可通过propertyFile参数覆盖默认路径连接失败先确认 Sakila 数据库已启动且监听localhost的 9092 端口H2 TCP 默认端口hibernate.connection.url中的 catalog/schemaSAKILA/PUBLIC需与库中实际值一致版本不匹配hibernate.version应与本地安装的 Hibernate ORM 版本一致避免插件与运行时 API 不兼容输出位置默认输出到target/generated-sources/该目录通常已由 Maven 自动加入源码根无需手动配置如需自定义使用outputDirectory参数。七、小结本示例以最精简的方式展示了 Hibernate Maven 插件hbm2java目标的完整用法一个绑定到generate-sources阶段的插件声明、一份hibernate.properties连接配置、一个ejb3false/ejb3开关外加一行带版本属性的 Maven 命令即可从运行中的 H2 Sakila 数据库逆向生成可编译、可使用的无注解 POJO 实体。结合 GenerateJavaMojo 源码可以看到ejb3、jdk5、outputDirectory、templatePath等参数最终都会透传给底层 POJO 导出器控制代码生成的每一处细节。对于希望以数据库优先方式快速产出实体骨架、或需要完全掌控实体代码风格的团队而言这是一个开箱即用且经 CI 验证的可靠方案。【免费下载链接】hibernate-ormIdiomatic persistence for Java and relational databases项目地址: https://gitcode.com/GitHub_Trending/hi/hibernate-orm创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考