云数据库 OceanBase：SpringJDBC 连接 OceanBase 数据库

前提条件

• 您已安装 OceanBase 数据库并且创建了 MySQL 模式租户。

• 您已安装 JDK 1.8 和 Maven。

• 您已安装 Eclipse。

  说明

  本文档运行代码使用的工具是 Eclipse IDE for Java Developers 2022-03 版本，您也可以根据个人喜好选择适合自己的工具运行的示例代码。

操作步骤

1. 将spring-jdbc-mysql-client项目导入到 Eclipse 中。

2. 获取 OceanBase 数据库 URL。

3. 修改spring-jdbc-mysql-client项目中的数据库连接信息。

4. 运行spring-jdbc-mysql-client项目。

步骤一：将 spring-jdbc-mysql-client 项目导入到 Eclipse 中

1. 打开 Eclipse，在菜单栏上选择 File > Open Projects from File System。

2. 在弹出的对话框中，点击 Directory 按钮选择项目所在的目录，然后点击 Finish 完成导入。

   说明

   当使用 Eclipse 导入 Maven 项目时，Eclipse 会自动检测项目中的pom.xml文件，并根据文件中描述的依赖关系自动下载所需的依赖库，并将它们添加到项目中。

   

3. 查看项目情况。

   

步骤二：获取 OceanBase 数据库 URL

1. 联系 OceanBase 数据库部署人员或者管理员获取相应的数据库连接串。获取连接串操作请参见 获取连接参数

   示例如下：

   obclient -hxxx.xxx.xxx.xxx -P3306 -ua**** -p****** -Dtest

2. 根据 OceanBase 数据库连接串信息填写下面 URL 的对应信息。

   jdbc:mysql://$host:$port/$database_name?user=$user_name&password=$password&useSSL=false

   参数说明：

   • $host：OceanBase 数据库连接的域名。

   • $port：提供 OceanBase 数据库连接端口，默认端口是 3306。

   • $database_name：需要访问的数据库名称。

   • $user_name：提供租户的连接账户。

   • $password：提供账户密码。

   更多有关 MySQL Connector/J 连接属性信息，请参见 Configuration Properties。

   示例如下：

   jdbc:mysql://xxx.xxx.xxx.xxx:3306/test?user=test_user001@mysql001&password=******&useSSL=false

步骤三：修改 spring-jdbc-mysql-client 项目中的数据库连接信息

根据步骤二：获取 OceanBase 数据库 URL 中获取的信息修改文件spring-jdbc-mysql-client/src/main/java/com/example/Main.java中的数据库连接信息。

示例如下：

• OBServer 节点的 IP 地址为xxx.xxx.xxx.xxx。

• 访问端口使用的是 3306。

• 需要访问的数据库名称为test。

• 租户的连接账户是test_user001@mysql001。

• 密码是******。

代码如下：

...
 String url = "jdbc:mysql://xxx.xxx.xxx.xxx:3306/test?useSSL=false";
 String username = "test_user001@mysql001";
 String password = "******";
...

步骤四：运行 spring-jdbc-mysql-client 项目

1. 在项目导航器视图中，找到并展开 src/main/java 目录。

2. 右键点击 Main.java 文件，然后选择 Run As > Java Application。

   

3. 在 Eclipse 的控制台窗口中来查看输出结果。

   

项目代码介绍

点击 spring-jdbc-mysql-client 下载项目代码，是一个名称为 spring-jdbc-mysql-client.zip 的压缩包。解压后，得到一个名为 spring-jdbc-mysql-client 的文件夹。目录结构如下所示：

spring-jdbc-mysql-client
├── src
│ 	└── main
│ 			└── java
│ 					└── com
│ 							└── example
│ 									└── Main.java
└── pom.xml

文件说明：

• src：源代码根目录。

• main：主代码目录，包含应用程序的主要逻辑。

• java：Java 源代码目录。

• com：Java 包目录。

• example：示例项目的包目录。

• Main.java：主类，包含创建表和插入数据等逻辑。

• pom.xml：Maven 项目的配置文件，用于管理项目的依赖和构建设置。

pom.xml 代码介绍

