SpringBootでOceanBase Cloudデータベースに接続するサンプルプログラム

本記事では、SpringBootフレームワークとOceanBase Cloudデータベースを使用して、テーブルの作成、データの挿入、クエリなどの基本的な操作を実現するアプリケーションを構築する方法を紹介します。

      クリックしてjava-oceanbase-springbootサンプルプロジェクトをダウンロード
  </a>
  <!-- <a role='video' href='https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/video-center/video/video/01%20java-ob-springboot_e01.mp4'>
      
      SpringBootでOceanBaseデータベースに接続するサンプルプログラム（Oracleモード）
   </a> -->

• OceanBase Cloudデータベースアカウントを登録し、クラスタインスタンスとOceanBase Cloud Oracleモードのテナントを作成していること。詳細については、クラスタインスタンスの作成およびテナントの作成をご参照ください。
• JDK 1.8とMavenをインストール済みであること。
• IntelliJ IDEAをインストール済みであること。

操作手順

1. OceanBase Cloudの接続情報を取得します。
2. java-oceanbase-springboot プロジェクトをIDEAにインポートします。
3. java-oceanbase-springboot プロジェクトのデータベース接続情報を修正します。
4. java-oceanbase-springboot プロジェクトを実行します。

ステップ１：OceanBase Cloudの接続情報を取得する

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

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

2. 作成済みのOceanBase Cloudに基づいて、以下のURLに対応する情報を入力します。

   説明

   application.properties ファイルにこのURL情報が必要です。

   jdbc:oceanbase://host:port/schema_name?user=$user_name&password=$password&useSSL=false&useUnicode=true&characterEncoding=utf-8
   

   パラメータ説明：

   • host：OceanBase Cloudの接続アドレスを提供します。例：t********.********.oceanbase.cloud。

   • port：OceanBase Cloudの接続ポートを提供します。デフォルトは1521です。

   • schema_name：アクセスするSchema名です。

   • user_name：データベースへのアクセスアカウントを提供します。

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

   • useSSL=false&useUnicode=true&characterEncoding=utf-8：追加の接続プロパティです。

     • useSSL：接続時にSSL/TLSを強制的に使用するかどうかを指定します。デフォルト値：false。
     • useUnicode：文字のエンコードおよびデコード形式を指定します。デフォルト値：true。
     • characterEncoding：サポートされているデータベースURLオプションの文字エンコーディングです。デフォルト値：utf8。
     • socketTimeout：ネットワークソケットのタイムアウト(SO_TIMEOUT)をミリ秒単位で定義します。値が0の場合、このタイムアウトは無効になります。

その他のURLパラメータの説明については、データベースURLをご参照ください。

ステップ2：java-oceanbase-springboot プロジェクトをIDEAにインポートする

1. IntelliJ IDEA を開き、File > Open... オプションを選択します。

2. 表示された Open File or Project ウィンドウで、対応するプロジェクトファイルを選択し、OK をクリックしてプロジェクトファイルのインポートを完了します。

3. IntelliJ IDEAは、プロジェクト内のさまざまなファイルの種類を自動的に認識し、Project ツールウィンドウで、プロジェクトのディレクトリ構造、ファイルリスト、モジュールリスト、依存関係などの情報を確認できます。Project ツールウィンドウは通常、IntelliJ IDEA画面の左側にあり、デフォルトでは開いています。Project ツールウィンドウが閉じている場合は、メニューバーの View > Tool Windows > Project をクリックするか、ショートカットキー Alt + 1 を使用して再表示できます。

   説明

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

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

ステップ3：java-oceanbase-springboot プロジェクトのデータベース接続情報を修正する

ステップ1：OceanBase Cloud接続情報を取得する の情報に基づいて、application.properties ファイル内のデータベース接続情報を修正します。

例：

• データベースドライバーの名前：com.oceanbase.jdbc.Driver
• OceanBase Cloudの接続アドレスは t5******.********.oceanbase.cloud です。
• アクセスポートは1521を使用します。
• アクセスするスキーマ名は sys です。
• テナントの接続アカウントはoracle001です。
• パスワードは ****** です。

サンプルコードは以下のとおりです：

spring.datasource.driverClassName=com.oceanbase.jdbc.Driver
spring.datasource.url=jdbc:oceanbase://t5******.********.oceanbase.cloud:1521/sys?useSSL=false&useUnicode=true&characterEncoding=utf-8
spring.datasource.username=oracle001
spring.datasource.password=******

