Tomcat接続プールを使用したOceanBase Cloudデータベース接続サンプルプログラム

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

      tomcat-oceanbase-client サンプルプロジェクトをダウンロード
  </a>
  <!-- <a role='video' href='https://obbusiness-private.oss-cn-shanghai.aliyuncs.com/video-center/video/video/08%20tomcat-ob-client_e08.mp4'>
      
      Tomcat接続プールを使用したOceanBase Cloud接続サンプルプログラム（Oracleモード）
   </a> -->

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

操作手順

ステップ１：tomcat-oceanbase-client プロジェクトを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. プロジェクトの状況を確認します。

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

前提条件で取得した接続文字列情報に基づいて、application.properties ファイル内のデータベース接続情報を修正します。

例：

#Apache Commons DBCP2 Connection Pool
#Database Connection Pool Driver Class Name
db.app.pool.driverClassName=com.oceanbase.jdbc.Driver
#Database URL
db.app.pool.url=jdbc:oceanbase://t5******.********.oceanbase.cloud:1521/SYS?characterEncoding=UTF-8
#Database username
db.app.pool.username=test_user
#Database password
db.app.pool.password=******
#Initial size of connection pool
db.app.pool.initialSize=3
#Maximum number of connections in the connection pool
db.app.pool.maxTotal=10
#Maximum number of idle connections in the connection pool
db.app.pool.maxIdle=20
#Minimum number of idle connections in the connection pool
db.app.pool.minIdle=5
#Maximum wait time for obtaining connections (in milliseconds)
db.app.pool.maxWaitMillis=5000
#Verify the connection's query statement
db.app.pool.validationQuery=select 1 from dual

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

ステップ3：tomcat-oceanbase-client プロジェクトのTomcat実行環境を構築する

1. Tomcat 8.5.95をダウンロードします。

   Apache Tomcat公式サイトからTomcat 8.5.95の圧縮ファイルをダウンロードします。ダウンロードした圧縮ファイルを、Tomcatをインストールしたいディレクトリに解凍します。

2. IDEAでTomcatを設定します。

   IntelliJ IDEAを開き、File メニューから Settings > Plugins を選択します。Settings ウィンドウ中央の検索ボックスで Smart Tomcat と検索し、ダウンロード後に 適用する を選択します。すると、Settings ウィンドウの左下に Tomcat Server タブが表示されます。Tomcat Server タブに移動し、右側の + ボタンをクリックして、解凍したTomcatディレクトリを選択します。適用する をクリックしてから OK をクリックし、設定を完了します。

3. Tomcat実行構成を作成します。

   IDEAの上部ツールバーで、Run > Edit Configurations を選択します。Run/Debug Configurations ウィンドウで、+ ボタンをクリックし、Tomcat Server を選択します。実行サーバー名 Name を入力し、Configuration 選択ボックスでインストールしたバージョンの Tomcat Server を選択します。Context path の値を / に変更し、SSL port に 8080 を入力します。Before launch 選択ボックスで、+ をクリックし、Launch Web Browser を選択します。Edit をクリックしてURLに http://localhost:8080/hello/getData を入力し、適用する をクリックしてから OK をクリックし、設定を完了します。

4. Tomcatサーバーを起動します。

   IDEAの上部ツールバーで、先ほど作成したTomcatの実行構成を選択します。緑色の三角形の実行ボタンをクリックしてTomcatサーバーを起動します。IDEAのRunウィンドウでTomcatサーバーの起動ログを確認できます。

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

1. 実行パス。

   IDEAの上部ツールバーで、先ほど作成したTomcatの実行構成を選択します。緑色の三角形の実行ボタンをクリックしてTomcatサーバーを起動します。Google ChromeまたはIEブラウザで http://localhost:8080/hello/getData を開き、実行結果を確認します。

2. 実行結果。

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

   • データ挿入後の結果。

     tomcat 接続プールテスト0
     tomcat 接続プールテスト1
     tomcat 接続プールテスト2
     tomcat 接続プールテスト3
     tomcat 接続プールテスト4
     tomcat 接続プールテスト5
     tomcat 接続プールテスト6
     tomcat 接続プールテスト7
     tomcat 接続プールテスト8
     tomcat 接続プールテスト9
     

   • データ変更後の結果。

     -----変更後-----
     POOl 接続プールテスト0
     POOl 接続プールテスト1
     POOl 接続プールテスト2
     POOl 接続プールテスト3
     POOl 接続プールテスト4
     POOl 接続プールテスト5
     POOl 接続プールテスト6
     POOl 接続プールテスト7
     POOl 接続プールテスト8
     POOl 接続プールテスト9
     

   • Webインターフェースに返す結果。

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

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

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

