Commons Pool による OceanBase データベース接続サンプルプログラム

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

commonpool-mysql-client サンプルプロジェクトをダウンロード

前提条件

• OceanBaseデータベースをインストールし、MySQLテナントを作成していること。

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

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

  説明

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

手順

1. commonpool-mysql-client プロジェクトをEclipseにインポートします。
2. OceanBaseデータベースのURLを取得します。
3. commonpool-mysql-client プロジェクト内のデータベース接続情報を修正します。
4. commonpool-mysql-client プロジェクトを実行します。

ステップ１：commonpool-mysql-clientプロジェクトをEclipseにインポートする

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

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

   説明

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

   

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

   

ステップ2：OceanBaseデータベースのURLを取得する

1. OceanBaseデータベースのデプロイ担当者または管理者から、該当するデータベース接続文字列を取得します。

   例：

   obclient -hxxx.xxx.xxx.xxx -P2881 -utest_user001@mysql001 -p****** -Dtest
   

   接続文字列の詳細については、OBClientを使用してOceanBaseテナントに接続するを参照してください。

2. OceanBaseデータベースの接続文字列情報に基づいて、以下のURLの対応する情報を入力します。

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

   パラメータ説明：

   • $host：OceanBaseデータベースへの接続IPアドレス。OceanBaseデータベースプロキシ(OceanBase Database Proxy、ODP)接続方式ではODPアドレスを使用し、直接接続方式ではOBServerノードのIPアドレスを使用します。

   • $port：OceanBaseデータベースへの接続ポート。ODP接続方式のデフォルトポートは2883で、ODPデプロイ時にカスタマイズ可能です。直接接続方式のデフォルトポートは2881で、OceanBaseデータベースのデプロイ時にカスタマイズ可能です。

   • $database_name：アクセスするデータベース名。

     注意

     テナントに接続するユーザーには、データベースに対する CREATE、DROP、INSERT、DELETE、UPDATE および SELECT 権限が付与されていなければなりません。ユーザー権限の詳細については、MySQLモードの権限分類を参照してください。

   • user_name：テナントの接続アカウント。ODP接続の一般的な形式：ユーザー名@テナント名#クラスタ名またはクラスタ名:テナント名:ユーザー名。直接接続方式の形式：ユーザー名@テナント名。

   • password：アカウントのパスワード。

   MySQL Connector/J接続プロパティの詳細については、Configuration Propertiesを参照してください。

   例：

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

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

ステップ2：OceanBaseデータベースのURLを取得するで取得した情報に基づいて、ファイルcommonpool-mysql-client/src/main/resources/db.properties内のデータベース接続情報を修正します。

例：

• OBServerノードのIPアドレスはxxx.xxx.xxx.xxxです。
• アクセスポートは2881を使用します。
• アクセスするデータベース名はtestです。
• テナントの接続アカウントはtest_user001@mysql001です。mysql001はOceanBaseデータベースで作成されたMySQLモードのユーザーテナントであり、test_user001はテナントmysql001のユーザー名です。
• パスワードは******です。

コード：

...
db.url=jdbc:mysql://xxx.xxx.xxx.xxx:2881/test?useSSL=false
db.username=test_user001@mysql001
db.password=******
...

ステップ4：commonpool-mysql-clientプロジェクトを実行する

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

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

   

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

   

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

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

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

commonpool-mysql-client
├── src
│   └── main
│       ├── java
│       │   └── com
│       │       └── example
│       │           └── Main.java
│       └── resources
│           └── db.properties
└── pom.xml

ファイルの説明：