ステップ4：java-oceanbase-hibernate プロジェクトを実行する

実行パス

1. プロジェクト構造の src > test > java 内から TestSpringbootApplicationTests.java ファイルを見つけます。
2. ツールメニューバーで 実行(U) > 実行 > TestSpringbootApplicationTests を選択するか、右上の緑色の三角形を直接クリックして実行します。
3. IDEAのコンソールでプロジェクトのログ情報と出力結果を確認します。

実行結果

test_springboot delete successfully!
test_springboot create successfully!
user = User{id=2, name='update'}
User{id=2, name='update'}
User{id=3, name='insert3'}
User{id=4, name='insert4'}
User{id=5, name='insert5'}
User{id=6, name='insert6'}
User{id=7, name='insert7'}
User{id=8, name='insert8'}
User{id=9, name='insert9'}
User{id=10, name='insert10'}

プロジェクトコードについて

java-oceanbase-springboot をクリックしてプロジェクトコードをダウンロードします。これは java-oceanbase-springboot という名前の圧縮ファイルです。

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

│--pom.xml
│
├─.idea
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─oceanbase
│  │  │          └─testspringboot
│  │  │              │--TestSpringbootApplication.java
│  │  │              │
│  │  │              ├─dao
│  │  │              │  │--UserDao.java
│  │  │              │  │
│  │  │              │  └─impl
│  │  │              │      └─--UserDaoImpl.java
│  │  │              │
│  │  │              └─entity
│  │  │                  └─--User.java
│  │  │
│  │  └─resources
│  │      └─--application.properties
│  │
│  └─test
│      └─java
│          └─com
│              └─oceanbase
│                  └─testspringboot
│                      └─--TestSpringbootApplicationTests.java
│
└─target

ファイルの説明：

• pom.xml：Mavenプロジェクトの設定ファイルで、プロジェクトの依存関係、プラグイン、ビルドなどの情報が含まれます。
• .idea：IDE（統合開発環境）で使用されるディレクトリで、プロジェクト関連の設定情報を格納します。
• src：プロジェクトのソースコードを格納するディレクトリです。
• main: 主要なソースコードとリソースファイルを格納するディレクトリ。
• java: Javaソースコードを格納するディレクトリ。
• com: Javaパッケージのルートディレクトリ。
• oceanbase: プロジェクトのルートディレクトリ。
• testspringboot：プロジェクトのすべてのJavaクラスを含むJavaパッケージのルートディレクトリ。
• TestSpringbootApplication.java：プロジェクトのメインクラスで、mainメソッドが含まれます。
• dao: データアクセスオブジェクト（Data Access Object）パッケージを格納するディレクトリで、データベースやその他のデータストレージサービスへのアクセスに使用されます。
• UserDao.java：ユーザーデータアクセスオブジェクトで、ユーザーデータの追加、削除、変更、検索などの操作に使用されます。
• impl：DAOインターフェースの実装ディレクトリ。
• UserDaoImpl.java：ユーザーDAOインターフェースの実装クラス。
• entity：エンティティクラスのディレクトリで、データベーステーブルに対応するJavaクラスを格納します。
• User.java：ユーザー永続化オブジェクトで、ユーザーデータテーブルのフィールドをマッピングするために使用されます。
• resources: リソースファイルを格納するディレクトリで、設定ファイルやSQLファイルなどが含まれます。
• application.properties：プロジェクトの設定ファイルで、アプリケーションのプロパティとパラメータを設定するために使用されます。
• test: テストコードとリソースファイルを格納するディレクトリ。
• TestSpringbootApplicationTests.java: Spring Bootのテスト用Javaクラス。
• target: コンパイル済みのClassファイルやJarパッケージなどのファイルを格納するディレクトリ。

pom.xmlコードの紹介

pom.xml 設定ファイルの内容は以下のとおりです：

1. ファイル宣言ステートメント。

   このファイルがXMLファイルであり、使用しているXMLバージョンが 1.0、文字エンコーディング方式が UTF-8 であることを宣言します。

   コード：

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

2. POMの名前空間とPOMモデルバージョンの設定。

3. xmlns を使用して、POMの名前空間を http://maven.apache.org/POM/4.0.0 に指定します。

