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

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

クリックしてjava-oceanbase-Jfinalサンプルプロジェクトをダウンロード

前提条件

• OceanBaseデータベースがインストール済みであること。
• JDK 1.8とMavenがインストール済みであること。
• IntelliJ IDEAがインストール済みであること。

手順

1. OceanBaseデータベースの接続文字列を取得します。
2. java-oceanbase-Jfinal プロジェクトをIDEAにインポートします。
3. java-oceanbase-Jfinal プロジェクトのTomcat実行環境を構築します。
4. java-oceanbase-Jfinal プロジェクト内のデータベース接続情報を変更します。
5. java-oceanbase-Jfinal プロジェクトを実行します。

ステップ１：OceanBaseデータベースの接続文字列を取得する

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

   obclient -hxx.xx.xx.xx -P2883 -uroot@sys#cluster -p**** -A
   

2. デプロイ済みのOceanBaseデータベースに基づいて、以下のURLに対応する情報を入力します。

   説明

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

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

   パラメータ説明：

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

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

ステップ2：java-oceanbase-Jfinalプロジェクトを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-Jfinal プロジェクトのTomcat実行環境を構築する

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

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

   

3. Tomcatの実行設定を作成します。

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

   

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

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

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

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

例：

• データベースドライバーの名前：com.oceanbase.jdbc.Driver
• OBServerノードのIPアドレスは 10.10.10.1 です。
• アクセスポートは2881を使用します。
• アクセスするスキーマ名は sys です。
• テナントの接続アカウントは sys@xyoracle です。xyoracle はOceanBaseデータベースで作成されたOracleモードのユーザーテナントであり、sys はテナント xyoracle のユーザー名です。
• パスワードは ****** です。

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

db.app.driver=com.oceanbase.jdbc.Driver
db.app.url=jdbc:oceanbase://10.10.10.1:2881/sys
db.app.user=sys@xyoracle
db.app.password=******
db.app.poolInitialSize=3
db.app.poolMaxSize=10
db.app.connectionTimeoutMillis=100
db.app.validationQuery=select 1 from dual

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

1. 実行パス。

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

2. 実行結果。

   [{"ID":1,"NAME":"John"},{"ID":2,"NAME":"Jane"}]
   

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

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

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

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

ファイルの説明：

• pom.xml：Mavenプロジェクトの設定ファイルで、プロジェクトの依存関係、プラグイン、ビルドなどの情報が含まれます。
• .idea：IDE（統合開発環境）で使用されるディレクトリで、プロジェクト関連の設定情報を格納します。
• src：プロジェクトのソースコードを格納するディレクトリです。
• main: 主要なソースコードとリソースファイルを格納するディレクトリ。
• java: Javaソースコードを格納するディレクトリ。
• com: Javaパッケージのルートディレクトリ。
• oceanbase: プロジェクトのルートディレクトリ。
• testjfinal：JFinalフレームワーク関連のコードを格納します。
• config：設定ファイルディレクトリで、アプリケーションの設定クラスファイルが含まれます。
• UserConfig.java：ユーザー設定クラスファイル。
• controller：コントローラーディレクトリで、アプリケーションのコントローラークラスファイルが含まれます。
• UserController.java：ユーザーコントローラークラスファイル。
• pojo: JavaBeanまたはエンティティクラスを格納します。
• User.java：ユーザーエンティティクラスを格納します。
• resources: リソースファイルを格納するディレクトリで、設定ファイルやSQLファイルなどが含まれます。
• config.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モデルバージョンの設定。

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ファイルの場所を http://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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
</project>

3. 基本情報の設定。

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

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

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

7. <packaging> を使用して、プロジェクトのパッケージング方式をWARファイル（Webアプリケーションアーカイブファイル）と指定します。

コード：

 <groupId>com.oceanbase</groupId>
 <artifactId>java-oceanbase-jfinal</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. コア依存関係の設定。

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

   コード：

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

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

  **コード：**

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

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

  **コード：**

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

