Spring JDBC を使用した OB Cloud データベースへの接続サンプルプログラム

本ドキュメントでは、Spring JDBC フレームワーク、OceanBase Connector/J、および OB Cloud データベースを使用してアプリケーションを構築し、テーブルの作成、データの挿入、更新、削除、照会、テーブルの削除などの基本的なデータベース操作を実装する方法について説明します。

      spring-jdbc-oceanbase-client サンプルプロジェクトのダウンロード
  </a>
  <a role='video' href='https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/video-center/video/video/05%20spring-jdbc-oceanbase-client.mp4'>
      
      Spring JDBC を使用した OceanBase データベースへの接続サンプルプログラム（Oracleモード）
  </a>

• OB Cloud データベースのアカウントを登録し、クラスタインスタンスと OB Cloud Oracleテナントを作成していること。詳細は、クラスタインスタンスの作成およびテナントの作成をご参照ください。

• JDK 1.8 および Maven がインストールされていること。

• Eclipse がインストールされていること。

  説明

  本ドキュメントでコードを実行するために使用するツールは Eclipse IDE for Java Developers 2022-03 バージョンですが、個人の好みに応じて適切なツールを選択してサンプルコードを実行することもできます。

手順

1. spring-jdbc-oceanbase-client プロジェクトを Eclipse にインポートします。
2. OB Cloud データベースの URL を取得します。
3. spring-jdbc-oceanbase-client プロジェクト内のデータベース接続情報を変更します。
4. spring-jdbc-oceanbase-client プロジェクトを実行します。

手順 1：spring-jdbc-oceanbase-client プロジェクトを Eclipse にインポートする

1. Eclipse を開き、メニューバーから File -> Open Projects from File System を選択します。

2. ポップアップダイアログで、Directory ボタンをクリックしてプロジェクトのディレクトリを選択し、Finish をクリックしてインポートを完了します。

   説明

   Eclipse を使用して Maven プロジェクトをインポートすると、Eclipse はプロジェクト内の pom.xml ファイルを自動的に検出し、ファイルに記述された依存関係に基づいて必要な依存ライブラリを自動的にダウンロードしてプロジェクトに追加します。

3. プロジェクトの状況を確認します。

手順 2：OB Cloud データベースの URL を取得する

1. OB Cloud コンソールにログインします。インスタンスリストページで、対象インスタンスの情報を展開し、対象テナントの下で 接続 > 接続文字列の取得 を選択します。

   詳細な操作については、接続文字列の取得をご参照ください。

2. 作成した OB Cloud データベースに基づいて、以下の URL の対応する情報を入力します。

   jdbc:oceanbase://$host:$port/$schema_name?user=$user_name&password=$password
   

   パラメータの説明：

   • $host：OB Cloud データベースの接続アドレスを指定します。例：t********.********.oceanbase.cloud。

   • $port：OB Cloud データベースの接続ポートを指定します。デフォルトは 1521 です。

   • $schema_name：アクセスする Schema 名を指定します。

     注意

     テナントに接続するユーザーは、CREATE SESSION 特権、および該当 Schema に対する CREATE TABLE、DROP TABLE、INSERT、DELETE、UPDATE、SELECT 特権を持っている必要があります。ユーザー特権の詳細については、アカウントの作成と管理をご参照ください。

   • $user_name：データベースにアクセスするアカウントを指定します。

   • $password：アカウントのパスワードを指定します。

   例：

   jdbc:oceanbase://t5******.********.oceanbase.cloud:1521/sys?user=oracle001&password=******
   

手順 3：spring-jdbc-oceanbase-client プロジェクト内のデータベース接続情報を変更する

手順 2：OB Cloud データベースの URL を取得する で取得した情報に基づいて、spring-jdbc-oceanbase-client/src/main/java/com/example/Main.java ファイル内のデータベース接続情報を変更します。

例：

• OB Cloud データベースの接続アドレスは t5******.********.oceanbase.cloud です。
• アクセスポートは 1521 を使用します。
• アクセスする Schema 名は sys です。
• テナントの接続アカウントは oracle001 です。
• パスワードは ****** です。

コードは以下の通りです：

...
        String url = "t5******.********.oceanbase.cloud:1521/sys";
        String username = "oracle001";
        String password = "******";
...

手順 4：spring-jdbc-oceanbase-client プロジェクトを実行する

1. プロジェクトナビゲータービューで、src/main/java ディレクトリを見つけて展開します。

2. Main.java ファイルを右クリックし、Run As -> Java Application を選択します。

3. Eclipse のコンソールウィンドウで出力結果を確認します。

プロジェクトコードの紹介

spring-jdbc-oceanbase-client をクリックしてプロジェクトコードをダウンロードします。これは spring-jdbc-oceanbase-client.zip という名前の圧縮パッケージです。

解凍すると、spring-jdbc-oceanbase-client という名前のフォルダが作成されます。ディレクトリ構造は以下の通りです：

