Java のZuora のデータエンティティを使用したObject-Relational Mapping (ORM)

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

この記事を通してEclipse がIDE として選択されていますが、CData JDBC Driver for Zuora はJava Runtime Environment をサポートするすべての 製品で機能します。Knowledge Base には、IntelliJ IDEA やNetBeans からZuora に接続するためのチュートリアルがあります。

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］を選択します。

新しいプロジェクトを開始

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

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

Hibernate 構成ファイルを追加

以下のステップに従って、Zuora に接続プロパティを構成します。

1. ［new project］で右クリックし、［New］->［Hibernate］->［Hibernate Configuration File (cfg.xml)］と進みます。
2. 親フォルダとして［src］を選択し、［Next］をクリックします。

3. 以下の値をインプットします。

   • Hibernate version:5.2
   • Database dialect:Derby
   • Driver class: cdata.jdbc.zuora.ZuoraDriver

   • Connection URL:jdbc:zuora: で始まり、セミコロンで区切られた接続プロパティのリストが続くJDBC URL

     Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

     Tenant プロパティの設定

     プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。
     • USProduction：リクエストはhttps://rest.zuora.com に送信されます。
     • USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
     • USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
     • EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
     • EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

     デフォルトではUSProduction テナントを使用します。

     Zuora サービスの選択

     データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

     DataQuery

     データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

     制限

     • フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
     • 出力レコードの最大数： 100,000
     • テナントごとの、実行用に送信される同時クエリの最大数： 5
     • テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
     • 1時間単位での、各クエリの最大処理時間： 1
     • GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
     • Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

     AQuADataExport

     AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

     制限

     • AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
     • 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。

     ビルトイン接続文字列デザイナ

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

     java -jar cdata.jdbc.zuora.jar

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

     以下は一般的なJDBC URL です。

     jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH

Hibernate のZuora のデータへの接続

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

1. ［Window］->［Open Perspective］->［Hibernate］と進み、Hibernate Configurations パースペクティブに切り替えます。
2. ［Hibernate Configurations］パネルで右クリックし、［Add Configuration］を選択します。
3. Hibernate version を5.2に設定します。
4. ［Browse］ボタンをクリックし、［project］を選択します。
5. ［Configuration file］フィールドで、［Setup］->［Use Existing］とクリックし、(このデモのsrc フォルダー内にある)hibernate.cfg.xml ファイルを選択します。
6. ［Classpath tab］で、［User Entries］の下に何もなかった場合、［Add External JARS］をクリックしてドライバーjar をもう一度追加します。構成が完了したら、［OK］をクリックします。
7. 新しく作成されたHibernate 構成ファイルのDatabase node を展開します。

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

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

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

実行するためのHibernate を構成

以下のステップに従って、plain old Java objects (POJO) をZuora テーブルに生成します。

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

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

マッピングタグを挿入

生成したマッピングごとにhibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを指定するようにする必要があります。hibernate.cfg.xml を開き、次のようにマッピングタグを挿入します。

SQLを実行

前の手順で作成したエンティティを使用して、Zuora の検索と変更を行うことができます。 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 Invoices I WHERE BillingState = :BillingState"; Query q = session.createQuery(SELECT, Invoices.class); q.setParameter("BillingState","CA"); List<Invoices> resultList = (List<Invoices>) q.list(); for(Invoices s: resultList){ System.out.println(s.getId()); System.out.println(s.getBillingCity()); } } }