使用 Hibernate 连接 TiDB

TiDB 是一个兼容 MySQL 的数据库，Hibernate 是一个流行的开源 Java ORM。从 6.0.0.Beta2 版本开始，Hibernate 支持 TiDB 方言，能够很好地适配 TiDB 的特性。

在本教程中，你可以学习如何使用 TiDB 和 Hibernate 完成以下任务：

• 搭建你的环境。
• 使用 Hibernate 连接到你的 TiDB 集群。
• 构建并运行你的应用程序。你还可以在 示例代码片段 中找到基本 CRUD 操作的示例代码。

前置条件

完成本教程，你需要：

• Java Development Kit (JDK) 17 或更高版本。你可以根据业务和个人需求选择 OpenJDK 或 Oracle JDK。
• Maven 3.8 或更高版本。
• Git。
• 一个 TiDB 集群。

如果你还没有 TiDB 集群，可以按如下方式创建：

• （推荐）参考创建 TiDB Cloud Starter 集群 创建你自己的 TiDB Cloud 集群。
• 参考部署本地测试 TiDB 集群 或部署生产环境 TiDB 集群 创建本地集群。

运行示例应用连接 TiDB

本节演示如何运行示例应用代码并连接到 TiDB。

第 1 步：克隆示例应用仓库

在终端窗口中运行以下命令，克隆示例代码仓库：

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

第 2 步：配置连接信息

根据你选择的 TiDB 部署方式，连接到你的 TiDB 集群。

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

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

   make
   

2. 检查 Expected-Output.txt 以确认输出是否一致。

示例代码片段

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

完整示例代码及运行方法请参考 tidb-samples/tidb-java-hibernate-quickstart 仓库。

连接 TiDB

编辑 Hibernate 配置文件 hibernate.cfg.xml：

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

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

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

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

请务必将 ${tidb_jdbc_url}、${tidb_user} 和 ${tidb_password} 替换为你 TiDB 集群的实际值。然后，定义如下函数：

public SessionFactory getSessionFactory() {
    return new Configuration()
            .configure("hibernate.cfg.xml")
            .addAnnotatedClass(${your_entity_class})
            .buildSessionFactory();
}

使用该函数时，需要将 ${your_entity_class} 替换为你自己的数据实体类。如果有多个实体类，需要为每个实体类添加一条 .addAnnotatedClass(${your_entity_class}) 语句。上述函数只是配置 Hibernate 的一种方式。如果你在配置过程中遇到问题，或想了解更多 Hibernate 相关内容，请参考 Hibernate 官方文档。

插入或更新数据

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

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

查询数据

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

更多信息请参考 查询数据。

删除数据

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

更多信息请参考 删除数据。

后续步骤

• 通过 Hibernate 文档 学习更多 Hibernate 的用法。
• 通过 开发者指南 各章节学习 TiDB 应用开发最佳实践，例如 插入数据、更新数据、删除数据、单表读取、事务 和 SQL 性能优化。
• 通过专业的 TiDB 开发者课程 学习，并在通过考试后获得 TiDB 认证。
• 通过 Java 开发者课程学习：Working with TiDB from Java。

需要帮助？

在 Discord 或 Slack 社区提问，或提交支持工单。