• src：ソースコードのルートディレクトリです。
• main：アプリケーションの主要なロジックを含むメインコードディレクトリです。
• java：Javaソースコードディレクトリです。
• com：Javaパッケージディレクトリです。
• example：サンプルプロジェクトのパッケージディレクトリです。
• Main.java：テーブルの作成、データの挿入、削除、更新、クエリなどのロジック処理を含むメインクラスプログラムのサンプルファイルです。
• resources：設定ファイルなどを含むリソースファイルディレクトリです。
• db.properties：データベース接続に関するパラメータを含む接続プールの設定ファイルです。
• 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>を使用して、プロジェクトの名前をcommonpool-mysql-clientと指定します。
   3. <version>を使用して、プロジェクトのバージョン番号を1.0-SNAPSHOTと指定します。

   コード：

       <groupId>com.example</groupId>
       <artifactId>commonpool-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依存ライブラリを追加します：

      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. プロジェクトでこのライブラリの機能とクラスを使用できるように、commons-pool2依存ライブラリを追加します：

      1. <groupId>を使用して、依存関係が属する組織をorg.apache.commonsと指定します。
      2. <artifactId>を使用して、依存関係の名前をcommons-pool2と指定します。
      3. <version>を使用して、依存関係のバージョン番号を2.7.0と指定します。

      コード：

              <dependency>
                  <groupId>org.apache.commons</groupId>
                  <artifactId>commons-pool2</artifactId>
                  <version>2.7.0</version>
              </dependency>
      

db.propertiesコードの紹介

db.properties は本記事の例となる接続プールの設定ファイルであり、接続プールの設定プロパティが含まれています。これらのプロパティには、データベースURL、ユーザー名、パスワード、接続プールのその他のオプションが含まれます。

本記事の db.properties ファイルのコードは、主に以下の部分で構成されています：

1. データベース接続パラメータの設定。

   1. データベース接続のURLを設定します。これには、ホストIPアドレス、ポート番号、アクセスするデータベースが含まれます。
   2. データベースのユーザー名を設定します。
   3. データベースのパスワードを設定します。

   コード：

   db.url=jdbc:mysql://$host:$port/$database_name?useSSL=false
   db.username=$user_name
   db.password=$password
   

   パラメータの説明：

   • $host：OceanBaseデータベースへの接続IPアドレス。ODP接続方式ではODPアドレスを使用し、直接接続方式ではOBServerノードのIPアドレスを使用します。
   • $port：OceanBaseデータベースへの接続ポート。ODP接続方式のデフォルトポートは 2883 で、ODPデプロイ時にカスタマイズ可能です。直接接続方式のデフォルトポートは 2881 で、OceanBaseデータベースのデプロイ時にカスタマイズ可能です。
   • $database_name：アクセスするデータベース名。
   • $user_name：テナントの接続アカウント。ODP接続の一般的な形式：ユーザー名@テナント名#クラスタ名 または クラスタ名:テナント名:ユーザー名。直接接続方式の形式：ユーザー名@テナント名。
   • $password：アカウントのパスワード。

2. その他の接続プールパラメータの設定。

   1. 接続プールの最大接続数を10に設定します。これは、接続プール内に同時に最大10個の接続を持つことができることを意味します。
   2. 接続プールの最大アイドル接続数を5に設定します。接続プール内の接続数が最大アイドル接続数を超えると、余分な接続は閉じられます。
   3. 接続プールの最小アイドル接続数を2に設定します。接続プール内で使用されている接続がない場合でも、少なくとも2つのアイドル接続が維持されます。
   4. 接続プールから接続を取得するための最大待機時間を5000ミリ秒に設定します。接続プール内に利用可能な接続がない場合、接続を取得する操作は最大待機時間を超えるまで待機します。

   コード：

   pool.maxTotal=10
   pool.maxIdle=5
   pool.minIdle=2
   pool.maxWaitMillis=5000
   

Commons Pool 2のよく使われる設定パラメータ：

Main.javaのコード紹介

Main.java ファイルはサンプルプログラムの一部であり、Commons Pool 2を使用してデータベース操作を実行する方法を示すコードです。本記事の Main.java ファイルのコードは、主に以下の部分で構成されています：