spring-jdbc-oceanbase-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-oceanbase-client に指定します。
   3. <version> を使用して、プロジェクトのバージョン番号を 1.0-SNAPSHOT に指定します。

   コードは以下の通りです：

       <groupId>com.example</groupId>
       <artifactId>spring-jdbc-oceanbase-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. データベースと対話するための oceanbase-client 依存ライブラリを追加します：

      1. <groupId> を使用して、依存関係が属する組織を com.oceanbase に指定します。
      2. <artifactId> を使用して、依存関係の名前を oceanbase-client に指定します。
      3. <version> を使用して、依存関係のバージョン番号を 2.4.2 に指定します。

      説明

      この部分のコードは、プロジェクトが依存するコンポーネントが OceanBase Connector/J の V2.4.2 バージョンであることを定義しています。他のバージョンの詳細については、OceanBase JDBC ドライバをご参照ください。

      コードは以下の通りです：

              <dependency>
                  <groupId>com.oceanbase</groupId>
                  <artifactId>oceanbase-client</artifactId>
                  <version>2.4.2</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. Spring JDBC フレームワークのコアクラスであり、データベース操作を実行するために使用される JdbcTemplate クラスをインポートします。
   3. Spring が提供する DataSource インターフェースを実装したデータソースクラスであり、データベース接続情報を設定するために使用される DriverManagerDataSource クラスをインポートします。

   コードは以下の通りです：

   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、$schema_name、$user_name、および $password を実際のデータベース接続情報に置き換える必要があります。

   コードは以下の通りです：

           String url = "jdbc:oceanbase://$host:$port/$schema_name";
           String username = "$user_name";
           String password = "$password";
   

   パラメータの説明：

   • $host：OB Cloud データベースの接続アドレスを指定します。例：t********.********.oceanbase.cloud。

   • $port：OB Cloud データベースの接続ポートを指定します。デフォルトは 1521 です。

   • $schema_name：アクセスする Schema 名を指定します。

   • $user_name：データベースにアクセスするアカウントを指定します。

   • $password：アカウントのパスワードを指定します。

4. データソースの作成。

   DriverManagerDataSource オブジェクトを作成し、ドライバクラス名、データベース URL、ユーザー名、パスワードなどのデータベース接続に関する情報を設定します。具体的な手順は以下の通りです：

   1. データベース接続情報を設定するための DriverManagerDataSource オブジェクトを作成します。
   2. ドライバクラス名の設定：setDriverClassName メソッドを呼び出して、データベースドライバクラス名を com.oceanbase.jdbc.Driver に設定します。これは OB Cloud データベースへの接続に使用されるドライバクラスです。
   3. データベース URL の設定：setUrl メソッドを呼び出して、データベースの URL を設定します。
   4. ユーザー名の設定：setUsername メソッドを呼び出して、データベースのユーザー名を設定します。
   5. パスワードの設定：setPassword メソッドを呼び出して、データベースのパスワードを設定します。

   コードは以下の通りです：

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

5. JdbcTemplate オブジェクトの作成。

   Spring JDBC フレームワークのコアクラスの 1 つである JdbcTemplate オブジェクトを作成します。JdbcTemplate は、SQL 文の実行、データの更新、データの照会などのデータベース操作を実行するメソッドを提供します。

   コードは以下の通りです：

           JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
   

6. テーブルの作成。

   1. テーブルを作成する SQL 文を定義します。SQL 文ではテーブル名を test_springjdbc と指定し、id という名前の NUMBER 型の列と、name という名前の VARCHAR2(20) 型の列の 2 つの列を定義します。
   2. テーブル作成の SQL 文を実行します。jdbcTemplate オブジェクトは execute メソッドを呼び出して、上記で定義したテーブル作成の SQL 文を実行します。
   3. コンソールにテーブル作成成功のメッセージを出力します。

   コードは以下の通りです：

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

7. データの挿入。

   1. データを挿入する SQL 文を定義します。SQL 文では挿入先のテーブルを test_springjdbc、列を id と name に指定し、(1,'A1')、(2,'A2')、および (1,'A3') の 3 行のデータを挿入します。
   2. データ挿入の SQL 文を実行します。jdbcTemplate オブジェクトは update メソッドを呼び出して、上記で定義したデータ挿入の SQL 文を実行します。
   3. コンソールにデータ挿入成功のメッセージを出力します。

   コードは以下の通りです：

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

8. データの更新。

   1. データベーステーブル test_springjdbc 内の id が 1 であるレコードの name フィールドの値を A11 に更新する SQL 文を定義します。
   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. データベーステーブル test_springjdbc から id が 2 であるレコードを削除する SQL 文を定義します。
   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. データベース内のテーブル test_springjdbc を削除する SQL 文を定義します。
    2. jdbcTemplate オブジェクトを介して SQL 文を実行し、テーブル削除操作をデータベースに適用します。
    3. テーブル削除成功のメッセージを出力します。

    コードは以下の通りです：

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

完全なコードの表示

<?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-oceanbase-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>com.oceanbase</groupId>
            <artifactId>oceanbase-client</artifactId>
            <version>2.4.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.2.0.RELEASE</version>
        </dependency>
    </dependencies>

</project>

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:oceanbase://$host:$port/$schema_name";
        String username = "$user_name";
        String password = "$password";

        // create data source
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.oceanbase.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 NUMBER, name VARCHAR2(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'), (1,'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.");
    }
}

関連情報