使用 MyBatis 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。MyBatis 是当前比较流行的开源 Java 应用持久层框架。

本文档将展示如何使用 TiDB 和 MyBatis 来完成以下任务：

  • 配置你的环境。
  • 使用 MyBatis 连接到 TiDB 集群。
  • 构建并运行你的应用程序。你也可以参考示例代码片段，完成基本的 CRUD 操作。

MyBatis - 图1

注意

本文档适用于 TiDB Serverless、TiDB Dedicated 和本地部署的 TiDB。

前置需求

运行代码并连接到 TiDB

本小节演示如何运行示例应用程序的代码，并连接到 TiDB。

第 1 步：克隆示例代码仓库到本地

运行以下命令，将示例代码仓库克隆到本地：

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

第 2 步：配置连接信息

根据不同的 TiDB 部署方式，使用不同的方法连接到 TiDB 集群。

  • TiDB Serverless
  • TiDB Dedicated
  • 本地部署 TiDB

  1. 在 TiDB Cloud 的 Clusters 页面中，选择你的 TiDB Serverless 集群，进入集群的 Overview 页面。

  2. 点击右上角的 Connect 按钮，将会弹出连接对话框。

  3. 确认对话框中的配置和你的运行环境一致。

    • Endpoint Type 为 Public。
    • Branch 选择 main。
    • Connect With 选择 General。
    • Operating System 为你的运行环境。

    MyBatis - 图2

    小贴士

    如果你在 Windows Subsystem for Linux (WSL) 中运行，请切换为对应的 Linux 发行版。

  4. 如果你还没有设置密码，点击 Generate Password 生成一个随机密码。

    MyBatis - 图3

    小贴士

    如果你之前已经生成过密码，可以直接使用原密码，或点击 Reset Password 重新生成密码。

  5. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    1. cp env.sh.example env.sh

  6. 复制并粘贴对应连接字符串至 env.sh 中。需更改部分示例结果如下：

    1. export TIDB_HOST='{host}'  # e.g. xxxxxx.aws.tidbcloud.com
    2. export TIDB_PORT='4000'
    3. export TIDB_USER='{user}'  # e.g. xxxxxx.root
    4. export TIDB_PASSWORD='{password}'
    5. export TIDB_DB_NAME='test'
    6. export USE_SSL='true'

    注意替换 {} 中的占位符为连接对话框中获得的值。

    TiDB Serverless 要求使用 TLS (SSL) connection，因此 USE_SSL 的值应为 true。

  7. 保存 env.sh 文件。

  8. 在 TiDB Cloud 的 Clusters 页面中，选择你的 TiDB Dedicated 集群，进入集群的 Overview 页面。

  9. 点击右上角的 Connect 按钮，将会出现连接对话框。

  10. 在对话框中点击 Allow Access from Anywhere。

    更多配置细节，可参考 TiDB Dedicated 标准连接教程（英文）。

  11. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    1. cp env.sh.example env.sh

  12. 复制并粘贴对应的连接字符串至 env.sh 中。需更改部分示例结果如下：

    1. export TIDB_HOST='{host}'  # e.g. xxxxxx.aws.tidbcloud.com
    2. export TIDB_PORT='4000'
    3. export TIDB_USER='{user}'  # e.g. xxxxxx.root
    4. export TIDB_PASSWORD='{password}'
    5. export TIDB_DB_NAME='test'
    6. export USE_SSL='false'

    注意替换 {} 中的占位符为连接对话框中获得的值。

  13. 保存 env.sh 文件。

  14. 运行以下命令，将 env.sh.example 复制并重命名为 env.sh：

    1. cp env.sh.example env.sh

  15. 复制并粘贴对应 TiDB 的连接字符串至 env.sh 中。需更改部分示例结果如下：

    1. export TIDB_HOST='{host}'  # e.g. xxxxxx.aws.tidbcloud.com
    2. export TIDB_PORT='4000'
    3. export TIDB_USER='root'  # e.g. xxxxxx.root
    4. export TIDB_PASSWORD='{password}'
    5. export TIDB_DB_NAME='test'
    6. export USE_SSL='false'

    注意替换 {} 中的占位符为你的 TiDB 对应的值，并设置 USE_SSL 为 false。如果你在本机运行 TiDB，默认 Host 地址为 127.0.0.1，密码为空。

  16. 保存 env.sh 文件。

