C3P0 コネクションプールを使用して OceanBase データベースに接続するサンプルプログラム

本トピックでは、C3P0 コネクションプール、MySQL Connector/J、および OceanBase データベースを使用してアプリケーションを構築し、テーブルの作成、データの挿入、削除、更新、クエリなどの基本的なデータベース操作を実装する方法について説明します。

      c3p0-mysql-jdbc サンプルプロジェクトをダウンロード
  </a>
  <!-- <a role='video' href='https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/video-center/video/video/01%20c3p0-mysql-jdbc.mp4'>
      
      C3P0 コネクションプールを使用して OceanBase データベースに接続するサンプルプログラム（MySQLモード）
  </a> -->

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

• 対象の MySQL互換モード テナントの接続文字列を取得していること。詳細な操作については、接続文字列の取得をご参照ください。

• JDK 1.8 および Maven をインストールしていること。

• Eclipse をインストールしていること。

  説明

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

操作手順

<main id="notice" type='explain'>
<h4>説明</h4>
<p>本ドキュメントに記載されている手順は、Windows 環境で Eclipse IDE for Java Developers 2022-03 を使用してプロジェクトをコンパイルおよび実行する手順です。他のオペレーティングシステム環境やコンパイラを使用している場合、手順が若干異なる場合があります。</p>
</main>

操作手順 1：c3p0-mysql-jdbc プロジェクトを Eclipse にインポートする

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

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

   説明

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

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

操作手順 2：c3p0-mysql-jdbc プロジェクトのデータベース接続情報を変更する

前提条件で取得した接続文字列情報に基づいて、ファイル c3p0-mysql-jdbc/src/main/resources/c3p0-config.xml 内のデータベース接続情報を変更します。

例は次のとおりです：

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

コードは次のとおりです。

...
        <property name="jdbcUrl">jdbc:mysql://t5******.********.oceanbase.cloud:3306/test</property>
        <property name="user">test_user001</property>
        <property name="password">******</property>
...

操作手順 3：c3p0-mysql-jdbc プロジェクトを実行する

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

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

3. Eclipse のコンソールウィンドウで、プロジェクトのログ情報と出力結果を確認します。

4. OceanBase クライアント（OBClient）で次の SQL 文を実行して結果を確認することもできます。

   obclient [test]> SELECT * FROM test_c3p0;
   

   返される結果は次のとおりです。

   +------+--------------+
   | id   | name         |
   +------+--------------+
   |    5 | test_update  |
   |    6 | test_insert6 |
   |    7 | test_insert7 |
   |    8 | test_insert8 |
   |    9 | test_insert9 |
   +------+--------------+
   5 rows in set
   

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

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

解凍すると、c3p0-mysql-jdbc という名前のフォルダが作成されます。ディレクトリ構造は次のとおりです。

c3p0-mysql-jdbc
├── src
│   └── main
│       ├── java
│       │   └── com
│       │        └── example
│       │           └── Main.java
│       └── resources
│           └── c3p0-config.xml 
└── pom.xml

ファイルの説明：