4. xmlns:xsi を使用して、XMLの名前空間を http://www.w3.org/2001/XMLSchema-instance に指定します。

5. xsi:schemaLocation を使用して、POM の名前空間を http://maven.apache.org/POM/4.0.0、POM の XSD ファイルの場所を https://maven.apache.org/xsd/maven-4.0.0.xsd に指定します。

6. <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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
</project>

3. 親要素情報の設定。

4. <groupId> を使用して、親要素の識別子を org.springframework.boot と指定します。

5. <artifactId> を使用して、親要素の依存関係を spring-boot-starter-parent と指定します。

6. <version> を使用して、親要素のバージョン番号を 2.7.11 と指定します。

7. relativePath を使用して、親要素のパスが空であることを示します。

コード：

 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-parent</artifactId>
 <version>2.7.11</version>
 <relativePath/> 

4. 基本情報の設定。

5. <groupId> を使用して、プロジェクト識別子を com.oceanbase と指定します。

6. <artifactId> を使用して、プロジェクトの依存関係を java-oceanbase-springboot と指定します。

7. <version> を使用して、プロジェクトのバージョン番号を 0.0.1-SNAPSHOT と指定します。

8. description を使用して、プロジェクト情報を Demo project for Spring Boot と紹介します。

コード：

 <groupId>com.oceanbase</groupId>
 <artifactId>java-oceanbase-springboot</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <name>java-oceanbase-springboot</name>
 <description>Demo project for Spring Boot</description>

5. Javaバージョンの設定。

   プロジェクトで使用するJavaバージョンを1.8に指定します。

   コード：

     <properties>
         <java.version>1.8</java.version>
     </properties>
   

6. コア依存関係の設定。

   1. 依存関係の所属組織をorg.springframework.boot、名前をspring-boot-starterに指定します。この依存ライブラリには、Spring Bootがデフォルトでサポートするコンポーネントの依存関係が含まれており、Web、データ処理、セキュリティ、Testなどの機能をサポートしています。

      コード：

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
      </dependency>
      

   2. 依存関係の所属組織をorg.springframework.boot、名前をspring-boot-starter-jdbcに指定します。この依存関係により、接続プールやデータソース設定など、Spring Bootが提供するJDBC関連機能を利用できます。

      コード：

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-jdbc</artifactId>
      </dependency>
      

   3. 依存関係の所属組織をorg.springframework.boot、名前をspring-boot-starter-test、スコープをtestに指定します。この依存関係により、JUnit、Mockito、Hamcrestなど、Spring Bootが提供するテストフレームワークとツールを利用できます。

      コード：

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
      </dependency>
      

   4. 依存関係の所属組織をcom.oceanbase、名前をoceanbase-client、バージョン番号を2.4.3に指定します。この依存関係により、接続、クエリ、トランザクションなど、OceanBaseが提供するクライアント機能を利用できます。

      コード：

          <dependencies>
          <dependency>
              <groupId>com.oceanbase</groupId>
              <artifactId>oceanbase-client</artifactId>
              <version>2.4.3</version>
          </dependency>
          </dependencies>
      

7. Mavenプラグインの設定。

   依存関係の所属組織をorg.springframework.boot、名前をspring-boot-maven-pluginに指定します。このプラグインは、Spring Bootアプリケーションを実行可能なJARパッケージまたはWARパッケージにパッケージ化し、直接実行するために使用されます。

   コード：

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
   

application.propertiesコードの紹介

application.properties ファイルは、Spring Bootアプリケーションのデータソースを設定し、OceanBase Cloudへの接続に必要なドライバークラス名、URL、ユーザー名、パスワードを指定します。これらの設定により、アプリケーションはOceanBase Cloudに接続し、操作を実行できます。

• spring.datasource.driverClassName を使用して、データベースドライバーを com.oceanbase.jdbc.Driver と指定します。これはOceanBase Cloudとの接続を確立するために使用されます。

• spring.datasource.url を使用して、データベース接続用のURLを指定します。

• spring.datasource.username を使用して、データベース接続用のユーザー名を指定します。

• spring.datasource.password を使用して、データベース接続用のパスワードを指定します。

  コード：

  spring.datasource.driverClassName=com.oceanbase.jdbc.Driver
  spring.datasource.url=jdbc:oceanbase://host:port/schema_name?useSSL=false&useUnicode=true&characterEncoding=utf-8
  spring.datasource.username=user_name
  spring.datasource.password=******
  

