Java で AlloyDB のデータ エンティティのオブジェクト リレーショナル マッピング(ORM)を行う
Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for AlloyDB を使用して Hibernate で AlloyDB リポジトリの ORM を生成する方法を説明します。
本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for AlloyDB は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から AlloyDB のデータ に接続するためのチュートリアルも用意しています。
Hibernate のインストール
以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。
- Eclipse で、Help -> Install New Software を選択します。
- Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
- フィルタボックスに「Hibernate」と入力します。
- Hibernate Tools を選択します。
新規プロジェクトの作成
以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。
- 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
- プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
- Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.alloydb.jar ライブラリを追加します。
Hibernate 設定ファイルの追加
以下の手順に従って、AlloyDB のデータ への接続プロパティを設定します。
- 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
- src を親フォルダとして選択し、Next をクリックします。
以下の値を入力します:
- Hibernate version:: 5.2
- Database dialect: Derby
- Driver class: cdata.jdbc.alloydb.AlloyDBDriver
Connection URL: JDBC URL です。jdbc:alloydb: から始まり、セミコロン区切りの接続プロパティが続きます。
AlloyDB 接続プロパティの取得・設定方法
AlloyDB に接続するには、次の接続プロパティが必要です。
- Server:AlloyDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
- Port(オプション):AlloyDB データベースをホスティングしているサーバーのポート。このプロパティはデフォルトで5432に設定されます。
- User:AlloyDB サーバーに認証する際に使われるユーザー。
- Password:AlloyDB サーバーに認証する際に使われるパスワード。
- Database(オプション):AlloyDB サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。
AlloyDB への認証
標準認証
標準認証(事前に提供されたユーザーとパスワードの組み合わせを使用)は、デフォルトの認証形式です。標準認証で接続する場合は、これ以上のアクションは必要ありません。
pg_hba.conf 認証スキーム
CData 製品がサポートしている他の認証方法では、AlloyDB サーバー上のpg_hba.conf ファイルで有効化する必要があります。
AlloyDB サーバーでの認証の設定については、こちらを参照してください。
MD5
pg_hba.conf ファイルのauth-method をmd5 に設定すると、MD5 パスワード検証を使用して認証できます。
SASL
CData 製品は、SASL(特にSCRAM-SHA-256)でパスワードを検証することで認証できます。
この認証方法を使用するには、pg_hba.conf ファイルのauth-method をscram-sha-256 に設定します。
Kerberos
Kerberos 認証は、CData 製品が接続を試行している際にAlloyDB サーバーで開始されます。この認証方法を有効化するには、AlloyDB サーバーでKerberos を設定します。AlloyDB サーバーでのKerberos 認証の設定を完了したら、CData 製品からKerberos 認証を行う方法については、ヘルプドキュメントの「Kerberos の使用」セクションを参照してください。
組み込みの接続文字列デザイナー
JDBC URL の構築には、AlloyDB JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行してください。
java -jar cdata.jdbc.alloydb.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
一般的な JDBC URL は以下のとおりです:
jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432
Hibernate から AlloyDB のデータ に接続
以下の手順に従って、前のステップで作成した設定を選択します。
- Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
- Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
- Hibernate version を 5.2 に設定します。
- Browse ボタンをクリックし、プロジェクトを選択します。
- Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
- Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
- 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。
AlloyDB のデータ のリバースエンジニアリング
以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。
- Package Explorer に戻ります。
- プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
- src を親フォルダとして選択し、Next をクリックします。
- Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
- ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。
Hibernate の実行設定
以下の手順に従って、AlloyDB テーブルの POJO(Plain Old Java Object)を生成します。
- メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
- Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
- Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
- Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
- Run をクリックします。
前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。
マッピングタグの挿入
生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:
cdata.alloydb.AlloyDBDriver
jdbc:alloydb:User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432
org.hibernate.dialect.SQLServerDialect
SQL の実行
前のステップで作成したエンティティを使用して、AlloyDB のデータ のデータの検索と変更が可能になります:
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 ShipCountry = :ShipCountry";
Query q = session.createQuery(SELECT, Orders.class);
q.setParameter("ShipCountry","USA");
List<Orders> resultList = (List<Orders>) q.list();
for(Orders s: resultList){
System.out.println(s.getShipName());
System.out.println(s.getShipCity());
}
}
}