MyBatis を使用して TiDB に接続する

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

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

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

注記：

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

前提条件

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

• Java開発キット (JDK) 17以降。ビジネスや個人の要件に基づいてOpenJDKまたはオラクルJDKを選択できます。
• メイビン 3.8以上。
• ギット 。
• TiDB クラスター。

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

• (推奨) TiDB サーバーレスクラスターの作成に従って、独自のTiDB Cloudクラスターを作成します。
• ローカル テスト TiDB クラスターをデプロイまたは本番TiDB クラスターをデプロイに従ってローカル クラスターを作成します。

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

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

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

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

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

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

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

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

1. 次のコマンドを実行してサンプル コードを実行します。

   make
   

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

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

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

完全なサンプル コードとその実行方法については、 tidb-samples/tidb-java-mybatis-quickstartリポジトリを確認してください。

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_password}必ず TiDB クラスターの実際の値に置き換えてください。また、 ${mapper_location}マッパー 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>

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

次のステップ

• MyBatis の詳しい使い方はMyBatis のドキュメントからご覧ください。
• TiDB アプリケーション開発単一テーブルの読み取りベスト プラクティスについて取引 、 開発者ガイドの章 ( データの挿入など) データを更新する参照データの削除 SQLパフォーマンスの最適化ください。
• プロフェッショナルを通じてTiDB 開発者コースを学び、試験合格後にTiDB 認定獲得します。
• Java開発者向けのコースを通じてJavaから TiDB を操作するを学びます。

助けが必要？

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