UserDaoImpl.javaファイルの紹介

UserDaoImpl.java ファイルは、JdbcTemplate オブジェクトを使用してSQLステートメントを実行し、Userテーブルに対する挿入、削除、更新、およびクエリ操作を実装します。

UserDaoImpl.java ファイルのコードは、主に以下の部分で構成されています：

1. 他のクラスとインターフェースのインポート。

   このファイルが属するパッケージ名を com.oceanbase.testspringboot.dao.impl として宣言し、以下のインターフェースとクラスを含みます：

   • UserDao インターフェース：UserDaoインターフェースで定義されたメソッドを実装するために使用されます。
   • User クラス：ユーザーデータの受け渡しと保存に使用されます。
   • Autowired アノテーション：SQLステートメントを実行するための JdbcTemplate オブジェクトをこのクラスに注入します。
   • BeanPropertyRowMapper クラス：データベースクエリ結果をJavaオブジェクトにマッピングするために使用されます。
   • JdbcTemplate クラス：SQLステートメントの実行とデータベースアクセスの処理に使用されます。
   • Repository アノテーション：データアクセスに使用されるSpringのリポジトリコンポーネントを示します。
   • List インターフェース：クエリ結果の集合を操作するために使用されます。

   コード：

   import com.oceanbase.testspringboot.dao.UserDao;
   import com.oceanbase.testspringboot.entity.User;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.jdbc.core.BeanPropertyRowMapper;
   import org.springframework.jdbc.core.JdbcTemplate;
   import org.springframework.stereotype.Repository;
   import java.util.List;
   

2. UserDaoImpl クラスの定義。

   Repository アノテーションを使用してこのクラスの Bean 名を userDao と指定し、JdbcTemplate オブジェクトを使用してSQLステートメントを実行することで、User テーブルに対する挿入、削除、更新、およびクエリ操作を実装します。

   1. ユーザー情報の挿入。

      JdbcTemplate オブジェクトの insert メソッドを呼び出し、ユーザーのIDと名前をデータベースの test_springboot テーブルに挿入し、挿入操作の結果に応じて対応するブール値を返します。

      コード：

      @Autowired
          private JdbcTemplate jdbcTemplate; //Jdbc connection tool class
          @Override
          public boolean insertUser(User user) {
              String sql = "insert into test_springboot(id,name)values(?,?)";
              Object[] params = {user.getId(), user.getName()};
              return jdbcTemplate.update(sql, params) > 0;
          }
      

   2. ユーザー情報の削除。

      JdbcTemplate オブジェクトの delete メソッドを呼び出し、ユーザーのIDに基づいてデータベース内のユーザー情報を削除し、削除操作の結果に応じて対応するブール値を返します。

      コード：

      @Override
      public boolean deleteById(Long id) {
          String sql = "delete from test_springboot where id=?";
          Object[] params = {id};
          return jdbcTemplate.update(sql, params) > 0;
      }
      

   3. ユーザー情報の更新。

      JdbcTemplate オブジェクトの update メソッドを呼び出し、指定されたIDのレコードについて、データベースのtest_springbootテーブル内のユーザー名を更新し、更新操作の結果に応じて対応するブール値を返します。

      コード：

      @Override
      public boolean updateUser(User user) {
          String sql = "update test_springboot set name=? where id=?";
          Object[] params = {user.getName(), user.getId()};
          return jdbcTemplate.update(sql, params) > 0;
      }
      

   4. ユーザー情報をクエリします。

      JdbcTemplate オブジェクトを使用してSQLクエリステートメントを実行し、test_springboot テーブルから指定されたIDのユーザーレコードを取得し、BeanPropertyRowMapper を使用して結果をマッピングします。クエリ結果オブジェクトを返します。

      コード：

      @Override
      public User selectUserById(Long id) {
          String sql = "select * from test_springboot where id=?";
          Object[] params = new Object[]{id};
          return jdbcTemplate.queryForObject(
                  sql,
                  params,
                  new BeanPropertyRowMapper<>(User.class));
      }
      

   5. すべてのユーザー情報をクエリします。

      JdbcTemplate オブジェクトの query メソッドを呼び出して、データベース内のすべてのユーザー情報をクエリし、クエリ結果をUser型のオブジェクトリストにマッピングして返します。

      コード：

      @Override
      public List<User> selectAllUsers() {
          String sql = "select * from test_springboot";
          return jdbcTemplate.query(sql, new BeanPropertyRowMapper<User>(User.class));
      }
      