1. パッケージの定義と必要なクラスのインポート。

   1. 現在のコードが属するパッケージ名を com.example と宣言します。
   2. java.io.IOException クラスをインポートします。これは入出力例外を処理するために使用されます。
   3. java.sql.Connection クラスをインポートします。これはデータベースへの接続を表します。このオブジェクトを使用してSQLステートメントを実行し、結果を取得できます。
   4. java.sql.DriverManager クラスをインポートします。これはドライバのロードとデータベース接続の確立を管理するために使用されます。このクラスを使用してデータベース接続を取得できます。
   5. java.sql.ResultSet クラスをインポートします。これはSQLクエリの結果セットを表します。このオブジェクトを使用してクエリ結果を走査および操作できます。
   6. java.sql.SQLException クラスをインポートします。これはSQLステートメント関連の例外状況を処理するために使用されます。
   7. java.sql.Statement クラスをインポートします。これはSQLステートメントを実行するオブジェクトです。Connection オブジェクトの createStatement メソッドを使用して作成できます。
   8. java.util.Properties クラスをインポートします。これはキーと値のペアのコレクションであり、設定情報の読み込みと保存に使用されます。設定ファイルからデータベースの接続情報を読み込むことができます。
   9. org.apache.commons.pool2.ObjectPool クラスをインポートします。これはオブジェクトプールのインターフェースであり、オブジェクトの取得や返却など、プール化されたオブジェクトの基本的な操作を定義しています。
   10. org.apache.commons.pool2.PoolUtils クラスをインポートします。これはオブジェクトプールを操作しやすくするためのいくつかのツールメソッドを提供します。
   11. org.apache.commons.pool2.PooledObject クラスをインポートします。これはオブジェクトプール管理を実装したラッピングオブジェクトです。このインターフェースを実装することで、プール化されたオブジェクトのライフサイクルを管理できます。
   12. org.apache.commons.pool2.impl.GenericObjectPool クラスをインポートします。これは ObjectPool インターフェースのデフォルト実装クラスであり、接続プールの基本機能を実装しています。
   13. org.apache.commons.pool2.impl.GenericObjectPoolConfig クラスをインポートします。これは GenericObjectPool の設定クラスであり、接続プールのプロパティを設定するために使用されます。
   14. org.apache.commons.pool2.impl.DefaultPooledObject クラスをインポートします。これは PooledObject インターフェースのデフォルト実装クラスであり、プール化されたオブジェクトのラッピングを管理するために使用されます。実際の接続オブジェクトやその他の管理情報を含むことができます。

   コード：

   package com.example;
   
   import java.io.IOException;
   import java.sql.Connection;
   import java.sql.DriverManager;
   import java.sql.ResultSet;
   import java.sql.SQLException;
   import java.sql.Statement;
   import java.util.Properties;
   
   import org.apache.commons.pool2.ObjectPool;
   import org.apache.commons.pool2.PoolUtils;
   import org.apache.commons.pool2.PooledObject;
   import org.apache.commons.pool2.impl.GenericObjectPool;
   import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
   import org.apache.commons.pool2.impl.DefaultPooledObject;
   

