使用 Hibernate 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。Hibernate 是当前比较流行的开源 Java 应用持久层框架，且 Hibernate 在版本 6.0.0.Beta2 及以上支持了 TiDB 方言，完美适配了 TiDB 的特性。

本文档将展示如何使用 TiDB 和 Hibernate 来完成以下任务：

  • 配置你的环境。
  • 使用 Hibernate 连接到 TiDB 集群。
  • 构建并运行你的应用程序。你也可以参考示例代码片段，完成基本的 CRUD 操作。

Hibernate - 图1

注意

本文档适用于 TiDB Serverless、TiDB Dedicated 和本地部署的 TiDB。

前置需求

运行代码并连接到 TiDB

本小节演示如何运行示例应用程序的代码，并连接到 TiDB。

第 1 步：克隆示例代码仓库到本地

运行以下命令，将示例代码仓库克隆到本地：

1. git clone https://github.com/tidb-samples/tidb-java-hibernate-quickstart.git
2. cd tidb-java-hibernate-quickstart

第 2 步：配置连接信息

根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。

  • TiDB Serverless
  • TiDB Dedicated

  • 本地部署 TiDB

  • 在 TiDB Cloud 的 Clusters 页面中，选择你的 TiDB Serverless 集群，进入集群的 Overview 页面。

  • 点击右上角的 Connect 按钮，将会弹出连接对话框。

  • 确认对话框中的配置和你的运行环境一致。

  • Endpoint Type 为 Public。

  • Branch 选择 main。
  • Connect With 选择 General。
  • Operating System 为你的运行环境。

Hibernate - 图2

小贴士

如果你在 Windows Subsystem for Linux (WSL) 中运行，请切换为对应的 Linux 发行版。 4. 如果你还没有设置密码，点击 Generate Password 生成一个随机密码。

Hibernate - 图3

小贴士

如果你之前已经生成过密码，可以直接使用原密码，或点击 Reset Password 重新生成密码。 5. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

1. cp env.sh.example env.sh 6. 复制并粘贴对应连接字符串至 env.sh 中。需更改部分示例结果如下：

1. export TIDB_HOST='{host}' # e.g. gateway01.ap-northeast-1.prod.aws.tidbcloud.com 2. export TIDB_PORT='4000' 3. export TIDB_USER='{user}' # e.g. xxxxxx.root 4. export TIDB_PASSWORD='{password}' 5. export TIDB_DB_NAME='test' 6. export USE_SSL='true'

注意替换 {} 中的占位符为连接对话框中获得的值。

TiDB Serverless 要求使用 TLS (SSL) connection，因此 USE_SSL 的值应为 true。 7. 保存 env.sh 文件。 8. 在 TiDB Cloud 的 Clusters 页面中，选择你的 TiDB Dedicated 集群，进入集群的 Overview 页面。 9. 点击右上角的 Connect 按钮，将会出现连接对话框。 10. 在对话框中点击 Allow Access from Anywhere。

更多配置细节，可参考 [TiDB Dedicated 标准连接教程（英文）](https://docs.pingcap.com/tidbcloud/connect-via-standard-connection)。

  1. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    1. cp env.sh.example env.sh 12. 复制并粘贴对应的连接字符串至 env.sh 中。需更改部分示例结果如下：

    1. export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com 2. export TIDB_PORT='4000' 3. export TIDB_USER='{user}' # e.g. root 4. export TIDB_PASSWORD='{password}' 5. export TIDB_DB_NAME='test' 6. export USE_SSL='false'

    注意替换 {} 中的占位符为连接对话框中获得的值。 13. 保存 env.sh 文件。 14. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    1. cp env.sh.example env.sh 15. 复制并粘贴对应 TiDB 的连接字符串至 env.sh 中。需更改部分示例结果如下：

    1. export TIDB_HOST='{host}' 2. export TIDB_PORT='4000' 3. export TIDB_USER='root' 4. export TIDB_PASSWORD='{password}' 5. export TIDB_DB_NAME='test' 6. export USE_SSL='false'

    注意替换 {} 中的占位符为你的 TiDB 对应的值，并设置 USE_SSL 为 false。如果你在本机运行 TiDB，默认 Host 地址为 127.0.0.1，密码为空。 16. 保存 env.sh 文件。

第 3 步：运行代码并查看结果

  1. 运行下述命令，执行示例代码：

1. make 2. 查看 Expected-Output.txt，并与你的程序输出进行比较。结果近似即为连接成功。

示例代码片段

你可参考以下关键代码片段，完成自己的应用开发。

完整代码及其运行方式，见代码仓库 tidb-java-hibernate-quickstart。

连接到 TiDB

编写配置文件 hibernate.cfg.xml：

1. <?xml version='1.0' encoding='utf-8'?>
2. <!DOCTYPE hibernate-configuration PUBLIC
3. "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
4. "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
5. <hibernate-configuration>
6. <session-factory>

8. <!-- Database connection settings -->
9. <property name="hibernate.connection.driver_class">com.mysql.cj.jdbc.Driver</property>
10. <property name="hibernate.dialect">org.hibernate.dialect.TiDBDialect</property>
11. <property name="hibernate.connection.url">${tidb_jdbc_url}</property>
12. <property name="hibernate.connection.username">${tidb_user}</property>
13. <property name="hibernate.connection.password">${tidb_password}</property>
14. <property name="hibernate.connection.autocommit">false</property>

16. <!-- Required so a table can be created from the 'PlayerDAO' class -->
17. <property name="hibernate.hbm2ddl.auto">create-drop</property>

19. <!-- Optional: Show SQL output for debugging -->
20. <property name="hibernate.show_sql">true</property>
21. <property name="hibernate.format_sql">true</property>
22. </session-factory>
23. </hibernate-configuration>

请将 ${tidb_jdbc_url}、${tidb_user}、${tidb_password} 等替换为你的 TiDB 集群的实际值。随后编写以下函数：

1. public SessionFactory getSessionFactory() {
2. return new Configuration()
3. .configure("hibernate.cfg.xml")
4. .addAnnotatedClass(${your_entity_class})
5. .buildSessionFactory();
6. }

在使用该函数时，你需要替换 ${your_entity_class} 为自己的数据实体类。如果你有多个实体类，需要添加多个 .addAnnotatedClass(${your_entity_class}) 语句。此外，这仅是 Hibernate 的其中一种配置方式。在配置中遇到任何问题，或想了解更多关于 Hibernate 的信息，你可参考 Hibernate 官方文档。

插入或更新数据

1. try (Session session = sessionFactory.openSession()) {
2. session.persist(new PlayerBean("id", 1, 1));
3. }

更多信息参考插入数据和更新数据。

查询数据

1. try (Session session = sessionFactory.openSession()) {
2. PlayerBean player = session.get(PlayerBean.class, "id");
3. System.out.println(player);
4. }

更多信息参考查询数据。

删除数据

1. try (Session session = sessionFactory.openSession()) {
2. session.remove(new PlayerBean("id", 1, 1));
3. }

更多信息参考删除数据。

下一步

需要帮助?

如果在开发的过程中遇到问题，可以在 AskTUG 上进行提问，寻求帮助。