│--pom.xml
│
├─.idea
│
├─src
│  ├─main
│  │  ├─java
│  │  │  └─com
│  │  │      └─oceanbase
│  │  │          └─testtomcat
│  │  │              ├─config
│  │  │              │   └─UserConfig.java
│  │  │              │
│  │  │              ├─controller
│  │  │              │   └─UserController.java
│  │  │              │
│  │  │              └─pojo
│  │  │                  └─User.java
│  │  │
│  │  ├─resources
│  │  │    └─application.properties
│  │  │    
│  │  └─webapp    
│  │      └─WEB-INF
│  │          └─web.xml
│  │             
│  │                
│  │
│  └─test
│      └─java
│         
│
└─target

ファイルの説明：

• pom.xml：Mavenプロジェクトの設定ファイルで、プロジェクトの依存関係、プラグイン、ビルドなどの情報が含まれます。
• .idea：IDE（統合開発環境）で使用されるディレクトリで、プロジェクト関連の設定情報を格納します。
• src：プロジェクトのソースコードを格納するディレクトリです。
• main: 主要なソースコードとリソースファイルを格納するディレクトリ。
• java: Javaソースコードを格納するディレクトリ。
• com: Javaパッケージのルートディレクトリ。
• oceanbase: プロジェクトのルートディレクトリ。
• testtomcat：JFinalフレームワーク関連のコードを格納します。
• config：設定ファイルディレクトリで、アプリケーションの設定クラスファイルが含まれます。
• UserConfig.java：ユーザー設定クラスファイル。
• controller：コントローラーディレクトリで、アプリケーションのコントローラークラスファイルが含まれます。
• UserController.java：ユーザーコントローラークラスファイル。
• pojo: JavaBeanまたはエンティティクラスを格納します。
• User.java：ユーザーエンティティクラスを格納します。
• resources: リソースファイルを格納するディレクトリで、設定ファイルやSQLファイルなどが含まれます。
• application.properties: データベース接続情報を格納する設定ファイル。
• webapp：Webアプリケーションディレクトリで、Webアプリケーションの静的リソースと設定ファイルが含まれます。
• WEB-INF：WebアプリケーションのWEB-INFディレクトリで、設定ファイルやその他の保護されたリソースファイルを格納します。
• web.xml：Webアプリケーションのデプロイメント記述子ファイル。
• test: テストコードとリソースファイルを格納するディレクトリ。
• target: コンパイル済みのClassファイル、Jarパッケージなどのファイルを格納するディレクトリ。

pom.xmlコードの紹介

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.oceanbase と指定します。
   2. <artifactId> を使用して、プロジェクトの依存関係を tomcat-oceanbase-client と指定します。
   3. <version> を使用して、プロジェクトのバージョン番号を 1.0-SNAPSHOT と指定します。
   4. <packaging> を使用して、プロジェクトのパッケージング方式をWARファイル（Webアプリケーションアーカイブファイル）と指定します。

   コード：

    <groupId>com.oceanbase</groupId>
    <artifactId>tomcat-oceanbase-client</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!-- Packaging method (default to jar) -->
    <packaging>war</packaging>
   

4. Mavenバージョンの設定。

   <maven.compiler.source> と <maven.compiler.target> を使用して、コンパイラのソースコードバージョンとターゲットコードバージョンをどちらもJava 8と指定します。

   コード：

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
   