• src：ソースコードのルートディレクトリ。
• main：メインコードディレクトリ。アプリケーションの主要なロジックが含まれます。
• java：Java ソースコードディレクトリ。
• com：Java パッケージディレクトリ。
• example：サンプルプロジェクトのパッケージディレクトリ。
• Main.java：メインクラス。テーブルの作成やデータの挿入などのロジックが含まれます。
• resources：リソースファイルディレクトリ。設定ファイルなどが含まれます。
• c3p0-config.xml：C3P0 コネクションプールの設定ファイル。
• 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> を使用して、プロジェクト名を testc3p0 に指定します。
   3. <version> を使用して、プロジェクトのバージョン番号を 1.0-SNAPSHOT に指定します。

   コードは次のとおりです。

       <groupId>com.example</groupId>
       <artifactId>testc3p0</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. プロジェクトが依存するコンポーネントを設定します。

   説明

   この部分のコードは、プロジェクトが依存するコンポーネントが MySQL Connector/J のバージョン 8.0.25 であることを定義しています。他のバージョンの情報については、MySQL Connector/J をご参照ください。

   <dependency> を使用して依存関係を定義します。

   • mysql-connector-java 依存ライブラリを追加します。
   1. <groupId> を使用して、依存関係が属する組織を mysql に指定します。
   2. <artifactId> を使用して、依存関係の名前を mysql-connector-java に指定します。
   3. <version> を使用して、依存関係のバージョン番号を 8.0.25 に指定します。
   • c3p0 依存ライブラリを追加します。
   1. <groupId> を使用して、依存関係が属する組織を com.mchange に指定します。
   2. <artifactId> を使用して、依存関係の名前を c3p0 に指定します。
   3. <version> を使用して、依存関係のバージョン番号を 0.9.5.5 に指定します。

   コードは次のとおりです：

       <dependencies>
           <dependency>
               <groupId>mysql</groupId>
               <artifactId>mysql-connector-java</artifactId>
               <version>8.0.25</version>
           </dependency>
           <dependency>
               <groupId>com.mchange</groupId>
               <artifactId>c3p0</artifactId>
               <version>0.9.5.5</version>
           </dependency>
       </dependencies>
   

c3p0-config.xml コードの紹介

c3p0-config.xml ファイルは C3P0 コネクションプールの設定ファイルであり、データベース接続に関連するプロパティを設定するために使用されます。各 <property> 要素の値を設定することで、データベースドライバ、接続 URL、ユーザー名、パスワード、コネクションプールサイズなどのプロパティを設定できます。

本ドキュメントの c3p0-config.xml ファイルのコードは、主に以下の部分で構成されています。

1. ファイル宣言文。

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

   コードは次のとおりです。

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

2. 基本情報を設定します。

   1. <c3p0-config> を使用して、c3p0 コネクションプールの設定情報を加えます。
   2. <named-config name="oceanbase"> を使用して、oceanbase という名前の構成を定義します。コード内でこの名前を使用して該当する構成を参照し、oceanbase データベースに関連する接続情報とコネクションプールのプロパティを取得できます。

   コードは次のとおりです。

   <c3p0-config>
       <named-config name="oceanbase">
   
            // 各<property>要素の値を設定
   
       </named-config>
   </c3p0-config>
   

3. データベースドライバを設定します。

   <property> を使用して、OceanBase データベースへの接続時に使用する MySQL JDBC ドライバのクラス名を com.mysql.cj.jdbc.Driver に指定します。

   説明

   MySQL Connector/J 実装クラスの名前情報については、Driver/Datasource Class Name をご参照ください。

   コードは次のとおりです。

           <property name="driverClass">com.mysql.cj.jdbc.Driver</property>
   

4. データベース接続情報を設定します。

   1. ホスト IP、ポート番号、アクセスするデータベース、URL パラメータなどの情報を含む、データベース接続の URL を設定します。
   2. データベースのユーザー名を設定します。
   3. データベースのパスワードを設定します。

   コードは次のとおりです。

        <property name="jdbcUrl">jdbc:mysql://$host:$port/$database_name</property>
        <property name="user">$user_name</property>
        <property name="password">$password</property>

**パラメータの説明：**

* `$host`：接続文字列の `-h` パラメータから取得した、OceanBase Cloud データベースの接続アドレス。
* `$port`：接続文字列の `-P` パラメータから取得した、OceanBase Cloud データベースの接続ポート。
* `$database_name`：接続文字列の `-D` パラメータから取得した、アクセスするデータベース名。
* `$user_name`：接続文字列の `-u` パラメータから取得した、アカウント名。
* `$password`：接続文字列の `-p` パラメータから取得した、アカウントのパスワード。