UserDao.javaファイルの紹介

UserDao.java ファイルは、UserDaoインターフェースを通じてユーザーデータの操作メソッドを定義するために使用されます。

UserDao.java ファイルのコードは、主に以下の部分で構成されています：

1. 他のクラスとインターフェースのインポート。

   このファイルが属するパッケージ名を package com.oceanbase.testspringboot.dao として宣言し、以下のインターフェースとクラスを含みます：

   • User クラス：ユーザーデータの受け渡しと保存に使用されます。
   • List インターフェース：クエリ結果の集合を操作するために使用されます。

   コード：

   import com.oceanbase.testspringboot.entity.User;
   import java.util.List;
   

2. UserDao インターフェースの定義。

   UserDao インターフェースを使用して、ユーザーデータの操作メソッドを定義します。ユーザー情報の挿入、削除、更新、ユーザーIDによるユーザー情報の検索、およびすべてのユーザー情報の検索などのメソッドが含まれます。

   コード：

   public interface UserDao {
       boolean insertUser(User user);
       boolean deleteById(Long id);
       boolean updateUser(User user);
       User selectUserById(Long id);
       List<User> selectAllUsers();
   }
   

User.javaファイルの紹介

User.java ファイルは、ユーザーオブジェクトを表す User クラスを定義するために使用されます。

1. User オブジェクトの宣言。 User クラスが id と name の2つのプライベートフィールドを含み、パラメータなしのコンストラクタメソッドを提供することを宣言します。id と name フィールドの値を設定および取得することで、ユーザー情報を操作します。

   コード：

   private Long id;
   private String name;
   
   public User() {
   }
   

2. User オブジェクトの作成。 User クラスのパラメータ付きコンストラクタメソッドを定義し、指定された id と name を持つ User オブジェクトを作成するために使用します。

   コード：

   public User(Long id, String name) {
       this.id = id;
       this.name = name;
   }
   

3. id と name の値の取得と設定。 User クラス内に、id と name プロパティの値を取得および設定するための4つのメソッドを定義します。 getId メソッドは id 値を取得するために使用され、setId メソッドは id 値を設定するために使用されます。getName メソッドは、ユーザー名 name の値を取得するために使用されます。setName メソッドは、ユーザー名 name の値を設定するために使用されます。

   コード：

   public Long getId() {
       return id;
   }
   
   public void setId(Long id) {
       this.id = id;
   }
   
   public String getName() {
       return name;
   }
   
   public void setName(String name) {
       this.name = name;
   }
   

4. User オブジェクトの文字列表現を返します。

   User クラスの toString メソッドをオーバーライドして、User オブジェクトの文字列表現を返すために使用します。 @Override を定義して、親クラスの同名メソッドをオーバーライドします。toString メソッドを定義し、User オブジェクトの文字列表現を返すために使用します。文字列連結を使用して、id と name プロパティの値を文字列としてフォーマットし、呼び出し元の User に返します。

   コード：

   @Override
   public String toString() {
       return "User{" +
               "id=" + id +
               ", name='" + name + '\'' +
               '}';
   }
   

TestSpringbootApplication.javaファイルの紹介

TestSpringbootApplication.java ファイルは、UserDao インターフェースを通じてSpring Bootアプリケーションを起動するために使用されます。

TestSpringbootApplication.java ファイルのコードは、主に以下の部分で構成されています：

1. クラスとインターフェースの定義。

   このファイルが属するパッケージ名を com.oceanbase.testspringboot と宣言し、以下のインターフェースとクラスを含みます：

   • SpringApplication クラス：Spring Bootアプリケーションを起動するために使用されます。
   • @SpringBootApplication アノテーション：このクラスがSpring Bootアプリケーションのエントリポイントであることを示すために使用されます。

   コード：

   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   

2. TestSpringbootApplication クラスの定義。

SpringBootApplicationアノテーションを使用して、このクラスがSpring Bootアプリケーションのエントリクラスであることを示します。SpringApplicationクラスのrunメソッドを呼び出すことで、Spring Bootアプリケーションを起動できます。