config.propertiesファイルの紹介

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

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

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

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

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

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

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

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

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

  コード：

    db.app.driver=com.oceanbase.jdbc.Driver
    db.app.url=jdbc:oceanbase://host:port/schema_name
    db.app.user=user_name
    db.app.password=******
    db.app.poolInitialSize=3
    db.app.poolMaxSize=10
    db.app.connectionTimeoutMillis=100
    db.app.validationQuery=select 1 from dual
  

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.testjfinal.config.UserConfig と指定します。このフィルターは、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.testjfinal.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("config.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("TEST_USER", 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.url"),
                    PropKit.get("db.app.user"),
                    PropKit.get("db.app.password"),
                    PropKit.get("db.app.driver")
            );
        
            druidPlugin.addFilter(new StatFilter());
            WallFilter wallFilter = new WallFilter();
            wallFilter.setDbType(JdbcConstants.OCEANBASE);
            druidPlugin.addFilter(wallFilter);
        
            druidPlugin.setInitialSize(PropKit.getInt("db.app.poolInitialSize"));
            druidPlugin.setMaxPoolPreparedStatementPerConnectionSize(PropKit.getInt("db.app.poolMaxSize"));
            druidPlugin.setTimeBetweenConnectErrorMillis(PropKit.getInt("db.app.connectionTimeoutMillis"));
            druidPlugin.setValidationQuery("select 1 from dual");
        
            return druidPlugin;
        }
        

   6. init メソッドの定義。

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

      コード：

      public void init() {
          ActiveRecordPlugin arp = initDbConnection();
          boolean tableExists = Db.queryInt("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = 'TEST_USER'") > 0;
          if (!tableExists) {
              String sql = "CREATE TABLE TEST_USER (ID NUMBER(10), NAME 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 クラス：データベース操作を実行するために使用されます。
   • User クラス：データベーステーブルにマッピングするために使用されます。
   • List インターフェース：クエリ結果の集合を操作するために使用されます。

   コード：

   import com.jfinal.core.Controller;
   import com.jfinal.plugin.activerecord.Db;
   import com.oceanbase.testjfinal.pojo.User;
   
   import java.util.List;
   

2. UserController クラスの定義。

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

   1. データの挿入。Db.update メソッドを使用してSQL挿入ステートメントを実行し、TEST_USER という名前のテーブルに2件のデータを挿入します。IDは 1 と 2、名前はそれぞれ John と Jane です。
   2. データのクエリ。User.dao.find メソッドを使用してSQLクエリステートメントを実行し、TEST_USER という名前のテーブルからすべてのデータをクエリします。クエリ結果は List 型の変数 users に代入されます。
   3. JSONデータのレンダリング。renderJson メソッドを使用して、users オブジェクトに保存されたデータをJSON形式でレンダリングし、クライアントに返します。
   4. 例外処理。操作の実行中に例外がキャッチされた場合、catch ステートメントブロックで例外のスタック情報を出力します。

   コード：

   public class UserController extends Controller {
       public void getData(){
   
           try {
   
               // データの挿入
               String insertDataSql = "INSERT INTO TEST_USER (ID, NAME) VALUES (?, ?)";
               Db.update(insertDataSql, 1, "John");
               Db.update(insertDataSql, 2, "Jane");
               //データのクエリ
               List<User> users;
               users = User.dao.find("SELECT * FROM TEST_USER");
               renderJson(users);
           }catch (Exception e){
               e.printStackTrace();
           }
       }
   
   }
   

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>java-oceanbase-jfinal</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>com.oceanbase</groupId>
            <artifactId>oceanbase-client</artifactId>
            <version>2.4.3</version>
        </dependency>
    </dependencies>
</project>

db.app.driver=com.oceanbase.jdbc.Driver
db.app.url=jdbc:oceanbase://host:port/schema_name
db.app.user=user_name
db.app.password=
db.app.poolInitialSize=3
db.app.poolMaxSize=10
db.app.connectionTimeoutMillis=100
db.app.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.testjfinal.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.testjfinal.controller.UserController;
import com.oceanbase.testjfinal.pojo.User;

public class UserConfig extends JFinalConfig {
    @Override
    public void configConstant(Constants constants) {
        // Read properties configuration
        PropKit.use("config.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("TEST_USER", User.class);
        plugins.add(activeRecordPlugin);
    }

    private DruidPlugin createDruidPlugin() {
        DruidPlugin druidPlugin = new DruidPlugin(
                PropKit.get("db.app.url"),
                PropKit.get("db.app.user"),
                PropKit.get("db.app.password"),
                PropKit.get("db.app.driver")
        );

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

        druidPlugin.setInitialSize(PropKit.getInt("db.app.poolInitialSize"));
        druidPlugin.setMaxPoolPreparedStatementPerConnectionSize(PropKit.getInt("db.app.poolMaxSize"));
        druidPlugin.setTimeBetweenConnectErrorMillis(PropKit.getInt("db.app.connectionTimeoutMillis"));
        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();
        boolean tableExists = Db.queryInt("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = 'TEST_USER'") > 0;
        if (!tableExists) {
            String sql = "CREATE TABLE TEST_USER (ID NUMBER(10), NAME 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.testjfinal.controller;

import com.jfinal.core.Controller;
import com.jfinal.plugin.activerecord.Db;
import com.oceanbase.testjfinal.pojo.User;

import java.util.List;

public class UserController extends Controller {
    public void getData(){

        try {

            // データの挿入
            String insertDataSql = "INSERT INTO TEST_USER (ID, NAME) VALUES (?, ?)";
            Db.update(insertDataSql, 1, "John");
            Db.update(insertDataSql, 2, "Jane");
            //データのクエリ
            List<User> users;
            users = User.dao.find("SELECT * FROM TEST_USER");
            renderJson(users);
        }catch (Exception e){
            e.printStackTrace();
        }
    }

}

package com.oceanbase.testjfinal.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ドライバを参照してください。