pom.xml文件是 Maven 项目的配置文件，定义了项目的依赖项、插件和构建规则等信息。Maven 是一个 Java 项目管理工具，可以自动下载依赖项、编译和打包项目等操作。

本文pom.xml文件的代码主要包括以下几个部分：

1. 文件声明语句。

   声明本文件是一个 XML 文件，使用的 XML 版本是1.0，字符编码方式是UTF-8。

   代码如下：

   <?xml version="1.0" encoding="UTF-8"?>

2. 配置 POM 的命名空间和 POM 模型版本。

   1. 通过xmlns指定 POM 的命名空间为http://maven.apache.org/POM/4.0.0。

   2. 通过xmlns:xsi指定 XML 命名空间http://www.w3.org/2001/XMLSchema-instance。

   3. 通过xsi:schemaLocation指定 POM 的命名空间为http://maven.apache.org/POM/4.0.0和 POM 的 XSD 文件的位置为http://maven.apache.org/xsd/maven-4.0.0.xsd。

   4. 通过<modelVersion>元素指定了该 POM 文件使用的 POM 模型版本为4.0.0。

   代码如下：

   <project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
   
    <!-- 其他配置 -->
   
   </project>

3. 配置基本信息。

   1. 通过<groupId>指定项目所属组织为com.example。

   2. 通过<artifactId>指定项目的名称为spring-jdbc-mysql-client。

   3. 通过<version>项目的版本号为1.0-SNAPSHOT。

   代码如下：

    <groupId>com.example</groupId>
    <artifactId>spring-jdbc-mysql-client</artifactId>
    <version>1.0-SNAPSHOT</version>

4. 配置项目源文件的属性。

   指定 Maven 的编译器插件为maven-compiler-plugin，并设置了源代码和目标 Java 版本都为 8。这意味着项目的源代码使用 Java 8 特性编写，且编译后的字节码也将兼容 Java 8 运行时环境。这样的设置可以确保项目在编译和运行时能够正确地处理 Java 8 的语法和特性。

   说明

   Java 1.8 和 Java 8 是同一个版本的不同命名方式。

   代码如下：

    <build>
    <plugins>
    <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <configuration>
    <source>8</source>
    <target>8</target>
    </configuration>
    </plugin>
    </plugins>
    </build>

5. 配置项目所依赖组件。

   1. 添加mysql-connector-java依赖库，用于与数据库进行交互：

      说明

      本部分代码定义项目所依赖组件是 MySQL Connector/J 的 V5.1.40 版本，如果需要了解其他版本的信息，请参见 MySQL Connector/J。

      1. 通过<groupId>指定依赖项所属的组织为mysql。

      2. 通过<artifactId>指定依赖项的名称为mysql-connector-java。

      3. 通过<version>指定依赖项的版本号为5.1.40。

      代码如下：

       <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <version>5.1.40</version>
       </dependency>
      

   2. 添加spring-jdbc依赖库：

      1. 通过<groupId>指定依赖项所属的组织为org.springframework。

      2. 通过<artifactId>指定依赖项的名称为spring-jdbc。

      3. 通过<version>指定依赖项的版本号为5.2.0.RELEASE。

      代码如下：

       <dependency>
       <groupId>org.springframework</groupId>
       <artifactId>spring-jdbc</artifactId>
       <version>5.2.0.RELEASE</version>
       </dependency>

Main.java 代码介绍

Main.java文件是示例程序的一部分，代码演示了如何使用 Spring JDBC 框架执行数据库操作。它首先配置了数据库连接信息，然后创建了一个JdbcTemplate对象来执行数据库操作。代码中还包括了创建表、插入数据和查询数据的示例。

本文Main.java文件的代码主要包括以下几个部分：

1. 定义包和导入必要的类。

   1. 声明当前代码所属的包名为com.example。

   2. 导入JdbcTemplate类，它是 Spring JDBC 框架中的核心类，用于执行数据库操作。

   3. 导入DriverManagerDataSource类，它是 Spring 提供的一个实现了DataSource接口的数据源类，用于配置数据库连接信息。

   代码如下：

   package com.example;
   
   import org.springframework.jdbc.core.JdbcTemplate;
   import org.springframework.jdbc.datasource.DriverManagerDataSource;