**コード：**

```java
@SpringBootApplication
public class TestSpringbootApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestSpringbootApplication.class, args);
    }
}
```

TestSpringbootApplicationTests.javaファイルの紹介

TestSpringbootApplicationTests.java ファイルは、UserDao インターフェースを通じてSpring Bootアプリケーションを起動するために使用されます。

TestSpringbootApplicationTests.java ファイルのコードは、主に以下の部分で構成されています：

1. 他のクラスとインターフェースのインポート。

   このファイルが属するパッケージ名を com.oceanbase.testspringboot と宣言し、以下のインターフェースとクラスを含みます：

   • UserDao インターフェース：UserDaoインターフェースで定義されたメソッドを実装するために使用されます。
   • User クラス：ユーザーデータの受け渡しと保存に使用されます。
   • Test アノテーション：テストメソッドを識別するために使用されます。
   • Autowired アノテーション：SQLステートメントを実行するためのJdbcTemplateオブジェクトをこのクラスに注入します。
   • SpringBootTest アノテーション：このクラスがSpring Bootのテストクラスであることを識別するために使用されます。
   • JdbcTemplate クラス：SQLステートメントの実行とデータベースアクセスの処理に使用されます。
   • List インターフェース：クエリ結果の集合を操作するために使用されます。

   コード：

   import com.oceanbase.testspringboot.dao.UserDao;
   import com.oceanbase.testspringboot.entity.User;
   import org.junit.jupiter.api.Test;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.boot.test.context.SpringBootTest;
   import org.springframework.jdbc.core.JdbcTemplate;
   import java.util.List;
   
   

2. TestSpringbootApplicationTests クラスを定義します。

   SpringBootTest アノテーションを使用して、Spring Bootアプリケーション内の機能をテストすることを示します。UserDao および JdbcTemplate オブジェクトを使用して、ユーザーデータの追加、削除、変更、検索操作を行い、結果を出力します。

   1. オブジェクトを定義します。

      Autowired アノテーションを使用して、UserDao および JdbcTemplate オブジェクトを自動注入します。

      コード：

      @Autowired
      private UserDao userDao;
      @Autowired
      private JdbcTemplate jdbcTemplate; 
      

   2. contextLoads メソッドを定義します。

      contextLoads メソッドをテストメソッドの具体的な実装として使用します。

      1. test_springboot テーブルを削除します。

         jdbcTemplate.execute メソッドを使用してSQLステートメント drop table test_springboot を実行し、test_springboot という名前のテーブルを削除します。

         コード：

         try {
               jdbcTemplate.execute("drop table test_springboot");
               System.out.println("test_springboot delete successfully!");
             } 
         

      2. test_springboot テーブルを作成します。

         jdbcTemplate.execute メソッドを使用してSQLステートメント create table test_springboot (id int primary key, name varchar(50)) を実行し、id と name の2つのフィールドを持つ test_springboot という名前のテーブルを作成します。

         コード：

         catch (Exception ignore) {
         
                 } finally {
                     jdbcTemplate.execute("create table test_springboot (" +
                             "id int primary key," +
                             "name varchar(50))");
                     System.out.println("test_springboot create successfully!");
                 }
         

      3. データを挿入します。

         userDao.insertUser メソッドを使用して、test_springboot テーブルに10件のユーザーデータを挿入します。id は1から10、name は "insert" + i です。

         コード：

         for (int i = 1; i <= 10; i++) {
             userDao.insertUser(new User((long) i, "insert" + i));
         }
         

      4. データを削除します。

         userDao.deleteById メソッドを使用して、id が1のユーザーデータを削除します。

         コード：

           userDao.deleteById(1L);
         

      5. データを更新します。

         userDao.updateUser メソッドを使用して、id が2のユーザーデータを更新し、name を update に変更します。

         コード：

         userDao.updateUser(new User(2L, "update"));
         

      6. データをクエリします。

         userDao.selectUserById メソッドを使用して、id が2のユーザーデータをクエリし、結果を出力します。

         コード：

         User user = userDao.selectUserById(2L);
         System.out.println("user = " + user);
         

      7. 全データをクエリします。

         userDao.selectAllUsers メソッドを使用して、test_springboot テーブル内のすべてのユーザーデータをクエリし、結果を出力します。

         コード：

         List<User> userList = userDao.selectAllUsers();
         userList.forEach(System.out::println);
         