5. 主要な依存関係の設定。

   1. 依存関係が属する組織を com.jfinal、名前を jfinal、バージョン番号を 5.0.6 と指定します。この依存関係により、JFinalフレームワークの機能を利用できます。

      コード：

      <dependency>
          <groupId>com.jfinal</groupId>
          <artifactId>jfinal</artifactId>
          <version>5.0.6</version>
      </dependency>
      

   2. 依存関係の所属組織を com.alibaba、名前を druid、バージョン番号を 1.2.8 と指定します。この依存関係により、Druidライブラリを使用できます。Druidは、データベース接続の取得と解放を管理および最適化するために使用されます。

      コード：

      <dependency>
          <groupId>com.alibaba</groupId>
          <artifactId>druid</artifactId>
          <version>1.2.8</version>
      </dependency>
      

   3. 依存関係の所属組織を org.apache.commons、名前を commons-dbcp2、バージョン番号を 2.9.0 と指定します。この依存関係により、Apache Commons DBCP2ライブラリを使用できます。Apache Commons DBCP2は、データベース接続の取得と解放を管理および最適化するために使用されます。

      コード：

      <dependency>
          <groupId>org.apache.commons</groupId>
          <artifactId>commons-dbcp2</artifactId>
          <version>2.9.0</version>
      </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>
      

application.propertiesファイルの紹介

application.properties ファイルは、OceanBaseデータベースへの接続情報を設定します。データベースドライバーのクラス名、接続URL、ユーザー名、パスワード、および接続プールに関する設定が含まれます。これらのパラメータは、アプリケーション内でデータベース接続を取得し、管理してデータベース操作を実行するために使用されます。

• db.app.pool.driverClassName を使用して、データベースドライバーを com.oceanbase.jdbc.Driver と指定し、OceanBaseデータベースとの接続を確立します。

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

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

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

• db.app.pool.initialSize を使用して、接続プールの初期サイズを 3 に指定します。これは、初期状態で3つのデータベース接続が作成されることを意味します。

• db.app.pool.maxTotal を使用して、接続プールの最大サイズを 10 に指定します。これは、接続プール内で最大10個のデータベース接続を作成できることを意味します。

• db.app.pool.maxIdle を使用して、接続プールのアイドル接続数の上限を 20 に指定します。

• db.app.pool.minIdle を使用して、接続プールのアイドル接続数の下限を 5 に指定します。

• db.app.pool.maxWaitMillis を使用して、データベース接続のタイムアウト時間を 5000ms に指定します。これは、データベース接続を取得する際、5000msを超えても接続を取得できない場合、タイムアウト例外がスローされることを意味します。

• db.app.pool.validationQuery を使用して、データベース接続を検証するためのSQLクエリステートメントを select 1 from dual と指定します。これは、接続プールから接続を取得する際、このクエリステートメントを実行して接続の有効性を検証することを意味します。

  コード：

    #Apache Commons DBCP2 Connection Pool
    #Database Connection Pool Driver Class Name
    db.app.pool.driverClassName=com.oceanbase.jdbc.Driver
    #Database URL
    db.app.pool.url=jdbc:oceanbase:////host:port/schema_name?characterEncoding=UTF-8
    #Database username
    db.app.pool.username=user_name
    #Database password
    db.app.pool.password=******
    #Initial size of connection pool
    db.app.pool.initialSize=3
    #Maximum number of connections in the connection pool
    db.app.pool.maxTotal=10
    #Maximum number of idle connections in the connection pool
    db.app.pool.maxIdle=20
    #Minimum number of idle connections in the connection pool
    db.app.pool.minIdle=5
    #Maximum wait time for obtaining connections (in milliseconds)
    db.app.pool.maxWaitMillis=5000
    #Verify the connection's query statement
    db.app.pool.validationQuery=select 1 from dual
  

Tomcat組み込み接続プールDBCPの一般的なパラメータ：

web.xmlコードの紹介

web.xml ファイルは、Webアプリケーションのフィルターを設定するために使用されます。

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

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

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

   コード：

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

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

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

4. xmlns を使用して、XMLの名前空間を http://java.sun.com/xml/ns/javaee に指定します。

5. xsi:schemaLocation を使用して、XML の名前空間を http://java.sun.com/xml/ns/javaee、XML の XSD ファイルの場所を http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd に指定します。

6. <id> と <version> 要素を使用して、WebアプリケーションのIDを WebApp_ID、バージョン番号を 3.0 と指定します。

コード：

 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
          xmlns="http://java.sun.com/xml/ns/javaee" 
          xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 
          id="WebApp_ID" 
          version="3.0">