2. 创建一个Main类，并定义了main方法。

   1. 定义一个名为Main的公共类，作为程序的入口点。类名需要与文件名保持一致。

   2. 定义一个公共静态方法main，作为程序的起始执行点。

   3. 其他数据库操作。

   代码如下：

   public class Main {
    public static void main(String[] args) {
    // 数据库连接信息
    // 创建数据源
    // 创建 JdbcTemplate 对象
    // 创建表
    // 插入数据
    // 更新数据
    // 删除数据
    // 查询数据
    // 删除表
    }
   }

3. 定义数据库连接信息。

   定义用于连接数据库的 URL、用户名和密码。您需要将$host、$port、$database_name、$user_name和$password替换为实际的数据库连接信息。

   代码如下：

    String url = "jdbc:mysql://$host:$port/$database_name?useSSL=false";
    String username = "$user_name";
    String password = "$password";

   参数解释：

   • $host：OceanBase 数据库连接的域名。

   • $port：提供 OceanBase 数据库连接端口，默认端口是 3306。

   • $database_name：需要访问的数据库名称。

   • $user_name：提供租户的连接账户。

   • $password：提供账户密码。

4. 创建数据源。

   创建一个DriverManagerDataSource对象，并配置了数据库连接的相关信息，包括驱动类名、数据库 URL、用户名和密码。具体步骤如下：

   1. 创建一个DriverManagerDataSource对象，用于配置数据库连接的信息。

   2. 设置驱动类名：通过调用setDriverClassName方法，设置数据库驱动类名为com.mysql.jdbc.Driver。

   3. 设置数据库 URL：通过调用setUrl方法，设置数据库的 URL。

   4. 设置用户名：通过调用setUsername方法，设置数据库的用户名。

   5. 设置密码：通过调用setPassword方法，设置数据库的密码。

   代码如下：

    DriverManagerDataSource dataSource = new DriverManagerDataSource();
    dataSource.setDriverClassName("com.mysql.jdbc.Driver");
    dataSource.setUrl(url);
    dataSource.setUsername(username);
    dataSource.setPassword(password);

5. 创建JdbcTemplate对象。

   创建一个JdbcTemplate对象，它是 Spring JDBC 框架的核心类之一。JdbcTemplate提供了执行数据库操作的方法，如执行 SQL 语句、更新数据以及查询数据等。

   代码如下：

    JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);

6. 创建表。

   1. 定义一个创建表的 SQL 语句，SQL 语句中指定表名为test_springjdbc，并定义了两个列，一个是名为id的INT类型列，另一个是名为name的VARCHAR(20)类型列。

   2. 执行创建表的 SQL 语句，jdbcTemplate对象通过调用execute方法，执行了上述定义的创建表的 SQL 语句。

   3. 在控制台输出一条成功创建表的消息。

   代码如下：

    String createTableSql = "CREATE TABLE test_springjdbc (id INT, name VARCHAR(20))";
    jdbcTemplate.execute(createTableSql);
    System.out.println("Create table successfully.");

7. 插入数据。

   1. 定义插入数据的 SQL 语句，SQL 语句中指定了要插入的表为test_springjdbc，列为id和name，插入了两行数据，分别是(1,'A1')、(2,'A2')和(3,'A3')。

   2. 执行插入数据的 SQL 语句，jdbcTemplate对象通过调用update方法，执行了上述定义的插入数据的 SQL 语句。

   3. 在控制台输出一条成功插入数据的消息。

   代码如下：

    String insertDataSql = "INSERT INTO test_springjdbc (id,name) VALUES (1,'A1'), (2,'A2'), (3,'A3')";
    jdbcTemplate.update(insertDataSql);
    System.out.println("Insert data successfully.");

8. 更新数据。

   1. 定义一个 SQL 语句，用于更新数据库表test_springjdbc中id为1的记录的name字段的值为A11。

   2. 通过jdbcTemplate对象执行 SQL 语句，将更新操作应用于数据库。

   3. 在控制台输出一条成功更新数据的消息。

   代码如下：

    String updateDataSql = "UPDATE test_springjdbc SET name = 'A11' WHERE id = 1";
    jdbcTemplate.update(updateDataSql);
    System.out.println("Update data successfully.");

