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

Spring Boot で TiDB に接続する

TiDB は MySQL 互換のデータベースであり、 春 Java用の人気のオープンソース コンテナ フレームワークです。このドキュメントでは、Spring の使用方法としてスプリングブート使用します。

このチュートリアルでは、TiDB を JPA プロバイダーとしてスプリングデータ JPAおよび休止状態とともに使用して、次のタスクを実行する方法を学習します。

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

注記：

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

前提条件

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

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

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

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

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

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

git clone https://github.com/tidb-samples/tidb-java-springboot-jpa-quickstart.git
cd tidb-java-springboot-jpa-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. 別のターミナル セッションでリクエスト スクリプトを実行します。

    make request

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

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

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

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

TiDBに接続する

設定ファイルapplication.ymlを編集します:

spring:
  datasource:
    url: ${TIDB_JDBC_URL:jdbc:mysql://localhost:4000/test}
    username: ${TIDB_USER:root}
    password: ${TIDB_PASSWORD:}
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    show-sql: true
    database-platform: org.hibernate.dialect.TiDBDialect
    hibernate:
      ddl-auto: create-drop

設定後、環境変数TIDB_JDBC_URL TIDB_USER TiDB クラスターの実際の値に設定します。設定ファイルにはTIDB_PASSWORDこれらの環境変数のデフォルト設定が用意されています。環境変数を設定しない場合、デフォルト値は次のようになります。

  • TIDB_JDBC_URL : "jdbc:mysql://localhost:4000/test"
  • TIDB_USER : "root"
  • TIDB_PASSWORD : ""

データ管理: @Repository

Spring Data JPA は@Repositoryインターフェースを通じてデータを管理します。 JpaRepositoryが提供する CRUD 操作を使用するには、 JpaRepositoryインターフェースを拡張する必要があります。

@Repository
public interface PlayerRepository extends JpaRepository<PlayerBean, Long> {
}

次に、 PlayerRepository必要とするクラスで@Autowired使用して自動依存性注入を行うことができます。これにより、 CRUD関数を直接使用できるようになります。次に例を示します。

@Autowired
private PlayerRepository playerRepository;

データの挿入または更新

playerRepository.save(player);

詳細については、 データを挿入およびデータの更新を参照してください。

クエリデータ

PlayerBean player = playerRepository.findById(id).orElse(null);

詳細についてはクエリデータを参照してください。

データを削除する

playerRepository.deleteById(id);

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

次のステップ

ヘルプが必要ですか?

不和またはスラック 、またはサポートチケットを送信するについてコミュニティに質問してください。

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