Skip to content

Latest commit

 

History

History
269 lines (181 loc) · 10.4 KB

dev-guide-sample-application-java-spring-boot.md

File metadata and controls

269 lines (181 loc) · 10.4 KB
Raw
title summary aliases
使用 Spring Boot 连接到 TiDB
了解如何使用 Spring Boot 连接到 TiDB。本文提供了使用 Spring Boot 与 TiDB 交互的 Java 示例代码片段。
/zh/tidb/dev/dev-guide-sample-application-spring-boot
/zh/tidb/dev/sample-application-spring-boot

使用 Spring Boot 连接到 TiDB

TiDB 是一个兼容 MySQL 的数据库。Spring 是当前比较流行的开源 Java 容器框架，本文选择 Spring Boot 作为使用 Spring 的方式。

本文档将展示如何使用 TiDB 和 Spring Data JPA 及 Hibernate 作为 JPA 提供者来完成以下任务：

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

注意

本文档适用于 TiDB Cloud Serverless、TiDB Cloud Dedicated 和本地部署的 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 集群。

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

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

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

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

    Tip:

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

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

    Tip:

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

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

    cp env.sh.example env.sh

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

    export TIDB_HOST='{host}'  # e.g. xxxxxx.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 要求使用 TLS (SSL) connection，因此 USE_SSL 的值应为 true。

  7. 保存 env.sh 文件。

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

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

  3. 在连接对话框中，从 Connection Type 下拉列表中选择 Public，并点击 CA cert 下载 CA 文件。

    如果你尚未配置 IP 访问列表，请在首次连接前点击 Configure IP Access List 或按照配置 IP 访问列表（英文）中的步骤进行配置。

    除 Public 连接类型外，TiDB Cloud Dedicated 还支持 Private Endpoint 和 VPC Peering 连接类型。详情请参阅连接 TiDB Cloud Dedicated 集群（英文）。

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

    cp env.sh.example env.sh

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

    export TIDB_HOST='{host}'  # e.g. xxxxxx.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='false'

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

  6. 保存 env.sh 文件。

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

    cp env.sh.example env.sh

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

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

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

  3. 保存 env.sh 文件。

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

  1. 运行下述命令，启动示例代码编写的服务：

    make

  2. 打开另一个终端，开启请求脚本：

    make request

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

示例代码片段

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

完整代码及其运行方式，见代码仓库 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: ""

数据管理

Spring Data JPA 通过 @Entity 注册数据实体，并绑定数据库的表。

@Entity
@Table(name = "player_jpa")
public class PlayerBean {
}

PlayerRepository 通过继承 JpaRepository 接口，由 JpaRepositoryFactoryBean 为其自动注册对应的 Repository Bean。同时，JpaRepository 接口的默认实现类 SimpleJpaRepository 提供了增删改查函数的具体实现。

@Repository
public interface PlayerRepository extends JpaRepository<PlayerBean, Long> {
}

随后，在需要使用 PlayerRepository 的类中，你可以通过 @Autowired 自动装配，这样就可以直接使用增删改查函数了。示例代码如下：

@Autowired
private PlayerRepository playerRepository;

插入或更新数据

playerRepository.save(player);

更多信息参考插入数据和更新数据。

查询数据

PlayerBean player = playerRepository.findById(id).orElse(null);

更多信息参考查询数据。

删除数据

playerRepository.deleteById(id);

更多信息参考删除数据。

下一步

需要帮助?

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