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

Spring Boot を使用して TiDB に接続する

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

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

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

注記：

このチュートリアルは、TiDB サーバーレス、TiDB 専用、および TiDB セルフホストで動作します。

前提条件

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

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 Serverless
  • TiDB Dedicated
  • TiDB Self-Hosted

  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 サーバーレスには安全な接続が必要です。したがって、 USE_SSL ～ trueの値を設定する必要があります。

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

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

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

  3. 「どこからでもアクセスを許可」をクリックし、 「TiDB クラスター CA のダウンロード」をクリックして CA 証明書をダウンロードします。

    接続文字列の取得方法の詳細については、 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-quickstartリポジトリを確認してください。

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_PASSWORDを TiDB クラスターの実際の値に設定します。構成ファイルは、これらの環境変数のデフォルト設定を提供します。環境変数を設定しない場合、デフォルト値は次のとおりです。

  • 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);

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

次のステップ

助けが必要？

不和またはサポートチケットを作成するについて質問してください。

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