5. その他の c3p0 データベースコネクションプールのパラメータを設定します。

   1. コネクションプールが必要な場合に一度に増やす接続数を 20 に設定します。つまり、コネクションプール内の接続が不足した場合、毎回 20 個の接続を追加します。
   2. コネクションプールの初期サイズを 10 に設定します。つまり、コネクションプールは起動時に 10 個の接続を事前に作成します。
   3. コネクションプールの最小接続数を 5 に設定します。つまり、コネクションプール内で保持される最小接続数は 5 を下回りません。
   4. コネクションプールの最大接続数を 30 に設定します。つまり、コネクションプール内で許可される最大接続数は 30 を超えません。
   5. 各接続の最大キャッシュ文数を 0 に設定します。つまり、文をキャッシュしません。
   6. コネクションプール内の各接続の最大キャッシュ文数を 0 に設定します。つまり、各接続は文をキャッシュしません。
   7. c3p0 が使用する補助スレッド数を 3 に設定します。これらの補助スレッドは、低速な JDBC 操作を実行するために使用されます。
   8. c3p0 接続のプロパティチェックサイクルを 3 秒に設定します。つまり、3 秒ごとに接続のプロパティをチェックします。
   9. 接続取得のタイムアウト時間を 1000 ミリ秒に設定します。つまり、1000 ミリ秒以内に接続を取得できない場合、タイムアウト例外がスローされます。
   10. コネクションプール内のアイドル接続のチェックサイクルを 3 秒に設定します。つまり、3 秒ごとにアイドル接続の状態をチェックします。
   11. コネクションプール内の接続の最大アイドル時間を 10 秒に設定します。つまり、接続が 10 秒間使用されない場合、その接続は閉じられます。
   12. コネクションプール内で最大接続数を超えた接続の最大アイドル時間を 5 秒に設定します。つまり、接続が最大接続数を超え、かつ 5 秒以上アイドル状態にある場合、その接続は閉じられます。
   13. 接続取得試行時の再試行遅延時間を 1000 ミリ秒に設定します。つまり、接続の取得に失敗した場合、1000 ミリ秒後に再試行します。
   14. c3p0 の自動テストテーブルを Test に設定します。これは、接続が有効かどうかをテストするために使用される特別なテーブルです。
   15. コネクションプールに接続を返却する際に接続の有効性をテストするかどうかを設定します。true に設定すると、接続がコネクションプールに返却される際に接続の有効性テストが行われます。

   コードは次のとおりです。

          <property name="acquireIncrement">20</property>
          <property name="initialPoolSize">10</property>
          <property name="minPoolSize">5</property>
          <property name="maxPoolSize">30</property>
          <property name="maxStatements">0</property>
          <property name="maxStatementsPerConnection">0</property>
          <property name="numHelperThreads">3</property>
          <property name="propertyCycle">3</property>
          <property name="checkoutTimeout">1000</property>
          <property name="idleConnectionTestPeriod">3</property>
          <property name="maxIdleTime">10</property>
          <property name="maxIdleTimeExcessConnections">5</property>
          <property name="acquireRetryDelay">1000</property>
          <property name="automaticTestTable">Test</property>
          <property name="testConnectionOnCheckin">true</property>
   

C3P0 コネクションプールの一般的なパラメータ:

   </td>

Main.java コードの紹介

Main.java ファイルはサンプルプログラムの一部であり、c3p0 コネクションプールを介してデータベース接続を取得し、トランザクション内でテーブルの作成、データの挿入、データの削除、データの更新、データのクエリなどの一連のデータベース操作を実行し、クエリ結果を出力する方法を示します。これは、c3p0 コネクションプールを使用してデータベース接続を管理し、トランザクション操作を実行して、データベース操作の効率とパフォーマンスを向上させる方法を示しています。

本トピックの Main.java ファイルのコードは、主に以下の部分で構成されています。