3. JFinalフィルターの設定。

   WebアプリケーションでJFinalフレームワークを使用するために、jfinal という名前のフィルターを設定します。フィルターのクラスを com.jfinal.core.JFinalFilter と指定します。初期化パラメータ configClass を指定することで、JFinalフレームワークの設定クラスの場所を com.oceanbase.testtomcat.config.UserConfig と指定します。JFinalフィルターは、WebアプリケーションでJFinalフレームワークを使用し、指定された設定クラスに基づいてJFinalフレームワークの動作を設定するために使用されます。

コード：

 <filter>
     <filter-name>jfinal</filter-name>
     <filter-class>com.jfinal.core.JFinalFilter</filter-class>
     <init-param>
         <param-name>configClass</param-name>
         <!-- your jfinal configuration location -->
         <param-value>com.oceanbase.testtomcat.config.UserConfig</param-value>
     </init-param>
 </filter>

4. JFinalフィルターマッピングの設定。

   jfinal フィルターをすべてのリクエストパスに適用します。つまり、このフィルターはアプリケーション内のすべてのリクエストに適用されます。

コード：

 <filter-mapping>
     <filter-name>jfinal</filter-name>
     <url-pattern>/*</url-pattern>
 </filter-mapping>

UserConfig.javaファイルの紹介

UserConfig.java ファイルは、アプリケーションのルーティング、プラグイン、データベース接続などの関連情報を設定するために使用されます。

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

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

   このファイルには以下のインターフェースとクラスが含まれていることを宣言します：

   • StatFilter クラス：データベースアクセスのパフォーマンス統計に使用されます。
   • JdbcConstants クラス：データベースタイプを定義するための定数を使用します。
   • WallFilter クラス：SQLインジェクション攻撃を防ぐために使用されます。
   • PropKit クラス：設定ファイルを読み取るために使用されます。
   • ActiveRecordPlugin クラス：データベース操作に使用されます。
   • Db クラス：データベース操作を実行するために使用されます。
   • OracleDialect クラス：データベースの方言を指定するために使用されます。
   • DruidPlugin クラス：データベース接続に使用されます。
   • Engine クラス：テンプレートエンジンを設定するために使用されます。
   • UserController クラス：ユーザー関連のリクエストを処理するために使用されます。
   • User クラス：ユーザーデータの受け渡しと保存に使用されます。

   コード：

   import com.alibaba.druid.filter.stat.StatFilter;
   import com.alibaba.druid.util.JdbcConstants;
   import com.alibaba.druid.wall.WallFilter;
   import com.jfinal.config.*;
   import com.jfinal.kit.PropKit;
   import com.jfinal.plugin.activerecord.ActiveRecordPlugin;
   import com.jfinal.plugin.activerecord.Db;
   import com.jfinal.plugin.activerecord.dialect.OracleDialect;
   import com.jfinal.plugin.druid.DruidPlugin;
   import com.jfinal.template.Engine;
   import com.oceanbase.testjfinal.controller.UserController;
   import com.oceanbase.testjfinal.pojo.User;
   

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

   JFinalConfig クラスの各メソッドをオーバーライドすることで、定数、ルーティング、プラグイン、データベース接続などの情報を設定できます。

   1. configConstant メソッドを定義します。

      JFinalフレームワークの定数を設定するために使用され、PropKit を使用して設定ファイルから設定を読み取ります。

      コード：

      @Override
      public void configConstant(Constants constants) {
          PropKit.use("application.properties");
      }
      

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

      ルーティングマッピングを設定するために使用され、routes.add メソッドを使用して "/hello" パスを UserController クラスのデフォルトアクセスページにマッピングします。

      コード：

      @Override
      public void configRoute(Routes routes) {
          routes.add("/hello", UserController.class, "/");
      }
      

   3. configEngine メソッドを定義します。

      テンプレートエンジンを設定するために使用されます。

      コード：

      @Override
      public void configEngine(Engine engine) {
      }
      

   4. configPlugin メソッドを定義します。

      アプリケーションのプラグインを設定するために使用されます。init メソッドを呼び出してデータベース接続とテーブル構造を初期化し、DruidPlugin と ActiveRecordPlugin プラグインを作成して plugins に追加します。同時に、activeRecordPlugin の addMapping メソッドを呼び出してデータベーステーブルとエンティティクラスのマッピング関係を追加し、TEST_USER テーブルを User クラスにマッピングします。

      コード：

      @Override
      public void configPlugin(Plugins plugins) {
          init();
          DruidPlugin druidPlugin = createDruidPlugin();
          plugins.add(druidPlugin);
      
          ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
          activeRecordPlugin.addMapping("TOMCAT_TEST", User.class);
          plugins.add(activeRecordPlugin);
      }
      

   5. createDruidPlugin メソッドを定義します。

      DruidPlugin プラグインを作成し、接続プールサイズ、SQLファイアウォール、接続エラー処理などの関連パラメータを設定するために使用されます。

      • PropKit の get メソッドを呼び出して、設定ファイルからURL、ユーザー名、パスワード、ドライバークラスなどのデータベース接続関連のプロパティ値を取得します。次に、DruidPlugin オブジェクトを作成し、取得したプロパティ値で初期化します。

      • addFilter メソッドを呼び出して、DruidPlugin に StatFilter インスタンスを追加し、データベースアクセスのパフォーマンス統計に使用します。WallFilter インスタンスを作成し、setDbType メソッドでデータベースタイプをOceanBaseに設定して DruidPlugin に追加し、SQLファイアウォールフィルタリングを実行します。

      • setInitialSize メソッドを呼び出して接続プールの初期サイズを設定します。setMaxPoolPreparedStatementPerConnectionSize メソッドで接続プールごとのプリペアドステートメントの最大数を設定します。setTimeBetweenConnectErrorMillis メソッドで接続エラー間の時間間隔を設定します。setValidationQuery メソッドで接続の検証クエリステートメントを設定します。最後に、作成した DruidPlugin インスタンスを返します。

        コード：

        private DruidPlugin createDruidPlugin() {
            DruidPlugin druidPlugin = new DruidPlugin(
                PropKit.get("db.app.pool.url"),
                PropKit.get("db.app.pool.username"),
                PropKit.get("db.app.pool.password"),
                PropKit.get("db.app.pool.driverClassName")
            );
        
            druidPlugin.addFilter(new StatFilter());
            WallFilter wallFilter = new WallFilter();
            wallFilter.setDbType(JdbcConstants.OCEANBASE);
            druidPlugin.addFilter(wallFilter);
        
            druidPlugin.setInitialSize(PropKit.getInt("db.app.pool.initialSize"));
            druidPlugin.setMaxPoolPreparedStatementPerConnectionSize(PropKit.getInt("db.app.pool.maxTotal"));
            druidPlugin.setTimeBetweenConnectErrorMillis(PropKit.getInt("db.app.pool.maxWaitMillis"));
            druidPlugin.setValidationQuery("select 1 from dual");
        
            return druidPlugin;
        }
        

   6. init メソッドを定義します。

      データベース接続の初期化とデータベーステーブルの作成に使用されます。initDbConnection メソッドを呼び出してデータベース接続を初期化し、ActiveRecordPlugin インスタンスを返します。次に、SQLステートメントを実行して、ユーザーテーブル TOMCAT_TEST が存在するかどうかを確認します。テーブル TOMCAT_TEST が存在する場合は、SQLステートメント DROP TABLE TOMCAT_TEST を実行してこのテーブルを削除します。その後、CREATE TABLE ステートメントを実行して、ID と USERNAME の2つのフィールドを持つ TOMCAT_TEST という名前のデータベーステーブルを作成します。最後に、ActiveRecordPlugin プラグインの接続を閉じて、データベース接続を解放します。

      コード：

      public void init() {
          ActiveRecordPlugin arp = initDbConnection();
      
          // Check if table exists
          boolean tableExists = Db.queryInt("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = 'TOMCAT_TEST'") > 0;
      
          // Drop table if it exists
          if (tableExists) {
              Db.update("DROP TABLE TOMCAT_TEST");
          }
      
          // Create table
          String sql = "CREATE TABLE TOMCAT_TEST (ID NUMBER(10), USERNAME VARCHAR2(50))";
          Db.update(sql);
      
          arp.stop();
      }
      

   7. initDbConnection メソッドを定義します。

      データベース接続の初期化に使用されます。まず、createDruidPlugin メソッドを呼び出して DruidPlugin オブジェクトを作成し、変数 druidPlugin に代入します。このメソッドは、データベース接続プールの管理に使用される DruidPlugin の作成と設定を担当します。次に、createActiveRecordPlugin メソッドを呼び出して ActiveRecordPlugin オブジェクトを作成し、DruidPlugin オブジェクトをパラメータとしてこのメソッドに渡します。このメソッドは、データベース操作の管理に使用される ActiveRecordPlugin の作成と設定を担当します。その後、druidPlugin.start メソッドを呼び出して DruidPlugin を起動し、データベース接続プールを初期化します。最後に、activeRecordPlugin.start メソッドを呼び出して ActiveRecordPlugin を起動します。このメソッドは、設定に基づいてデータベース操作に関する設定を初期化します。

      コード：

      private ActiveRecordPlugin initDbConnection() {
          DruidPlugin druidPlugin = createDruidPlugin();
          ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
      
          druidPlugin.start();
          activeRecordPlugin.start();
      
          return activeRecordPlugin;
      }
      

   8. ConfigInterceptor と ConfigHandler メソッドを定義します。

      システム初期化プロセス中にグローバル設定を行うために使用されます。

      コード：

      @Override
      public void configInterceptor(Interceptors interceptors) {
      }
      
      @Override
      public void configHandler(Handlers handlers) {
      }
      

UserController.javaファイルの紹介

UserController.java ファイルは、getData メソッドを使用してデータベースにデータを挿入し、データをクエリして、その結果をJSON形式でクライアントに返します。JFinalフレームワークが提供する Db クラスを使用してデータベース操作を実行し、カスタムの User クラスを使用してデータマッピングを行うことで、データベース操作とデータ返却機能を実現しています。

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

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

   このファイルには以下のインターフェースとクラスが含まれていることを宣言します：

   • Controller クラス：リクエストとレスポンスを処理するために使用されます。
   • Db クラス：データベース操作を実行するために使用されます。
   • Record クラス：データのクエリ、挿入、更新、削除などのデータベース操作を実行するために使用されます。
   • ArrayList クラス：空のリストを作成するために使用されます。
   • User クラス：データベーステーブルをマッピングするために使用されます。
   • List インターフェース：クエリ結果セットを操作するために使用されます。

   コード：

   import com.jfinal.core.Controller;
   import com.jfinal.plugin.activerecord.Db;
   import com.jfinal.plugin.activerecord.Record;
   
   import java.util.ArrayList;
   import java.util.List;
   

2. UserController クラスの定義。

   JFinalフレームワークにコントローラーを提供し、getData メソッドを使用してデータベースへのデータ挿入とデータクエリ操作を実行するために使用されます。

   1. データの挿入。10個の Record オブジェクトを含むリスト dataList を作成します。各 Record オブジェクトは、異なる ID と USERNAME フィールド値を持ちます。次に、Db.batchSave メソッドを使用して、dataList リスト内のレコードを TOMCAT_TEST という名前のデータベーステーブルに一括保存します。

      コード：

              for (int i = 0; i < 10; i++) {
                  Record record = new Record().set("ID", i).set("USERNAME", "tomcat 接続プールテスト" + i);
                  dataList.add(record);
              }
              Db.batchSave("TOMCAT_TEST", dataList, dataList.size());
      

   2. データのクエリ。Db.find メソッドを使用してSQLクエリを実行し、結果を resultList リストに格納します。拡張 for ループを使用して、resultList リスト内の各 Record オブジェクトを走査します。getStr メソッドを使用して Record オブジェクトの指定フィールドの値を取得し、System.out.println メソッドを使用して出力します。

      コード：

          List<Record> resultList = Db.find("SELECT * FROM TOMCAT_TEST");
          for (Record result : resultList) {
              System.out.println(result.getStr("USERNAME"));
          }
      

   3. データの更新。ループを使用して10回繰り返し、各繰り返しで1つの更新ステートメントを実行します。更新ステートメントは Db.update メソッドを使用して実行され、TOMCAT_TEST という名前のデータベーステーブル内のレコードを条件に基づいて更新します。

      コード：

          for (int i = 0; i < 10; i++) {
              Db.update("UPDATE TOMCAT_TEST SET USERNAME = 'POOl 接続プールテスト" + i + "' WHERE ID = " + i);
          }
      

   4. 変更後のデータをクエリします。TOMCAT_TEST という名前のデータベーステーブルをクエリし、結果を modifiedList に格納します。-----変更後----- というメッセージを出力します。modifiedList を走査し、各レコードの USERNAME フィールドの値を出力します。renderJson メソッドを使用して、応答メッセージ Data retrieved successfully をJSON形式でレンダリングし、クライアントに返します。

      コード：

              List<Record> modifiedList = Db.find("SELECT * FROM TOMCAT_TEST");
              System.out.println("-----変更後-----");
              for (Record modified : modifiedList) {
                  System.out.println(modified.getStr("USERNAME"));
              }
              renderJson("Data retrieved successfully");
      

User.javaファイルの紹介

User.java ファイルは、データベーステーブルとJavaオブジェクトのマッピングを実装するために使用されます。

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

1. Model クラスをインポートします。

   Model クラスは、データベーステーブルのマッピングとデータ操作に使用されます。

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

   User クラスは、継承した Model クラスが提供するメソッドを使用してデータベース操作を行います。

   コード：

   import com.jfinal.plugin.activerecord.Model;
   
       public class User extends Model<User> {
           public static final User dao = new User();
   
   }
   

全コード表示

<?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.oceanbase</groupId>
    <artifactId>tomcat-oceanbase-client</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!-- Packaging method (default to jar) -->
    <packaging>war</packaging>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>com.jfinal</groupId>
            <artifactId>jfinal</artifactId>
            <version>5.0.6</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.8</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-dbcp2</artifactId>
            <version>2.9.0</version>
        </dependency>
        <dependency>
            <groupId>com.oceanbase</groupId>
            <artifactId>oceanbase-client</artifactId>
            <version>2.4.3</version>
        </dependency>

    </dependencies>
</project>

    #Apache Commons DBCP2 Connection Pool
    #Database Connection Pool Driver Class Name
    db.app.pool.driverClassName=com.oceanbase.jdbc.Driver
    #Database URL
    db.app.pool.url=jdbc:oceanbase://host:port/schema_name?characterEncoding=UTF-8
    #Database username
    db.app.pool.username=user_name
    #Database password
    db.app.pool.password=******
    #Initial size of connection pool
    db.app.pool.initialSize=3
    #Maximum number of connections in the connection pool
    db.app.pool.maxTotal=10
    #Maximum number of idle connections in the connection pool
    db.app.pool.maxIdle=20
    #Minimum number of idle connections in the connection pool
    db.app.pool.minIdle=5
    #Maximum wait time for obtaining connections (in milliseconds)
    db.app.pool.maxWaitMillis=5000
    #Verify the connection's query statement
    db.app.pool.validationQuery=select 1 from dual

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
    <filter>
        <filter-name>jfinal</filter-name>
        <filter-class>com.jfinal.core.JFinalFilter</filter-class>
        <init-param>
            <param-name>configClass</param-name>
            <!-- your jfinal configuration location -->
            <param-value>com.oceanbase.testjfinal.config.UserConfig</param-value>
        </init-param>
    </filter>

    <filter-mapping>
        <filter-name>jfinal</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

package com.oceanbase.testtomcat.config;

import com.alibaba.druid.filter.stat.StatFilter;
import com.alibaba.druid.util.JdbcConstants;
import com.alibaba.druid.wall.WallFilter;
import com.jfinal.config.*;
import com.jfinal.kit.PropKit;
import com.jfinal.plugin.activerecord.ActiveRecordPlugin;
import com.jfinal.plugin.activerecord.Db;
import com.jfinal.plugin.activerecord.dialect.OracleDialect;
import com.jfinal.plugin.druid.DruidPlugin;
import com.jfinal.template.Engine;
import com.oceanbase.testtomcat.controller.UserController;
import com.oceanbase.testtomcat.pojo.User;

public class UserConfig extends JFinalConfig {
    @Override
    public void configConstant(Constants constants) {
        // Read properties configuration
        PropKit.use("application.properties");
    }

    @Override
    public void configRoute(Routes routes) {
        // Set the default access page for project startup, which does not need to be set in the web.
        routes.add("/hello", UserController.class);

    }

    @Override
    public void configEngine(Engine engine) {
    }

    @Override
    public void configPlugin(Plugins plugins) {
        init();
        DruidPlugin druidPlugin = createDruidPlugin();
        plugins.add(druidPlugin);

        ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);
        activeRecordPlugin.addMapping("TOMCAT_TEST", User.class);
        plugins.add(activeRecordPlugin);
    }

    private DruidPlugin createDruidPlugin() {
        DruidPlugin druidPlugin = new DruidPlugin(
                PropKit.get("db.app.pool.url"),
                PropKit.get("db.app.pool.username"),
                PropKit.get("db.app.pool.password"),
                PropKit.get("db.app.pool.driverClassName")
        );

        druidPlugin.addFilter(new StatFilter());
        WallFilter wallFilter = new WallFilter();
        wallFilter.setDbType(JdbcConstants.OCEANBASE);
        druidPlugin.addFilter(wallFilter);

        druidPlugin.setInitialSize(PropKit.getInt("db.app.pool.initialSize"));
        druidPlugin.setMaxPoolPreparedStatementPerConnectionSize(PropKit.getInt("db.app.pool.maxTotal"));
        druidPlugin.setTimeBetweenConnectErrorMillis(PropKit.getInt("db.app.pool.maxWaitMillis"));
        druidPlugin.setValidationQuery("select 1 from dual");

        return druidPlugin;
    }

    private ActiveRecordPlugin createActiveRecordPlugin(DruidPlugin druidPlugin) {
        ActiveRecordPlugin activeRecordPlugin = new ActiveRecordPlugin(druidPlugin);
        activeRecordPlugin.setDialect(new OracleDialect());

        return activeRecordPlugin;
    }

    public void init() {
        ActiveRecordPlugin arp = initDbConnection();

        // Check if table exists
        boolean tableExists = Db.queryInt("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = 'TOMCAT_TEST'") > 0;

        // Drop table if it exists
        if (tableExists) {
            Db.update("DROP TABLE TOMCAT_TEST");
        }

        // Create table
        String sql = "CREATE TABLE TOMCAT_TEST (ID NUMBER(10), USERNAME VARCHAR2(50))";
        Db.update(sql);

        arp.stop();
    }
    private ActiveRecordPlugin initDbConnection() {
        DruidPlugin druidPlugin = createDruidPlugin();
        ActiveRecordPlugin activeRecordPlugin = createActiveRecordPlugin(druidPlugin);

        druidPlugin.start();
        activeRecordPlugin.start();

        return activeRecordPlugin;
    }

    @Override
    public void configInterceptor(Interceptors interceptors) {
    }

    @Override
    public void configHandler(Handlers handlers) {
    }
}

package com.oceanbase.testtomcat.controller;

import com.jfinal.core.Controller;
import com.jfinal.plugin.activerecord.Db;
import com.jfinal.plugin.activerecord.Record;

import java.util.ArrayList;
import java.util.List;

public class UserController extends Controller {

    public void getData() {
        try {
            List<Record> dataList = new ArrayList<>();
            // データの挿入
            for (int i = 0; i < 10; i++) {
                Record record = new Record().set("ID", i).set("USERNAME", "Tomcat接続プールテスト" + i);
                dataList.add(record);
            }
            Db.batchSave("TOMCAT_TEST", dataList, dataList.size());
            // データのクエリ
            List<Record> resultList = Db.find("SELECT * FROM TOMCAT_TEST");
            for (Record result : resultList) {
                System.out.println(result.getStr("USERNAME"));
            }
            // データの更新
            for (int i = 0; i < 10; i++) {
                Db.update("UPDATE TOMCAT_TEST SET USERNAME = 'Pool接続プールテスト" + i + "' WHERE ID = " + i);
            }
            // 更新後のデータのクエリ
            List<Record> modifiedList = Db.find("SELECT * FROM TOMCAT_TEST");
            System.out.println("-----更新後-----");
            for (Record modified : modifiedList) {
                System.out.println(modified.getStr("USERNAME"));
            }
            renderJson("Data retrieved successfully");
        } catch (Exception e) {
            e.printStackTrace();
            renderJson("Error occurred");
        }
    }
}

package com.oceanbase.testtomcat.pojo;

import com.jfinal.plugin.activerecord.Model;

    public class User extends Model<User> {
        public static final User dao = new User();

}

関連ドキュメント

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