全コード表示

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.11</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.oceanbase</groupId>
    <artifactId>java-oceanbase-springboot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>java-oceanbase-springboot</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.oceanbase</groupId>
            <artifactId>oceanbase-client</artifactId>
            <version>2.4.3</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

  spring.datasource.driverClassName=com.oceanbase.jdbc.Driver
  spring.datasource.url=jdbc:oceanbase://host:port/schema_name?useSSL=false&useUnicode=true&characterEncoding=utf-8
  spring.datasource.username=user_name
  spring.datasource.password=******

package com.oceanbase.testspringboot.dao.impl;

import com.oceanbase.testspringboot.dao.UserDao;
import com.oceanbase.testspringboot.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository("userDao")
public class UserDaoImpl implements UserDao {
    @Autowired
    private JdbcTemplate jdbcTemplate; //Jdbc connection tool class

    @Override
    public boolean insertUser(User user) {
        String sql = "insert into test_springboot(id,name)values(?,?)";
        Object[] params = {user.getId(), user.getName()};
        return jdbcTemplate.update(sql, params) > 0;
    }

    @Override
    public boolean deleteById(Long id) {
        String sql = "delete from test_springboot where id=?";
        Object[] params = {id};
        return jdbcTemplate.update(sql, params) > 0;
    }

    @Override
    public boolean updateUser(User user) {
        String sql = "update test_springboot set name=? where id=?";
        Object[] params = {user.getName(), user.getId()};
        return jdbcTemplate.update(sql, params) > 0;
    }

    @Override
    public User selectUserById(Long id) {
        String sql = "select * from test_springboot where id=?";
        Object[] params = new Object[]{id};
        return jdbcTemplate.queryForObject(
                sql,
                params,
                new BeanPropertyRowMapper<>(User.class));
    }

    @Override
    public List<User> selectAllUsers() {
        String sql = "select * from test_springboot";
        return jdbcTemplate.query(sql, new BeanPropertyRowMapper<User>(User.class));
    }
}

package com.oceanbase.testspringboot.dao;

import com.oceanbase.testspringboot.entity.User;

import java.util.List;

public interface UserDao {
    boolean insertUser(User user);

    boolean deleteById(Long id);

    boolean updateUser(User user);

    User selectUserById(Long id);

    List<User> selectAllUsers();
}

package com.oceanbase.testspringboot.entity;

public class User {
    private Long id;
    private String name;

    public User() {
    }

    public User(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}

package com.oceanbase.testspringboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class TestSpringbootApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestSpringbootApplication.class, args);
    }
}

package com.oceanbase.testspringboot;

import com.oceanbase.testspringboot.dao.UserDao;
import com.oceanbase.testspringboot.entity.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.jdbc.core.JdbcTemplate;

import java.util.List;

@SpringBootTest
class TestSpringbootApplicationTests {
    @Autowired
    private UserDao userDao;
    @Autowired
    private JdbcTemplate jdbcTemplate; //Jdbc connection tool class

    @Test
    void contextLoads() {
        try {
            // Use the execute() method to execute SQL statements and delete the user table test_springboot
            jdbcTemplate.execute("drop table test_springboot");
            System.out.println("test_springboot delete successfully!");
        } catch (Exception ignore) {

        } finally {
            // Use the execute() method to execute SQL statements and create user table tests_ user
            jdbcTemplate.execute("create table test_springboot (" +
                    "id int primary key," +
                    "name varchar(50))");
            System.out.println("test_springboot create successfully!");
        }
        //UserDao userDao=new UserDaoImpl();

        //ApplicationContext ioc=new ApplicationContext("/appli");`
        //add
        for (int i = 1; i <= 10; i++) {
            userDao.insertUser(new User((long) i, "insert" + i));
        }
        //delete
        userDao.deleteById(1L);
        //update
        userDao.updateUser(new User(2L, "update"));
        //selectUserById
        User user = userDao.selectUserById(2L);
        System.out.println("user = " + user);
        //query all users
        List<User> userList = userDao.selectAllUsers();
        userList.forEach(System.out::println);
    }

}

関連ドキュメント

OceanBase Connector/Jの詳細については、OceanBase JDBCドライバをご参照ください。