9. 删除数据。

   1. 定义一个 SQL 语句，用于从数据库表test_springjdbc中删除id为2的记录。

   2. 通过jdbcTemplate对象执行 SQL 语句，将删除操作应用于数据库。

   3. 在控制台输出一条成功删除数据的消息。

   代码如下：

    String deleteDataSql = "DELETE FROM test_springjdbc WHERE id = 2";
    jdbcTemplate.update(deleteDataSql);
    System.out.println("Delete data successfully.");

10. 查询数据。

    1. 定义查询数据的 SQL 语句，SQL 语句中使用了SELECT *来选择所有列，从test_springjdbc表中查询数据。

    2. 执行查询数据的SQL语句，jdbcTemplate对象通过调用query方法，执行了上述定义的查询数据的 SQL 语句，并接收一个回调函数作为参数。

    3. 回调函数中的代码使用ResultSet对象(rs) 获取查询结果中的每一行数据，并进行处理。回调函数使用getInt和getString方法从ResultSet对象中获取id和name列的值，并将其打印到控制台。最后，回调函数返回null。

    4. 在控制台输出一条成功查询数据的消息。

    代码如下：

     String selectDataSql = "SELECT * FROM test_springjdbc";
     jdbcTemplate.query(selectDataSql, (rs, rowNum) -> {
     int id = rs.getInt("id");
     String name = rs.getString("name");
     System.out.println("id: " + id + ", name: " + name);
     return null;
     });
     System.out.println("Query data successfully.");

11. 删除表。

    1. 定义一个 SQL 语句，用于删除数据库中的表test_springjdbc。

    2. 通过jdbcTemplate对象执行 SQL 语句，将删除表的操作应用于数据库。

    3. 输出一条成功删除表的消息。

    代码如下：

     String deleteTableSql = "DROP TABLE test_springjdbc";
     jdbcTemplate.execute(deleteTableSql);
     System.out.println("Table drop successfully.");

完整的代码展示

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>spring-jdbc-mysql-client</artifactId>
    <version>1.0-SNAPSHOT</version>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.40</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.2.0.RELEASE</version>
        </dependency>
    </dependencies>

</project>

Main.java

package com.example;

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.datasource.DriverManagerDataSource;

public class Main {
    public static void main(String[] args) {
        // Database Connect Information
        String url = "jdbc:mysql://$host:$port/$database_name?useSSL=false";
        String username = "$user_name";
        String password = "$password";

        // create data source
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.jdbc.Driver");
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);

        // Create a JdbcTemplate object
        JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);

        // Create table
        String createTableSql = "CREATE TABLE test_springjdbc (id INT, name VARCHAR(20))";
        jdbcTemplate.execute(createTableSql);
        System.out.println("Create table successfully.");

        // Insert data
        String insertDataSql = "INSERT INTO test_springjdbc (id,name) VALUES (1,'A1'), (2,'A2'), (3,'A3')";
        jdbcTemplate.update(insertDataSql);
        System.out.println("Insert data successfully.");

        // Update data
        String updateDataSql = "UPDATE test_springjdbc SET name = 'A11' WHERE id = 1";
        jdbcTemplate.update(updateDataSql);
        System.out.println("Update data successfully.");

        // Delete data
        String deleteDataSql = "DELETE FROM test_springjdbc WHERE id = 2";
        jdbcTemplate.update(deleteDataSql);
        System.out.println("Delete data successfully.");

        // Query data
        String selectDataSql = "SELECT * FROM test_springjdbc";
        jdbcTemplate.query(selectDataSql, (rs, rowNum) -> {
            int id = rs.getInt("id");
            String name = rs.getString("name");
            System.out.println("id: " + id + ", name: " + name);
            return null;
        });
        System.out.println("Query data successfully.");
        
        // Delete table
        String deleteTableSql = "DROP TABLE test_springjdbc";
        jdbcTemplate.execute(deleteTableSql);
        System.out.println("Table drop successfully.");
    }
}

相关文档

更多 MySQL Connector/J 的信息，请参见 Overview of MySQL Connector/J。