Java で JSON Services エンティティのオブジェクト リレーショナル マッピング(ORM)を行う

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
オブジェクト リレーショナル マッピング(ORM)技術を使用すると、リレーショナルデータソースの操作が容易になり、論理的なビジネスモデルと物理ストレージモデルを橋渡しできます。本記事では、Java ベースの ORM フレームワーク Hibernate に JSON services への接続を組み込む方法を説明します。

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

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

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.json.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

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

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

    • Hibernate version:: 5.2
    • Database dialect: Derby
    • Driver class: cdata.jdbc.json.JSONDriver
    • Connection URL: JDBC URL です。jdbc:json: から始まり、セミコロン区切りの接続プロパティが続きます。

      データソースへの認証については、ヘルプドキュメントの「はじめに」を参照してください。CData 製品は、JSON API を双方向データベーステーブルとして、JSON ファイルを読み取り専用ビュー(ローカル ファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー)としてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。詳細はヘルプドキュメントの「はじめに」を参照してください。

      URI を設定して認証値を入力したら、DataModel を設定してデータ表現とデータ構造をより厳密に一致させます。

      DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、次の基本設定を切り替えます。

      • Document(デフォルト):JSON データのトップレベルのドキュメントビューをモデル化します。CData 製品 は、ネストされたオブジェクト配列を集約されたJSON オブジェクトとして返します。
      • FlattenedDocuments:ネストされた配列オブジェクトと親オブジェクトを、単一テーブルに暗黙的に結合します。
      • Relational:階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれています。

      リレーショナル表現の設定についての詳細は、ヘルプドキュメントの「JSON データのモデリング」を参照してください。また、以下の例で使用されているサンプルデータも確認できます。データには人や所有する車、それらの車に行われたさまざまなメンテナンスサービスのエントリが含まれています。

      Amazon S3 内のJSON への接続

      URI をバケット内のJSON ドキュメントに設定します。さらに、次のプロパティを設定して認証します。

      • AWSAccessKey:AWS アクセスキー(username)に設定。
      • AWSSecretKey:AWS シークレットキーに設定。

      Box 内のJSON への接続

      URI をJSON ファイルへのパスに設定します。Box へ認証するには、OAuth 認証標準を使います。 認証方法については、Box への接続 を参照してください。

      Dropbox 内のJSON への接続

      URI をJSON ファイルへのパスに設定します。Dropbox へ認証するには、OAuth 認証標準を使います。 認証方法については、Dropbox への接続 を参照してください。ユーザーアカウントまたはサービスアカウントで認証できます。ユーザーアカウントフローでは、以下の接続文字列で示すように、ユーザー資格情報の接続プロパティを設定する必要はありません。 URI=dropbox://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;

      SharePoint Online SOAP 内のJSON への接続

      URI をJSON ファイルを含むドキュメントライブラリに設定します。認証するには、User、Password、およびStorageBaseURL を設定します。

      SharePoint Online REST 内のJSON への接続

      URI をJSON ファイルを含むドキュメントライブラリに設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。

      FTP 内のJSON への接続

      URI をJSON ファイルへのパスが付いたサーバーのアドレスに設定します。認証するには、User およびPassword を設定します。

      Google Drive 内のJSON への接続

      デスクトップアプリケーションからのGoogle への認証には、InitiateOAuth をGETANDREFRESH に設定して、接続してください。詳細はドキュメントの「Google Drive への接続」を参照してください。

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

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

      java -jar cdata.jdbc.json.jar
      

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

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

      jdbc:json:URI=C:/people.json;DataModel=Relational;

Hibernate から JSON Services に接続

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

  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 ノードを展開します。

JSON Services のリバースエンジニアリング

以下の手順に従って、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 の実行設定

以下の手順に従って、JSON テーブルの 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.json.JSONDriver
    
    
      jdbc:json:URI=C:/people.json;DataModel=Relational;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

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


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 people p WHERE [ personal.name.last ] = :[ personal.name.last ]";
    Query q = session.createQuery(SELECT, people.class);
    q.setParameter("[ personal.name.last ]","Roberts");
    List<people> resultList = (List<people>) q.list();

    for(people s: resultList){
      System.out.println(s.get[ personal.name.first ]());
      System.out.println(s.get[ personal.name.last ]());
    }
  }
}

はじめる準備はできましたか?

JSON Driver の無料トライアルをダウンロードしてお試しください:

 ダウンロード

詳細:

JSON Icon JSON JDBC Driver お問い合わせ

JSON Web サービス連携のパワフルなJava アプリケーションを素早く作成して配布。