TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

Hibernate で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、 休止状態人気のオープンソースJava ORM です。バージョン6.0.0.Beta2以降、Hibernate は TiDB の機能に適した TiDB 方言をサポートしています。

このチュートリアルでは、TiDB と Hibernate を使用して次のタスクを実行する方法を学習します。

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

注記：

このチュートリアルは、 TiDB Cloud Serverless、 TiDB Cloud Dedicated、および TiDB Self-Managed で機能します。

前提条件

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

TiDB クラスターがない場合は、次のように作成できます。

サンプルアプリを実行してTiDBに接続する

このセクションでは、サンプル アプリケーション コードを実行して TiDB に接続する方法を示します。

ステップ1: サンプルアプリのリポジトリをクローンする

サンプル コード リポジトリを複製するには、ターミナル ウィンドウで次のコマンドを実行します。

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

ステップ2: 接続情報を構成する

選択した TiDB デプロイメント オプションに応じて、TiDB クラスターに接続します。

  • TiDB Cloud Serverless
  • TiDB Cloud Dedicated
  • TiDB Self-Managed

  1. クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。

  2. 右上隅の「接続」をクリックします。接続ダイアログが表示されます。

  3. 接続ダイアログの構成が動作環境と一致していることを確認します。

    • 接続タイプはPublicに設定されています

    • ブランチはmainに設定されています

    • 接続先はGeneralに設定されています

    • オペレーティング システムは環境に適合します。

    ヒント：

    プログラムが Windows Subsystem for Linux (WSL) で実行されている場合は、対応する Linux ディストリビューションに切り替えます。

  4. ランダムなパスワードを作成するには、 「パスワードの生成」をクリックします。

    ヒント：

    以前にパスワードを作成したことがある場合は、元のパスワードを使用するか、 「パスワードのリセット」をクリックして新しいパスワードを生成することができます。

  5. 次のコマンドを実行してenv.sh.exampleコピーし、名前をenv.shに変更します。

    cp env.sh.example env.sh

  6. 対応する接続文字列をコピーして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 Serverless では安全な接続が必要です。そのため、 USE_SSLの値をtrueに設定する必要があります。

  7. env.shファイルを保存します。

  1. クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。

  2. 右上隅の「接続」をクリックします。接続ダイアログが表示されます。

  3. 接続ダイアログで、 [接続タイプ]ドロップダウン リストから[パブリック]を選択し、 [CA 証明書]をクリックして CA 証明書をダウンロードします。

    IP アクセス リストを設定していない場合は、 「IP アクセス リストの設定」をクリックするか、手順IPアクセスリストを構成するに従って最初の接続の前に設定してください。

    TiDB Dedicated は、パブリック接続タイプに加えて、プライベートエンドポイントとVPC ピアリング接続タイプもサポートしています。詳細については、 TiDB専用クラスタに接続するを参照してください。

  4. 次のコマンドを実行してenv.sh.exampleコピーし、名前をenv.shに変更します。

    cp env.sh.example env.sh

  5. 対応する接続文字列をコピーして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'

    プレースホルダー{}を、接続ダイアログから取得した接続パラメータに必ず置き換えてください。

  6. env.shファイルを保存します。

  1. 次のコマンドを実行してenv.sh.exampleコピーし、名前をenv.shに変更します。

    cp env.sh.example env.sh

  2. 対応する接続文字列をコピーして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で、パスワードは空です。

  3. env.shファイルを保存します。

ステップ3: コードを実行して結果を確認する

  1. サンプル コードを実行するには、次のコマンドを実行します。

    make

  2. 予想される出力.txtをチェックして、出力が一致するかどうかを確認します。

サンプルコードスニペット

次のサンプル コード スニペットを参照して、独自のアプリケーション開発を完了することができます。

完全なサンプル コードとその実行方法については、 tidb サンプル/tidb-java-hibernate-クイックスタートリポジトリを参照してください。

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 クラスターの実際の値に置き換えてください。次に、次の関数を定義${tidb_password}ます。

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

この関数を使用する場合は、 ${your_entity_class}独自のデータ エンティティ クラスに置き換える必要があります。エンティティ クラスが複数ある場合は、それぞれに.addAnnotatedClass(${your_entity_class})ステートメントを追加する必要があります。上記の関数は、Hibernate を構成する 1 つの方法にすぎません。構成で問題が発生した場合、または 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));
}

詳細についてはデータを削除するを参照してください。

次のステップ

ヘルプが必要ですか?

TiDB コミュニティ 、またはサポートチケットを作成するについて質問します。

このページは役に立ちましたか？