JDBCを使用してTiDBに接続する

TiDBはMySQL互換データベースであり、JDBC（Java Database Connectivity）はJavaのデータアクセスAPIです。MySQL MySQL Connector/Jは、MySQLにおけるJDBCの実装です。

このチュートリアルでは、TiDBとJDBCを使用して以下のタスクを実行する方法を学ぶことができます。

• 環境をセットアップしてください。
• JDBCを使用してTiDBに接続します。
• アプリケーションをビルドして実行します。オプションで、基本的な CRUD 操作用のサンプルコードスニペットを見つけることができます。

前提条件

このチュートリアルを完了するには、以下が必要です。

• Java Development Kit (JDK) 17以降が必要です。業務要件や個人のニーズに応じて、 OpenJDKまたはOracle JDKを選択できます。
• Maven3.8以上。
• Git 。
• TiDBクラスタ。

TiDBクラスタをお持ちでない場合は、以下の手順で作成できます。

• (推奨) TiDB Cloud Starterインスタンスを作成する。
• ローカルテスト用のTiDB Self-Managedクラスタをデプロイまたは本番のTiDB Self-Managedクラスタをデプロイ

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文を書く必要がない限り、 Hibernate、 MyBatis 、 Spring Data JPAなどのORMフレームワークを開発に利用することをお勧めします。これにより、以下のようなメリットが得られます。

• 接続とトランザクションを管理するための定型コードを削減します。
• 多数のSQL文の代わりに、データオブジェクトを使用してデータを操作します。

MySQLとの互換性

MySQL では、 DECIMAL列にデータを挿入する際に、小数点以下の桁数が列で定義されているスケールを超えた場合、MySQL は余分な桁を自動的に切り捨て、切り捨てられたデータを正常に挿入します。余分な小数点以下の桁数に関係なく、この処理が行われます。

TiDB v8.5.3以前のバージョンでは：

• 小数点以下の桁数が定義されたスケールを超えているが72を超えていない場合、TiDBは余分な桁を自動的に切り捨て、切り捨てられたデータを正常に挿入します。
• ただし、小数点以下の桁数が72を超えると、挿入は失敗し、エラーが返されます。

TiDB v8.5.4以降、TiDBはMySQLの動作に準拠するようになりました。つまり、小数点以下の桁数がいくつ多くても、余分な桁を自動的に切り捨て、切り捨てられたデータを正常に挿入します。

次のステップ

• MySQL Connector/J の使用法の詳細についてはMySQL Connector/J のドキュメントを参照してください。
• 開発者ガイド の データを挿入する、データの更新、データを削除する、単一表の読み取り、トランザクション、SQLパフォーマンス最適化 などの章を参考に、TiDB アプリケーション開発のベストプラクティスを学びます。
• プロフェッショナルなTiDB開発者向けコースコースを通じて学習し、試験に合格するとTiDB認定資格を取得します。
• Java開発者向けのコース「 JavaからTiDBを操作するを通じて学習します。

お困りですか？

• Discordor Slackコミュニティに質問してください。
• TiDB Cloudのサポートチケットを送信してください
• TiDB Self-Managedのサポートチケットを送信してください