使用 JDBC 连接 TiDB

TiDB 是一个兼容 MySQL 的数据库，JDBC（Java Database Connectivity）是 Java 的数据访问 API。MySQL Connector/J 是 MySQL 的 JDBC 实现。

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

• 搭建你的环境。
• 使用 JDBC 连接到你的 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-jdbc-quickstart.git
cd tidb-java-jdbc-quickstart

第 2 步：配置连接信息

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

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

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

   make
   

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

示例代码片段

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

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

连接 TiDB

public MysqlDataSource getMysqlDataSource() throws SQLException {
    MysqlDataSource mysqlDataSource = new MysqlDataSource();

    mysqlDataSource.setServerName(${tidb_host});
    mysqlDataSource.setPortNumber(${tidb_port});
    mysqlDataSource.setUser(${tidb_user});
    mysqlDataSource.setPassword(${tidb_password});
    mysqlDataSource.setDatabaseName(${tidb_db_name});
    if (${tidb_use_ssl}) {
        mysqlDataSource.setSslMode(PropertyDefinitions.SslMode.VERIFY_IDENTITY.name());
        mysqlDataSource.setEnabledTLSProtocols("TLSv1.2,TLSv1.3");
    }

    return mysqlDataSource;
}

使用该函数时，你需要将 ${tidb_host}、${tidb_port}、${tidb_user}、${tidb_password} 和 ${tidb_db_name} 替换为你 TiDB 集群的实际值。

插入数据

public void createPlayer(PlayerBean player) throws SQLException {
    MysqlDataSource mysqlDataSource = getMysqlDataSource();
    try (Connection connection = mysqlDataSource.getConnection()) {
        PreparedStatement preparedStatement = connection.prepareStatement("INSERT INTO player (id, coins, goods) VALUES (?, ?, ?)");
        preparedStatement.setString(1, player.getId());
        preparedStatement.setInt(2, player.getCoins());
        preparedStatement.setInt(3, player.getGoods());

        preparedStatement.execute();
    }
}

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

查询数据

public void getPlayer(String id) throws SQLException {
    MysqlDataSource mysqlDataSource = getMysqlDataSourceByEnv();
    try (Connection connection = mysqlDataSource.getConnection()) {
        PreparedStatement preparedStatement = connection.prepareStatement("SELECT * FROM player WHERE id = ?");
        preparedStatement.setString(1, id);
        preparedStatement.execute();

        ResultSet res = preparedStatement.executeQuery();
        if(res.next()) {
            PlayerBean player = new PlayerBean(res.getString("id"), res.getInt("coins"), res.getInt("goods"));
            System.out.println(player);
        }
    }
}

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

更新数据

public void updatePlayer(String id, int amount, int price) throws SQLException {
    MysqlDataSource mysqlDataSource = getMysqlDataSourceByEnv();
    try (Connection connection = mysqlDataSource.getConnection()) {
        PreparedStatement transfer = connection.prepareStatement("UPDATE player SET goods = goods + ?, coins = coins + ? WHERE id=?");
        transfer.setInt(1, -amount);
        transfer.setInt(2, price);
        transfer.setString(3, id);
        transfer.execute();
    }
}

更多信息请参考 更新数据。

删除数据

public void deletePlayer(String id) throws SQLException {
    MysqlDataSource mysqlDataSource = getMysqlDataSourceByEnv();
    try (Connection connection = mysqlDataSource.getConnection()) {
        PreparedStatement deleteStatement = connection.prepareStatement("DELETE FROM player WHERE id=?");
        deleteStatement.setString(1, id);
        deleteStatement.execute();
    }
}

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

实用说明

使用驱动还是 ORM 框架？

Java 驱动提供了对数据库的底层访问，但这要求开发者：

• 手动建立和释放数据库连接。
• 手动管理数据库事务。
• 手动将数据行映射为数据对象。

除非你需要编写复杂的 SQL 语句，否则推荐使用 ORM 框架进行开发，例如 Hibernate、MyBatis 或 Spring Data JPA。它可以帮助你：

• 减少用于管理连接和事务的 样板代码。
• 通过数据对象操作数据，而不是大量 SQL 语句。

后续步骤

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

需要帮助？

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