第 3 步：运行代码并查看结果

  1. 运行下述命令，执行示例代码：

    1. make

  2. 查看 Expected-Output.txt，并与你的程序输出进行比较。结果近似即为连接成功。

示例代码片段

你可参考以下关键代码片段，完成自己的应用开发。

完整代码及其运行方式，见代码仓库 tidb-java-mybatis-quickstart。

连接到 TiDB

编写配置文件 mybatis-config.xml：

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3.         PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4.         "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6.     <settings>
  7.         <setting name="cacheEnabled" value="true"/>
  8.         <setting name="lazyLoadingEnabled" value="false"/>
  9.         <setting name="aggressiveLazyLoading" value="true"/>
  10.         <setting name="logImpl" value="LOG4J"/>
  11.     </settings>
  13.     <environments default="development">
  14.         <environment id="development">
  15.             <!-- JDBC transaction manager -->
  16.             <transactionManager type="JDBC"/>
  17.             <!-- Database pool -->
  18.             <dataSource type="POOLED">
  19.                 <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
  20.                 <property name="url" value="${TIDB_JDBC_URL}"/>
  21.                 <property name="username" value="${TIDB_USER}"/>
  22.                 <property name="password" value="${TIDB_PASSWORD}"/>
  23.             </dataSource>
  24.         </environment>
  25.     </environments>
  26.     <mappers>
  27.         <mapper resource="${MAPPER_LOCATION}.xml"/>
  28.     </mappers>
  29. </configuration>

请将 ${TIDB_JDBC_URL}、${TIDB_USER}、${TIDB_PASSWORD} 等替换为你的 TiDB 集群的实际值。并替换 ${MAPPER_LOCATION} 的值为你的 mapper XML 配置文件的位置。如果你有多个 mapper XML 配置文件，需要添加多个 <mapper/> 标签。随后编写以下函数：

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

插入数据

在 mapper XML 中添加节点，并在 XML 配置文件的 mapper.namespace 属性中配置的接口类中添加同名函数：

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

更多信息参考插入数据。

查询数据

在 mapper XML 中添加节点，并在 XML 配置文件的 mapper.namespace 属性中配置的接口类中添加同名函数。特别地，如果你在 MyBatis 的查询函数中使用 resultMap 作为返回类型，需要额外注意配置文件的 <resultMap/> 节点配置是否正确。

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.pingcap.model.PlayerMapper">
  4.     <resultMap id="BaseResultMap" type="com.pingcap.model.Player">
  5.         <constructor>
  6.             <idArg column="id" javaType="java.lang.String" jdbcType="VARCHAR" />
  7.             <arg column="coins" javaType="java.lang.Integer" jdbcType="INTEGER" />
  8.             <arg column="goods" javaType="java.lang.Integer" jdbcType="INTEGER" />
  9.         </constructor>
  10.     </resultMap>
  12.     <select id="selectByPrimaryKey" parameterType="java.lang.String" resultMap="BaseResultMap">
  13.     SELECT id, coins, goods
  14.     FROM player
  15.     WHERE id = #{id, jdbcType=VARCHAR}
  16.     </select>
  17. </mapper>

更多信息参考查询数据。

更新数据

在 mapper XML 中添加节点，并在 XML 配置文件的 mapper.namespace 属性中配置的接口类中添加同名函数：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.pingcap.model.PlayerMapper">
  4.     <update id="updateByPrimaryKey" parameterType="com.pingcap.model.Player">
  5.     UPDATE player
  6.     SET coins = #{coins, jdbcType=INTEGER},
  7.       goods = #{goods, jdbcType=INTEGER}
  8.     WHERE id = #{id, jdbcType=VARCHAR}
  9.     </update>
  10. </mapper>

更多信息参考更新数据。

删除数据

在 mapper XML 中添加节点，并在 XML 配置文件的 mapper.namespace 属性中配置的接口类中添加同名函数：

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

更多信息参考删除数据。

下一步

需要帮助?

如果在开发的过程中遇到问题，可以在 AskTUG 上进行提问，寻求帮助。