📣

TiDB Cloud Serverless が
Starter
に変わりました!このページは自動翻訳されたものです。
原文はこちらからご覧ください。

MyBatisでTiDBに接続する

TiDB は MySQL 互換のデータベースであり、 マイバティス人気のオープンソースのJava ORM です。

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

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

注記:

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

前提条件

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

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

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

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

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

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

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

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

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

    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 Cloud Dedicatedは、パブリック接続タイプに加えて、プライベートエンドポイントVPCピアリング接続タイプもサポートしています。詳細については、 TiDB Cloud専用クラスタに接続するご覧ください。

    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_SSLfalseに設定してください。TiDBをローカルで実行している場合、デフォルトのホストアドレスは127.0.0.1で、パスワードは空です。

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

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

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

      make
    2. 期待出力.txtチェックして、出力が一致するかどうかを確認します。

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

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

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

    TiDBに接続する

    MyBatis設定ファイルmybatis-config.xmlを編集します。

    <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <setting name="cacheEnabled" value="true"/> <setting name="lazyLoadingEnabled" value="false"/> <setting name="aggressiveLazyLoading" value="true"/> <setting name="logImpl" value="LOG4J"/> </settings> <environments default="development"> <environment id="development"> <!-- JDBC transaction manager --> <transactionManager type="JDBC"/> <!-- Database pool --> <dataSource type="POOLED"> <property name="driver" value="com.mysql.cj.jdbc.Driver"/> <property name="url" value="${tidb_jdbc_url}"/> <property name="username" value="${tidb_user}"/> <property name="password" value="${tidb_password}"/> </dataSource> </environment> </environments> <mappers> <mapper resource="${mapper_location}.xml"/> </mappers> </configuration>

    ${tidb_jdbc_url} ${tidb_user} TiDBクラスタの実際の値に置き換えてください。また、 ${mapper_location} ${tidb_password} XML設定ファイルのパスに置き換えてください。マッパーXML設定ファイルが複数ある場合は、それぞれに<mapper/>タグを追加する必要があります。次に、以下の関数を定義します。

    public SqlSessionFactory getSessionFactory() { InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml"); SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(inputStream); }

    データを挿入する

    マッパー XML にノードを追加し、XML 構成ファイルのmapper.namespace属性で構成されたインターフェイス クラスに同じ名前の関数を追加します。

    <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.pingcap.model.PlayerMapper"> <insert id="insert" parameterType="com.pingcap.model.Player"> insert into player (id, coins, goods) values (#{id,jdbcType=VARCHAR}, #{coins,jdbcType=INTEGER}, #{goods,jdbcType=INTEGER}) </insert> </mapper>

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

    クエリデータ

    マッパーXMLにノードを追加し、XML設定ファイルのmapper.namespace属性で設定されたインターフェースクラスに同じ名前の関数を追加します。特に、MyBatisクエリ関数の戻り値の型としてresultMap使用する場合は、 <resultMap/>ノードが正しく設定されていることを確認してください。

    <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.pingcap.model.PlayerMapper"> <resultMap id="BaseResultMap" type="com.pingcap.model.Player"> <constructor> <idArg column="id" javaType="java.lang.String" jdbcType="VARCHAR" /> <arg column="coins" javaType="java.lang.Integer" jdbcType="INTEGER" /> <arg column="goods" javaType="java.lang.Integer" jdbcType="INTEGER" /> </constructor> </resultMap> <select id="selectByPrimaryKey" parameterType="java.lang.String" resultMap="BaseResultMap"> select id, coins, goods from player where id = #{id,jdbcType=VARCHAR} </select> </mapper>

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

    データを更新する

    マッパー XML にノードを追加し、XML 構成ファイルのmapper.namespace属性で構成されたインターフェイス クラスに同じ名前の関数を追加します。

    <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.pingcap.model.PlayerMapper"> <update id="updateByPrimaryKey" parameterType="com.pingcap.model.Player"> update player set coins = #{coins,jdbcType=INTEGER}, goods = #{goods,jdbcType=INTEGER} where id = #{id,jdbcType=VARCHAR} </update> </mapper>

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

    データを削除する

    マッパー XML にノードを追加し、XML 構成ファイルのmapper.namespace属性で構成されたインターフェイス クラスに同じ名前の関数を追加します。

    <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="com.pingcap.model.PlayerMapper"> <delete id="deleteByPrimaryKey" parameterType="java.lang.String"> delete from player where id = #{id,jdbcType=VARCHAR} </delete> </mapper>

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

    次のステップ

    ヘルプが必要ですか?

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

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