2. Main クラスを作成し、main メソッドを定義します。

   Main クラスと main メソッドを定義します。main メソッドは、接続プールを使用してデータベースから一連の操作を実行する方法を示すために使用されます。具体的な手順は以下のとおりです：

   1. プログラムのエントリポイントとして、Main という名前のpublicクラスを定義します。クラス名はファイル名と一致させる必要があります。

   2. プログラムの実行開始点として、public staticメソッド main を定義します。

      1. データベース設定ファイルの読み込み：

         1. データベース設定情報を格納するための Properties オブジェクトを作成します。
         2. Mainクラスのクラスローダを使用して、db.properties リソースファイルの入力ストリームを取得し、Properties オブジェクトの load() メソッドを使用してこの入力ストリームを読み込み、プロパティファイル内のキーと値のペアを props オブジェクトにロードします。
         3. スローされる可能性のある IOException 例外をキャッチし、例外スタック情報を出力します。

      2. データベース接続プールの設定の作成：

         1. 接続プールの動作を設定するためのジェネリックオブジェクトプール設定オブジェクトを作成します。
         2. 接続プールで許可される最大接続数を設定します。
         3. 接続プールで許容される最大アイドル接続数を設定します。
         4. 接続プールで許容される最小アイドル接続数を設定します。
         5. 接続取得の最大待機時間を設定します。

      3. データベース接続プールの作成：スレッドセーフな接続プールオブジェクト connectionPool を作成し、ConnectionFactory オブジェクトと poolConfig 設定オブジェクトを使用してジェネリックオブジェクトプールを作成し、それをスレッドセーフなオブジェクトプールでラッピングします。接続プールをスレッドセーフにラッピングすることで、マルチスレッド環境における接続の取得と解放操作の安全性を確保できます。

      4. データベース接続の取得：接続プールの borrowObject() メソッドを使用してデータベース接続を取得し、try コードブロック内でその接続を使用してデータベース操作を実行します。

         1. createTable() メソッドを呼び出してテーブルを作成します。
         2. insertData() メソッドを呼び出してデータを挿入します。
         3. selectData() メソッドを呼び出してデータをクエリします。
         4. updateData() メソッドを呼び出してデータを更新します。
         5. 再度 selectData() メソッドを呼び出して、更新後のデータをクエリします。
         6. deleteData() メソッドを呼び出してデータを削除します。
         7. 再度 selectData() メソッドを呼び出して、削除後のデータをクエリします。
         8. dropTable() メソッドを呼び出してテーブルを削除します。
         9. 例外が発生した場合はキャッチして出力します。

   3. その他のデータベース操作メソッドを定義します。

   コード：

   public class Main {
   
       public static void main(String[] args) {
           // Load the database configuration file
           Properties props = new Properties();
           try {
               props.load(Main.class.getClassLoader().getResourceAsStream("db.properties"));
           } catch (IOException e) {
               e.printStackTrace();
           }
   
           // Create the database connection pool configuration
           GenericObjectPoolConfig<Connection> poolConfig = new GenericObjectPoolConfig<>();
           poolConfig.setMaxTotal(Integer.parseInt(props.getProperty("pool.maxTotal")));
           poolConfig.setMaxIdle(Integer.parseInt(props.getProperty("pool.maxIdle")));
           poolConfig.setMinIdle(Integer.parseInt(props.getProperty("pool.minIdle")));
           poolConfig.setMaxWaitMillis(Long.parseLong(props.getProperty("pool.maxWaitMillis")));
   
           // Create the database connection pool
           ObjectPool<Connection> connectionPool = PoolUtils.synchronizedPool(new GenericObjectPool<>(new ConnectionFactory(
                   props.getProperty("db.url"), props.getProperty("db.username"), props.getProperty("db.password")), poolConfig));
   
           // Get a database connection
           try (Connection connection = connectionPool.borrowObject()) {
   
               // Create table
               createTable(connection);
   
               // Insert data
               insertData(connection);
               // Query data
               selectData(connection);
   
               // Update data
               updateData(connection);
               // Query the updated data
               selectData(connection);
   
               // Delete data
               deleteData(connection);
               // Query the data after deletion
   
               selectData(connection);
   
               // Drop table
               dropTable(connection);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   
       // テーブルを作成するためのメソッドを定義します。
       // データを挿入するためのメソッドを定義します。
       // データを更新するためのメソッドを定義します。
       // データを削除するためのメソッドを定義します。
       // データをクエリするためのメソッドを定義します。
       // テーブルを削除するためのメソッドを定義します。
       // ConnectionFactoryクラスを定義します。
   }
   

3. テーブルを作成するためのメソッドを定義します。

   createTable という名前のメソッドを定義し、Connection オブジェクトをパラメータとして受け取ります。具体的な手順は以下のとおりです：

   1. プライベート静的メソッド createTable() を定義します。このメソッドは Connection オブジェクトをパラメータとして受け取り、SQLException 例外をスローする可能性があることを宣言します。
   2. 接続の createStatement() メソッドを使用して Statement オブジェクトを作成し、try-with-resources ステートメント内でこのオブジェクトを使用してデータベース操作を実行します。
   3. 文字列変数 sql を定義し、テーブル作成のSQLステートメントを格納します。
   4. Statement オブジェクトの executeUpdate() メソッドを使用して sql ステートメントを実行し、テーブルを作成します。
   5. コンソールにテーブル作成成功のメッセージを出力します。

   コード：

       private static void createTable(Connection connection) throws SQLException {
           try (Statement statement = connection.createStatement()) {
               String sql = "CREATE TABLE test_commonpool (id INT,name VARCHAR(20))";
               statement.executeUpdate(sql);
               System.out.println("Table created successfully.");
           }
       }
   

4. データを挿入するためのメソッドを定義します。

   insertData() という名前のメソッドを定義し、Connection オブジェクトをパラメータとして受け取ります。具体的な手順は以下のとおりです：

   1. プライベート静的メソッド insertData() を定義します。このメソッドは Connection オブジェクトをパラメータとして受け取り、SQLException 例外をスローする可能性があることを宣言します。
   2. 接続の createStatement() メソッドを使用して Statement オブジェクトを作成し、try-with-resources ステートメント内でこのオブジェクトを使用してデータベース操作を実行します。
   3. 文字列変数 sql を定義し、データ挿入のSQLステートメントを格納します。
   4. Statement オブジェクトの executeUpdate() メソッドを使用して sql ステートメントを実行し、データを挿入します。
   5. コンソールにデータ挿入成功のメッセージを出力します。

   コード：

       private static void insertData(Connection connection) throws SQLException {
           try (Statement statement = connection.createStatement()) {
               String sql = "INSERT INTO test_commonpool (id, name) VALUES (1,'A1'), (2,'A2'), (3,'A3')";
               statement.executeUpdate(sql);
               System.out.println("Data inserted successfully.");
           }
       }
   

5. データを更新するためのメソッドを定義します。

   updateData() という名前のメソッドを定義し、Connection オブジェクトをパラメータとして受け取ります。具体的な手順は以下のとおりです：

   1. プライベート静的メソッド updateData() を定義します。このメソッドは Connection オブジェクトをパラメータとして受け取り、SQLException 例外をスローする可能性があることを宣言します。
   2. 接続の createStatement() メソッドを使用して Statement オブジェクトを作成し、try-with-resources ステートメント内でこのオブジェクトを使用してデータベース操作を実行します。
   3. 文字列変数 sql を定義し、データ更新のSQLステートメントを格納します。
   4. Statement オブジェクトの executeUpdate() メソッドを使用して sql ステートメントを実行し、データを更新します。
   5. コンソールにデータ更新成功のメッセージを出力します。

   コード：

       private static void updateData(Connection connection) throws SQLException {
           try (Statement statement = connection.createStatement()) {
               String sql = "UPDATE test_commonpool SET name = 'A11' WHERE id = 1";
               statement.executeUpdate(sql);
               System.out.println("Data updated successfully.");
           }
       }
   

6. データを削除するためのメソッドを定義します。

   deleteData() という名前のメソッドを定義し、Connection オブジェクトをパラメータとして受け取ります。具体的な手順は以下のとおりです：

   1. プライベート静的メソッド deleteData() を定義します。このメソッドは Connection オブジェクトをパラメータとして受け取り、SQLException 例外をスローする可能性があることを宣言します。
   2. 接続の createStatement() メソッドを使用して Statement オブジェクトを作成し、try-with-resources ステートメント内でこのオブジェクトを使用してデータベース操作を実行します。
   3. 文字列変数 sql を定義し、データ削除のSQLステートメントを格納します。
   4. Statement オブジェクトの executeUpdate() メソッドを使用して sql ステートメントを実行し、データを削除します。
   5. コンソールにデータ削除成功のメッセージを出力します。

   コード：

       private static void deleteData(Connection connection) throws SQLException {
           try (Statement statement = connection.createStatement()) {
               String sql = "DELETE FROM test_commonpool WHERE id = 2";
               statement.executeUpdate(sql);
               System.out.println("Data deleted successfully.");
           }
       }
   

7. データをクエリするためのメソッドを定義します。

   selectData() という名前のメソッドを定義し、Connection オブジェクトをパラメータとして受け取ります。具体的な手順は以下のとおりです：

   1. プライベート静的メソッド selectData() を定義します。このメソッドは Connection オブジェクトをパラメータとして受け取り、SQLException 例外をスローする可能性があることを宣言します。
   2. 接続の createStatement() メソッドを使用して Statement オブジェクトを作成し、try-with-resources ステートメント内でこのオブジェクトを使用してデータベース操作を実行します。
   3. 文字列変数 sql を定義し、データクエリのSQLステートメントを格納します。
   4. Statement オブジェクトの executeQuery() メソッドを使用して sql ステートメントを実行し、結果を ResultSet オブジェクトに格納します。
   5. resultSet.next() メソッドを使用して次の行のデータがあるかどうかを判断し、ループに入ります。
   6. resultSet.getInt() メソッドを使用して、データの列名をパラメータとして指定し、現在の行の整数データを取得します。
   7. resultSet.getString() メソッドを使用して、データの列名をパラメータとして指定し、現在の行の文字列データを取得します。
   8. コンソールに現在の行のデータを出力します。

   コード：

       private static void selectData(Connection connection) throws SQLException {
           try (Statement statement = connection.createStatement()) {
               String sql = "SELECT * FROM test_commonpool";
               ResultSet resultSet = statement.executeQuery(sql);
               while (resultSet.next()) {
                   int id = resultSet.getInt("id");
                   String name = resultSet.getString("name");
                   System.out.println("id: " + id + ", name: " + name);
               }
           }
       }
   

8. テーブルを削除するためのメソッドを定義します。

   dropTable() という名前のメソッドを定義し、Connection オブジェクトをパラメータとして受け取ります。具体的な手順は以下のとおりです：

   1. プライベート静的メソッド dropTable() を定義します。このメソッドは Connection オブジェクトをパラメータとして受け取り、SQLException 例外をスローする可能性があることを宣言します。
   2. 接続の createStatement() メソッドを使用して Statement オブジェクトを作成し、try-with-resources ステートメント内でこのオブジェクトを使用してデータベース操作を実行します。
   3. 文字列変数 sql を定義し、テーブル削除のSQLステートメントを格納します。
   4. Statement オブジェクトの executeUpdate() メソッドを使用して sql ステートメントを実行し、テーブルを削除します。
   5. コンソールにテーブル削除成功のメッセージを出力します。

   コード：

       private static void dropTable(Connection connection) throws SQLException {
           try (Statement statement = connection.createStatement()) {
               String sql = "DROP TABLE test_commonpool";
               statement.executeUpdate(sql);
               System.out.println("Table dropped successfully.");
           }
       }
   

9. ConnectionFactory クラスを定義します。

   ConnectionFactory という名前の静的インナークラスを定義します。このクラスは BasePooledObjectFactory クラスを継承し、接続オブジェクトの作成と管理を行うメソッドを実装しています。具体的な手順は以下のとおりです：

   説明

   @Override はアノテーションであり、以下のメソッドが親クラスのメソッドをオーバーライドしていることを示します。

   1. ConnectionFactory という名前の静的インナークラスを定義します。このクラスは org.apache.commons.pool2.BasePooledObjectFactory<Connection> を継承し、接続オブジェクトを作成および管理するためのファクトリクラスとして使用されます。
   2. データベースのURLを格納するためのプライベートで不変な文字列変数を定義します。
   3. データベースに接続するためのユーザー名を格納するためのプライベートで不変な文字列変数を定義します。
   4. データベースに接続するためのパスワードを格納するためのプライベートで不変な文字列変数を定義します。
   5. ConnectionFactory クラスのコンストラクタを定義します。このコンストラクタは、クラスのメンバー変数 url、username、password を初期化するために使用されます。コンストラクタはデータベースのURL、データベース接続用のユーザー名、パスワードという3つのパラメータを受け取り、それぞれの値を対応するメンバー変数に代入します。これにより、ConnectionFactory オブジェクトを作成する際に、コンストラクタを通じてデータベース関連情報を渡すことができます。
   6. BasePooledObjectFactory クラスの create() メソッドをオーバーライドし、新しい接続オブジェクトを作成するために使用します。
   7. DriverManager クラスの getConnection() メソッドを使用して接続オブジェクトを作成し、返します。
   8. BasePooledObjectFactory クラスの destroyObject() メソッドをオーバーライドし、接続オブジェクトを破棄するために使用します。
   9. 接続オブジェクトの close() メソッドを呼び出して接続を閉じます。
   10. BasePooledObjectFactory クラスの validateObject() メソッドをオーバーライドし、接続オブジェクトの有効性を検証するために使用します。
   11. 接続オブジェクトの isValid() メソッドを呼び出して接続が有効かどうかを確認し、タイムアウト時間を5000ミリ秒に設定します。
   12. BasePooledObjectFactory クラスの wrap() メソッドをオーバーライドし、接続オブジェクトを PooledObject オブジェクトにラッピングするために使用します。
   13. DefaultPooledObject クラスのコンストラクタを使用して PooledObject オブジェクトを作成し、接続オブジェクトをパラメータとして渡します。

   コード：

   static class ConnectionFactory extends org.apache.commons.pool2.BasePooledObjectFactory<Connection> {
           private final String url;
           private final String username;
           private final String password;
   
           public ConnectionFactory(String url, String username, String password) {
               this.url = url;
               this.username = username;
               this.password = password;
           }
   
           @Override
           public Connection create() throws Exception {
               return DriverManager.getConnection(url, username, password);
           }
   
           @Override
           public void destroyObject(org.apache.commons.pool2.PooledObject<Connection> p) throws Exception {
               p.getObject().close();
           }
   
           @Override
           public boolean validateObject(org.apache.commons.pool2.PooledObject<Connection> p) {
               try {
                   return p.getObject().isValid(5000);
               } catch (SQLException e) {
                   return false;
               }
           }
   
           @Override
           public PooledObject<Connection> wrap(Connection connection) {
               return new DefaultPooledObject<>(connection);
           }
       }
   

全コード表示

<?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>commonpool-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.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.7.0</version>
        </dependency>
    </dependencies>
</project>

# Database Configuration
db.url=jdbc:mysql://$host:$port/$database_name?useSSL=false
db.username=$user_name
db.password=$password

# Connection Pool Configuration
pool.maxTotal=10
pool.maxIdle=5
pool.minIdle=2
pool.maxWaitMillis=5000

package com.example;

import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Properties;

import org.apache.commons.pool2.ObjectPool;
import org.apache.commons.pool2.PoolUtils;
import org.apache.commons.pool2.PooledObject;
import org.apache.commons.pool2.impl.GenericObjectPool;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.apache.commons.pool2.impl.DefaultPooledObject;

public class Main {

    public static void main(String[] args) {
        // Load the database configuration file
        Properties props = new Properties();
        try {
            props.load(Main.class.getClassLoader().getResourceAsStream("db.properties"));
        } catch (IOException e) {
            e.printStackTrace();
        }

        // Create the database connection pool configuration
        GenericObjectPoolConfig<Connection> poolConfig = new GenericObjectPoolConfig<>();
        poolConfig.setMaxTotal(Integer.parseInt(props.getProperty("pool.maxTotal")));
        poolConfig.setMaxIdle(Integer.parseInt(props.getProperty("pool.maxIdle")));
        poolConfig.setMinIdle(Integer.parseInt(props.getProperty("pool.minIdle")));
        poolConfig.setMaxWaitMillis(Long.parseLong(props.getProperty("pool.maxWaitMillis")));

        // Create the database connection pool
        ObjectPool<Connection> connectionPool = PoolUtils.synchronizedPool(new GenericObjectPool<>(new ConnectionFactory(
                props.getProperty("db.url"), props.getProperty("db.username"), props.getProperty("db.password")), poolConfig));

        // Get a database connection
        try (Connection connection = connectionPool.borrowObject()) {

            // Create table
            createTable(connection);

            // Insert data
            insertData(connection);
            // Query data
            selectData(connection);

            // Update data
            updateData(connection);
            // Query the updated data
            selectData(connection);

            // Delete data
            deleteData(connection);
            // Query the data after deletion
            selectData(connection);

            // Drop table
            dropTable(connection);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static void createTable(Connection connection) throws SQLException {
        try (Statement statement = connection.createStatement()) {
            String sql = "CREATE TABLE test_commonpool (id INT,name VARCHAR(20))";
            statement.executeUpdate(sql);
            System.out.println("Table created successfully.");
        }
    }

    private static void insertData(Connection connection) throws SQLException {
        try (Statement statement = connection.createStatement()) {
            String sql = "INSERT INTO test_commonpool (id, name) VALUES (1,'A1'), (2,'A2'), (3,'A3')";
            statement.executeUpdate(sql);
            System.out.println("Data inserted successfully.");
        }
    }

    private static void updateData(Connection connection) throws SQLException {
        try (Statement statement = connection.createStatement()) {
            String sql = "UPDATE test_commonpool SET name = 'A11' WHERE id = 1";
            statement.executeUpdate(sql);
            System.out.println("Data updated successfully.");
        }
    }

    private static void deleteData(Connection connection) throws SQLException {
        try (Statement statement = connection.createStatement()) {
            String sql = "DELETE FROM test_commonpool WHERE id = 2";
            statement.executeUpdate(sql);
            System.out.println("Data deleted successfully.");
        }
    }

    private static void selectData(Connection connection) throws SQLException {
        try (Statement statement = connection.createStatement()) {
            String sql = "SELECT * FROM test_commonpool";
            ResultSet resultSet = statement.executeQuery(sql);
            while (resultSet.next()) {
                int id = resultSet.getInt("id");
                String name = resultSet.getString("name");
                System.out.println("id: " + id + ", name: " + name);
            }
        }
    }

    private static void dropTable(Connection connection) throws SQLException {
        try (Statement statement = connection.createStatement()) {
            String sql = "DROP TABLE test_commonpool";
            statement.executeUpdate(sql);
            System.out.println("Table dropped successfully.");
        }
    }

    static class ConnectionFactory extends org.apache.commons.pool2.BasePooledObjectFactory<Connection> {
        private final String url;
        private final String username;
        private final String password;

        public ConnectionFactory(String url, String username, String password) {
            this.url = url;
            this.username = username;
            this.password = password;
        }

        @Override
        public Connection create() throws Exception {
            return DriverManager.getConnection(url, username, password);
        }

        @Override
        public void destroyObject(org.apache.commons.pool2.PooledObject<Connection> p) throws Exception {
            p.getObject().close();
        }

        @Override
        public boolean validateObject(org.apache.commons.pool2.PooledObject<Connection> p) {
            try {
                return p.getObject().isValid(5000);
            } catch (SQLException e) {
                return false;
            }
        }

        @Override
        public PooledObject<Connection> wrap(Connection connection) {
            return new DefaultPooledObject<>(connection);
        }
    }
}

関連ドキュメント

MySQL Connector/Jの詳細については、Overview of MySQL Connector/Jを参照してください。