Java で DB2 のデータ エンティティのオブジェクト リレーショナル マッピング（ORM）を行う

Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for DB2 を使用して Hibernate で DB2 リポジトリの ORM を生成する方法を説明します。

本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for DB2 は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から DB2 のデータ に接続するためのチュートリアルも用意しています。

Hibernate のインストール

以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。

1. Eclipse で、Help -> Install New Software を選択します。
2. Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
3. フィルタボックスに「Hibernate」と入力します。
4. Hibernate Tools を選択します。

新規プロジェクトの作成

以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。

1. 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
2. プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
3. Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.db2.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

以下の手順に従って、DB2 のデータ への接続プロパティを設定します。

1. 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
2. src を親フォルダとして選択し、Next をクリックします。

3. 以下の値を入力します:

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.db2.DB2Driver

   • Connection URL: JDBC URL です。jdbc:db2: から始まり、セミコロン区切りの接続プロパティが続きます。

     DB2 に接続するには以下のプロパティを設定します。

     • Server: DB2 を実行するサーバー名。
     • Port: DB2 サーバーのポート。
     • Database: DB2 データベース名。

     接続の準備ができたら、認証スキームを選択し、以下で説明するように適切なプロパティを設定します。

     CData 製品 は、DB2 への認証に4つの異なるスキームをサポートします。DB2 ユーザー資格情報（デフォルト）、暗号化されたユーザー資格情報、IBM Identity and Access Management（IAM）認証、および Kerberos です。

     DB2 ユーザー資格情報

     ユーザー資格情報を使用して認証するには、次のプロパティを設定します。
     • AuthScheme：USRIDPWD。
     • User：データベースへのアクセス権を持つユーザーのユーザー名。
     • Password：データベースへのアクセス権を持つユーザーのパスワード。

     暗号化されたユーザー資格情報

     サーバーがセキュア認証に対応しており、暗号化されたユーザー資格情報を使用して認証を行いたい場合は、このプロパティを設定します。
     • AuthScheme：EUSRIDPWD

     IAM、Kerberos で認証したい場合は、ヘルプドキュメントの「はじめに」セクションを参照してください。

     パスワード方式によるSSH 接続

     パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

     • User: DB2 のユーザ
     • Password: DB2 のパスワード
     • Database: DB2 の接続先データベース
     • Server: DB2 のサーバー
     • Port: DB2 のポート
     • UserSSH: "true"
     • SSHAuthMode: "Password"
     • SSHPort: SSH のポート
     • SSHServer: SSH サーバー
     • SSHUser: SSH ユーザー
     • SSHPassword: SSH パスワード

     接続文字列形式では以下のようになります。

     Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=testUseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

     公開鍵認証方式方式によるSSH 接続

     公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

     • User: DB2 のユーザ
     • Password: DB2 のパスワード
     • Database: DB2 の接続先データベース
     • Server: DB2 のサーバー
     • Port: DB2 のポート
     • UserSSH: "true"
     • SSHAuthMode: "Public_Key"
     • SSHClientCertType: キーストアの種類
     • SSHPort: SSH のポート
     • SSHServer: SSH サーバー
     • SSHUser: SSH ユーザー
     • SSHClientCert: 秘密鍵ファイルのパス

     接続文字列形式では以下のようになります。

     Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;UseSSH=true;SSHAuthMode=Public_Key;SSHClientCertType=PUBLIC_KEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;

     組み込みの接続文字列デザイナー

     JDBC URL の構築には、DB2 JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行してください。

     java -jar cdata.jdbc.db2.jar
     

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     

     一般的な JDBC URL は以下のとおりです:

     jdbc:db2:Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;

Hibernate から DB2 のデータ に接続

以下の手順に従って、前のステップで作成した設定を選択します。

1. Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
2. Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
3. Hibernate version を 5.2 に設定します。
4. Browse ボタンをクリックし、プロジェクトを選択します。
5. Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
6. Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
7. 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。

DB2 のデータ のリバースエンジニアリング

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

1. Package Explorer に戻ります。
2. プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
3. src を親フォルダとして選択し、Next をクリックします。
4. Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
5. ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、DB2 テーブルの POJO（Plain Old Java Object）を生成します。

1. メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
2. Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
3. Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
4. Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
5. Run をクリックします。

前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。

マッピングタグの挿入

生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:

  
    
      cdata.db2.DB2Driver
    
    
      jdbc:db2:Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

前のステップで作成したエンティティを使用して、DB2 のデータ のデータの検索と変更が可能になります:

import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM Orders O WHERE ShipCity = :ShipCity";
    Query q = session.createQuery(SELECT, Orders.class);
    q.setParameter("ShipCity","New York");
    List<Orders> resultList = (List<Orders>) q.list();

    for(Orders s: resultList){
      System.out.println(s.getOrderName());
      System.out.println(s.getFreight());
    }
  }
}