Spring Boot で TiDB に接続する
TiDB は MySQL 互換のデータベースであり、 春 Java用の人気のオープンソース コンテナ フレームワークです。このドキュメントでは、Spring の使用方法としてスプリングブート使用します。
このチュートリアルでは、TiDB を JPA プロバイダーとしてスプリングデータ JPAおよび休止状態とともに使用して、次のタスクを実行する方法を学習します。
- 環境を設定します。
- Hibernate と Spring Data JPA を使用して TiDB クラスターに接続します。
- アプリケーションをビルドして実行します。オプションで、基本的な CRUD 操作用のサンプルコードスニペットを見つけることができます。
注記:
このチュートリアルは、TiDB Serverless、TiDB Dedicated、および TiDB Self-Hosted で機能します。
前提条件
このチュートリアルを完了するには、次のものが必要です。
TiDB クラスターがない場合は、次のように作成できます。
- (推奨) TiDB サーバーレス クラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
- ローカルテスト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
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
接続ダイアログの構成が動作環境と一致していることを確認します。
エンドポイントタイプは
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 Serverless では安全な接続が必要です。そのため、
USE_SSL
の値をtrue
に設定する必要があります。env.sh
ファイルを保存します。
クラスターページに移動し、ターゲット クラスターの名前をクリックして概要ページに移動します。
右上隅の「接続」をクリックします。接続ダイアログが表示されます。
「どこからでもアクセスを許可」をクリックし、 「CA 証明書のダウンロード」をクリックして CA 証明書をダウンロードします。
接続文字列を取得する方法の詳細については、 TiDB専用標準接続を参照してください。
次のコマンドを実行して
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別のターミナル セッションでリクエスト スクリプトを実行します。
make request予想される出力.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_PASSWORD
TiDB クラスターの実際の値に設定します。設定ファイルには、これらの環境変数のデフォルト設定が用意さTIDB_USER
ています。環境変数を設定しない場合、デフォルト値は次のようになります。
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);
詳細についてはデータを削除するを参照してください。
次のステップ
このドキュメントで使用されているサードパーティのライブラリとフレームワークの使用方法の詳細については、公式ドキュメントを参照してください。
開発者ガイドのデータを挿入 、 データの更新 、 データを削除する 、 単一テーブル読み取り 、 取引 、 SQLパフォーマンスの最適化などの章で、 TiDB アプリケーション開発のベスト プラクティスを学習します。
プロフェッショナルTiDB 開発者コースを通じて学び、試験に合格するとTiDB 認定獲得します。
Java開発者向けコースを通じて学習します: Javaから TiDB を操作する .
助けが必要?
不和 、またはサポートチケットを作成するについて質問します。