1. パッケージを定義し、java.sql のインターフェースをインポートします。

   1. 現在のコードが属するパッケージ名を com.example として宣言します。
   2. データベース接続を表すために使用される java.sql.Connection クラスをインポートします。
   3. プリコンパイルされたデータベース操作を実行するために使用される java.sql.PreparedStatement クラスをインポートします。
   4. データベースクエリ結果セットを表すために使用される java.sql.ResultSet クラスをインポートします。
   5. c3p0 コネクションプールを使用するために com.mchange.v2.c3p0.ComboPooledDataSource クラスをインポートします。

   コードは次のとおりです。

   package com.example;
   
   import java.sql.Connection;
   import java.sql.PreparedStatement;
   import java.sql.ResultSet;
   import com.mchange.v2.c3p0.ComboPooledDataSource;
   

2. クラス名とメソッドを定義します。

   1. プログラムのエントリポイントとして、Main という名前のパブリッククラスを定義します。クラス名はファイル名と一致している必要があります。
   2. プログラムの実行開始点として、パブリック静的メソッド main を定義します。
   3. try-with-resources 文を使用して、データベース接続を取得し、プリコンパイルされた SQL 文を作成します。
   4. データベーストランザクション操作。
   5. 発生する可能性のある例外をキャッチし、例外スタック情報を出力します。
   6. c3p0 コネクションプールからデータベース接続を取得するためのプライベート静的メソッド getConnection を定義します。メソッド内で、まず ComboPooledDataSource オブジェクト cpds を作成します。このオブジェクトは、パラメータ oceanbase を介してコネクションプールの設定を指定します。次に、cpds.getConnection() メソッドを使用してコネクションプールからデータベース接続を取得し、それを返します。

   コードは次のとおりです。

   public class Main {
   
       public static void main(String[] args) {
           try (
               //データベース接続を取得します
               // プリコンパイルされた SQL 文を作成します
               ) {
   
               // データベーストランザクション操作：トランザクションの開始、テーブルの作成、データの挿入、データの削除、データの更新、データのクエリ、およびトランザクションのコミット
   
           } catch (Exception e) {
               e.printStackTrace();
           }
           }
   
       private static Connection getConnection() throws Exception {
           ComboPooledDataSource cpds = new ComboPooledDataSource("oceanbase");
           return cpds.getConnection();
           }
           }
   

3. データベース接続を取得します。

   データベース接続を取得し、それを conn 変数に代入します。

   コードは次のとおりです。

                Connection conn = getConnection();
   

4. プリコンパイルされた SQL 文を作成します。

   1. test_c3p0 という名前のデータベーステーブルを作成するためのプリコンパイルされた SQL 文を作成します。
   2. test_c3p0 テーブルにデータを挿入するためのプリコンパイルされた SQL 文を作成します。
   3. test_c3p0 テーブルからデータを削除するためのプリコンパイルされた SQL 文を作成します。
   4. test_c3p0 テーブル内のデータを更新するためのプリコンパイルされた SQL 文を作成します。
   5. test_c3p0 テーブルからデータをクエリするためのプリコンパイルされた SQL 文を作成します。

   コードは次のとおりです。

                PreparedStatement stmtCreate = conn.prepareStatement("CREATE TABLE test_c3p0 (id INT, name VARCHAR(32))");
                PreparedStatement stmtInsert = conn.prepareStatement("INSERT INTO test_c3p0 VALUES (?, ?)");
                PreparedStatement stmtDelete = conn.prepareStatement("DELETE FROM test_c3p0 WHERE id < ?");
                PreparedStatement stmtUpdate = conn.prepareStatement("UPDATE test_c3p0 SET name = ? WHERE id = ?");
                PreparedStatement stmtSelect = conn.prepareStatement("SELECT * FROM test_c3p0")
   

