JDBC で TiDB に接続する
TiDB は MySQL 互換のデータベースであり、JDBC (Java Database Connectivity) はJavaのデータ アクセス API です。1 MySQL コネクタ/J MySQL の JDBC 実装です。
このチュートリアルでは、TiDB と JDBC を使用して次のタスクを実行する方法を学習します。
- 環境を設定します。
 - JDBC を使用して TiDB クラスターに接続します。
 - アプリケーションをビルドして実行します。オプションで、基本的なCRUD操作用のサンプルコードスニペット見つけることもできます。
 
注記:
- このチュートリアルは、 TiDB Cloud Starter、 TiDB Cloud Essential、 TiDB Cloud Dedicated、および TiDB Self-Managed で機能します。
 - TiDB v7.4以降、JDBC URLで
 connectionCollationが設定されておらず、characterEncoding設定されていないかUTF-8に設定されている場合、JDBC接続で使用される照合順序はJDBCドライバーのバージョンによって異なります。詳細については、 JDBC接続で使用される照合順序参照してください。
前提条件
このチュートリアルを完了するには、次のものが必要です。
- Java Development Kit (JDK) 17以上。ビジネスおよび個人の要件に応じて、 オープンJDKまたはオラクル JDK選択できます。
 - メイヴン 3.8以上。
 - ギット 。
 - TiDB クラスター。
 
注記:
セキュリティ上の理由から、インターネット経由で TiDB クラスターに接続する場合は、
VERIFY_IDENTITY使用して TLS 接続を確立することをお勧めします。TiDB TiDB Cloud Starter、 TiDB Cloud Essential、およびTiDB Cloud Dedicated は、Subject Alternative Name (SAN) 証明書を使用します。これには、MySQL Connector/J のバージョンが8.0.22以上である必要があります。
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 クラスターに接続します。
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
接続タイプは
Publicに設定されていますブランチは
mainに設定されています接続先が
Generalに設定されていますオペレーティング システムは環境に適合します。
ヒント:
プログラムが Windows Subsystem for Linux (WSL) で実行されている場合は、対応する Linux ディストリビューションに切り替えます。
ランダムなパスワードを作成するには、 「パスワードの生成」をクリックします。
ヒント:
以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードのリセット」をクリックして新しいパスワードを生成することができます。
次のコマンドを実行して
env.sh.exampleコピーし、名前をenv.shに変更します。cp env.sh.example env.sh対応する接続文字列をコピーして、
env.shファイルに貼り付けます。結果の例は次のとおりです。export TIDB_HOST='{host}' # e.g. gateway01.ap-northeast-1.prod.aws.tidbcloud.com export TIDB_PORT='4000' export TIDB_USER='{user}' # e.g. xxxxxx.root export TIDB_PASSWORD='{password}' export TIDB_DB_NAME='test' export USE_SSL='true'プレースホルダー
{}、接続ダイアログから取得した接続パラメータに置き換えてください。TiDB Cloud Starterは安全な接続を必要とします。そのため、
USE_SSLをtrueに設定する必要があります。env.shファイルを保存します。
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログで、 [接続タイプ]ドロップダウン リストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。
IP アクセス リストをまだ設定していない場合は、 「IP アクセス リストの設定」をクリックするか、手順IPアクセスリストを設定するに従って、最初の接続の前に設定してください。
TiDB Cloud Dedicatedは、パブリック接続タイプに加えて、プライベートエンドポイントとVPCピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud専用クラスタに接続するご覧ください。
次のコマンドを実行して
env.sh.exampleコピーし、名前をenv.shに変更します。cp env.sh.example env.sh対応する接続文字列をコピーして、
env.shファイルに貼り付けます。結果の例は次のとおりです。export TIDB_HOST='{host}' # e.g. tidb.xxxx.clusters.tidb-cloud.com export TIDB_PORT='4000' export TIDB_USER='{user}' # e.g. root export TIDB_PASSWORD='{password}' export TIDB_DB_NAME='test' export USE_SSL='false'プレースホルダー
{}、接続ダイアログから取得した接続パラメータに置き換えてください。env.shファイルを保存します。
次のコマンドを実行して
env.sh.exampleコピーし、名前をenv.shに変更します。cp env.sh.example env.sh対応する接続文字列をコピーして、
env.shファイルに貼り付けます。結果の例は次のとおりです。export TIDB_HOST='{host}' export TIDB_PORT='4000' export TIDB_USER='root' export TIDB_PASSWORD='{password}' export TIDB_DB_NAME='test' export USE_SSL='false'プレースホルダー
{}接続パラメータに置き換え、USE_SSLをfalseに設定してください。TiDBをローカルで実行している場合、デフォルトのホストアドレスは127.0.0.1で、パスワードは空です。env.shファイルを保存します。
ステップ3: コードを実行して結果を確認する
サンプル コードを実行するには、次のコマンドを実行します。
make期待出力.txtチェックして、出力が一致するかどうかを確認します。
サンプルコードスニペット
次のサンプル コード スニペットを参照して、独自のアプリケーション開発を完了することができます。
完全なサンプル コードとその実行方法については、 tidb-samples/tidb-java-jdbc-クイックスタートリポジトリを参照してください。
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文を書く必要がない限り、開発には休止状態 、 マイバティス 、 スプリングデータ JPAなどのフレームワークをORM使用することをお勧めします。これにより、次のようなメリットが得られます。
- 接続とトランザクションを管理するために定型コード減らします。
 - 多数の SQL ステートメントの代わりにデータ オブジェクトを使用してデータを操作します。
 
次のステップ
- MySQL Connector/J の使用方法をMySQL Connector/J のドキュメントから詳しく学びます。
 - 開発者ガイドのデータを挿入する 、 データを更新する 、 データを削除する 、 単一テーブルの読み取り 、 取引 、 SQLパフォーマンスの最適化などの章で、 TiDB アプリケーション開発のベスト プラクティスを学習します。
 - プロフェッショナルTiDB開発者コースを通じて学び、試験に合格するとTiDB認定獲得します。
 - Java開発者向けコースを通じて学習します: JavaからTiDBを操作する .
 
ヘルプが必要ですか?
不和またはスラック 、あるいはサポートチケットを送信するについてコミュニティに質問してください。