HibernateTools：高效开发的得力助手

### Hibernate Tools：高效开发的得力助手 Hibernate Tools 工具集包含两类工具：用于增强 Eclipse 集成开发环境（IDE）的插件，以及适用于 Ant 构建工具的任务集。尽管它们的外观不同，但实现上有很多共享部分。需要注意的是，目前 Hibernate Tools 处于高级测试阶段，使用时可能会遇到一些问题，但大多可以解决。 #### 1. Eclipse 插件 Eclipse 是近年来广受欢迎的 Java 开发环境，它起源于 IBM 的 WebSphere Application Developer（WSAD）环境，后作为开源应用发布。Eclipse 以核心应用为基础，通过各种插件扩展功能，通常包含 Java 开发工具（JDT）。 ##### 1.1 下载与安装 - **下载 Eclipse**：可从 Eclipse 基金会网站（www.eclipse.org）下载，当前最新版本的 SDK 是 3.1.2，下载文件名为 eclipse - SDK - 3.1.2 - win32.zip。 - **下载含 Hibernate 插件的 Eclipse**：JBoss 提供了包含 Hibernate 插件的 Eclipse 版本，可从其网站（http://download.jboss.com/jbosside/builds）下载。若选择此版本，可跳过后续安装步骤。 - **安装插件**：使用 Eclipse 的标准更新功能进行安装，步骤如下： 1. 选择“Help” -> “Software Updates” -> “Find and Install”。 2. 选择搜索新功能，因为 Hibernate 不是标准的 Eclipse SDK 组件。 3. 默认情况下，Eclipse 仅知晓 Eclipse 基金会网站为新功能源，点击右上角的“New Remote Site”按钮，添加获取 Hibernate Tools 插件的站点，当前下载站点为 http://download.jboss.org/jbosside/updates/development 。 4. 返回站点列表，取消勾选 Eclipse 下载站点，因为只安装 Hibernate Tools 插件。 5. 点击“Next”，Eclipse 将从提供的更新站点下载可用更新列表。若遇到问题，检查代理设置和 URL 是否正确。 6. 成功到达此步骤后，选择 Hibernate Tools 复选框，点击“Next”。 7. Eclipse 列出要安装的功能，并提示接受插件功能的许可证，勾选“Accept”并点击“Next”。 8. 确认要安装的功能，可选择非标准安装位置，通常接受默认安装到 Eclipse 插件目录，点击“Finish”。 9. 由于 Hibernate Tools 插件未进行数字签名，Eclipse 会发出警告，接受验证提示以继续安装。 10. 最后，Eclipse 提示重启或直接应用更改，建议选择重启。 如果无法或不想直接从 Eclipse 安装，也可从 Hibernate 网站下载 ZIP 文件，将插件目录复制到 Eclipse 的插件目录上，然后重启 Eclipse。但不建议新手尝试此方法。 ##### 1.2 项目配置 - **创建用户库**：为方便向新项目添加 JAR 文件，可创建用户库。从“Window” -> “Preferences”菜单创建，选择“Java” -> “Build Path” -> “User Libraries”节点，点击“add”按钮创建库。第一个库包含 Hibernate 核心的 JAR 文件，建议在库名中包含完整版本号。添加核心 Hibernate 3 JAR 文件分两步：先选择 hibernate3.jar 文件，再选择 lib 子目录下的所有 JAR 文件。重复此过程创建 Hibernate Annotations 用户库。 - **创建项目**：创建名为 ToolsExample 的新 Java 项目，从 Apress 网站（www.apress.com）获取示例源代码，复制到工作区目录的 ToolsExample 文件夹中并刷新项目。 - **配置项目**：若 Eclipse 在 1.4 JVM 或更早版本下运行且要使用注解，需重新配置为在 Java 5 下运行，可在 Eclipse 命令行添加 - vm 标志。目前 Hibernate Tools 存在一个小问题，若配置文件在项目根目录可能会有问题，因此将项目配置为包含单独的 src 和 bin 目录，分别作为源文件夹和默认输出文件夹。 - **添加用户库**：选择项目的“Build Path” -> “Configure Build Path”，在“Libraries”选项卡中点击“Add Library”，选择“User Library”，勾选之前配置的两个 Hibernate 库，点击“Finish”，最后点击“OK”接受路径更改。 - **打开 Hibernate 控制台视角**：可通过“Window” -> “Open Perspective”或点击“Open Perspective”图标，选择“Other”，再选择“Hibernate Console”。 #### 2. 使用 Hibernate 控制台 ##### 2.1 创建 Hibernate 控制台配置 Hibernate 控制台需要与其他 Hibernate 客户端相同的基本配置信息，如 Hibernate XML 配置文件和/或属性文件。示例配置文件如下： ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> <hibernate-configuration> <session-factory> <!-- 数据库设置 --> <property name="hibernate.connection.driver_class"> org.hsqldb.jdbcDriver </property> <property name="hibernate.connection.url"> jdbc:hsqldb:file:/workspace/ToolsExample/db/annotationsdb;shutdown=true </property> <property name="hibernate.dialect"> org.hibernate.dialect.HSQLDialect </property> <property name="hibernate.connection.username">sa</property> <property name="hibernate.connection.password"/> <property name="hibernate.connection.pool_size">0</property> <property name="show_sql">false</property> <!-- 示例的类映射 --> <mapping class="com.hibernatebook.tools.Note"/> <mapping class="com.hibernatebook.tools.Notepad"/> </session-factory> </hibernate-configuration> ``` 若使用 HSQLDB 数据库，建议使用全限定路径名，以避免 Ant、Eclipse IDE 和 Hibernate 控制台在工作目录和类路径上的冲突。使用注解映射时，可使用带有 class 属性的 mapping 元素确定映射类，控制台配置会自动通过反射查找正确注解的实体类，因此这些条目可省略。若使用基于 XML 的映射，可使用 file 属性指定映射文件。 创建 Hibernate 配置条目可使用向导，选择“File” -> “New” -> “Hibernate Console Configuration”，在弹出的对话框中设置配置名称、Hibernate 配置文件路径，勾选使用注解的复选框。中间部分可指定未在配置文件中明确包含的映射文件，最后部分设置 Hibernate 控制台使用的类路径，包括 JDBC 驱动和映射的 POJO 类的位置。点击“Finish”后，可在控制台配置视图中看到配置名称。 ##### 2.2 生成数据库模式 展开控制台配置窗口中的 ToolsExample 条目，有三个节点，第三个节点是数据库中与控制台配置映射的实体对应的表视图。若数据库中没有预定义表，该视图为空。选择“Run SchemaExport”菜单项可生成相应表，但需注意，若配置的数据库用户有表删除权限，此操作会直接删除并重新创建所有表，没有进一步警告。首次运行 SchemaExport 时，事件日志视图可能会显示尝试删除不存在表的错误消息，再次运行通常会消失，可忽略。 ##### 2.3 运行测试程序 为生成测试数据，可运行一个测试应用程序。切换回 Java 视角，为 PopulateNotes 类添加新的 Java 应用程序运行配置，在“Classpath”选项卡中添加 JDBC 驱动路径，运行应用程序后，会看到确认信息，表明一个 Notepad 实体和 100 个相关的 Note 实体已持久化到数据库。 ##### 2.4 浏览模型 在 Hibernate 控制台视角中，可通过控制台配置视图的 Session Factory 节点访问对象模型的内容。打开 Session factory 节点，可看到每个映射类的节点，进一步展开可查看映射字段和属性的表示。双击映射类，数据库中该类的所有实例将被检索，并在 Hibernate Query Result 视图中显示 toString 表示，生成的 HQL 查询会显示在另一个选项卡中。 ##### 2.5 测试 HQL 查询 Hibernate Tools 提供了查询编辑器，可在不编写代码的情况下对数据库运行 HQL 查询。选择项目配置视图的上下文菜单中的“HQL Scratchpad”，会创建一个新的编辑器窗口。在编辑器中输入查询，按 Ctrl + Space 可激活上下文敏感功能。创建查询时，Hibernate Dynamic SQL Preview 窗口会更新对应的 SQL 查询。输入满意的 HQL 查询后，点击编辑器窗口上方的绿色播放按钮可执行查询，结果会在视图中列出。 对于参数化的 HQL 查询，Hibernate 控制台允许指定参数值。将查询粘贴到临时窗口中运行时，若未设置所有查询参数，控制台会记录错误。在视