5. トランザクションを開始します。

   データベース接続の自動コミットを false に設定し、トランザクションメカニズムを有効にします。

   コードは次のとおりです。

               conn.setAutoCommit(false); 
   

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

   テーブル作成の SQL 文を実行します。

   コードは次のとおりです。

               stmtCreate.execute();
   

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

   for ループを使用して test_c3p0 テーブルに 10 件のデータを挿入します。最初の列の値は変数 i の値であり、2 番目の列の値は文字列 test_insert の後に変数 i の値を追加したものです。

   コードは次のとおりです。

               for (int i = 0; i < 10; i++) {
                   stmtInsert.setInt(1, i);
                   stmtInsert.setString(2, "test_insert" + i);
                   stmtInsert.executeUpdate();
               }
   

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

   削除文のパラメータを 5 に設定し、削除操作を実行します。

   コードは次のとおりです。

               stmtDelete.setInt(1, 5);
               stmtDelete.executeUpdate();
   

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

   更新文の最初のパラメータを test_update に、2 番目のパラメータを 5 に設定し、更新操作を実行します。

   コードは次のとおりです。

               stmtUpdate.setString(1, "test_update");
               stmtUpdate.setInt(2, 5);
               stmtUpdate.executeUpdate();
   

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

    1. クエリ文を実行し、クエリ結果を ResultSet オブジェクト rs に保存します。
    2. while ループを使用し、rs.next() を介して結果セットに次の行のデータがあるかどうかを判断します。ある場合は、ループ内のコードを実行します。
    3. ループ内のコードは、各行のデータの id 列と name 列の値を出力します。
    4. 結果セットを閉じ、関連するリソースを解放します。

    コードは次のとおりです。

                ResultSet rs = stmtSelect.executeQuery();
                while (rs.next()) {
                    System.out.println(rs.getInt("id") + "   " + rs.getString("name"));
                }
                rs.close();
    

11. トランザクションをコミットします。

    コードは次のとおりです。

                conn.commit(); 
    

完全なコードの表示

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

<groupId>com.oceanbase</groupId>
<artifactId>testc3p0</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>8.0.25</version>
    </dependency>
    <dependency>
        <groupId>com.mchange</groupId>
        <artifactId>c3p0</artifactId>
        <version>0.9.5.5</version>
    </dependency>
</dependencies>

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

```java
package com.example;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import com.mchange.v2.c3p0.ComboPooledDataSource;

public static void main(String[] args) {
    try (Connection conn = getConnection();

         PreparedStatement stmtCreate = conn.prepareStatement("CREATE TABLE test_c3p0 (id INT, name VARCHAR(32))");
         PreparedStatement stmtInsert = conn.prepareStatement("INSERT INTO test_c3p0 VALUES (?, ?)");
         PreparedStatement stmtDelete = conn.prepareStatement("DELETE FROM test_c3p0 WHERE id < ?");
         PreparedStatement stmtUpdate = conn.prepareStatement("UPDATE test_c3p0 SET name = ? WHERE id = ?");
         PreparedStatement stmtSelect = conn.prepareStatement("SELECT * FROM test_c3p0")) {
        
        // Begin transaction
        conn.setAutoCommit(false); 

        // Create table
        stmtCreate.execute();

        // Insert data
        for (int i = 0; i < 10; i++) {
            stmtInsert.setInt(1, i);
            stmtInsert.setString(2, "test_insert" + i);
            stmtInsert.executeUpdate();
        }

        // Delete data
        stmtDelete.setInt(1, 5);
        stmtDelete.executeUpdate();

        // Update data
        stmtUpdate.setString(1, "test_update");
        stmtUpdate.setInt(2, 5);
        stmtUpdate.executeUpdate();

        // Query data
        ResultSet rs = stmtSelect.executeQuery();
        while (rs.next()) {
            System.out.println(rs.getInt("id") + "   " + rs.getString("name"));
        }
        rs.close();
        
        // Commit transaction
        conn.commit(); 
        
    } catch (Exception e) {
        e.printStackTrace();
    }
}

private static Connection getConnection() throws Exception {
    ComboPooledDataSource cpds = new ComboPooledDataSource("oceanbase");
    return cpds.getConnection();
}

関連情報

MySQL Connector/J の詳細については、MySQL Connector/Jの概要 をご参照ください。