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

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

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

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

Hibernate 設定ファイルの追加

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

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

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

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.gmomakeshop.GMOMakeShopDriver

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

     GMO MakeShop に接続するには、MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId が必要です。

     GMO MakeShop へのアクセスの設定

     MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId を取得するには、以下の手順に従ってください。

     • GMO MakeShop には各API のAccessCode が必要です。
     • GMO MakeShop Store Manager にログインし、メニューの「ショップ作成」をクリックします。
     • 左ナビゲーションメニューの「外部システム連携」から任意の連携対象設定ををクリックします（メニューに表示されない場合は別途GMO MakeShop にご確認ください）。
     • 商品データ連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
     • 注文データ連携設定の場合：最初に「注文情報参照」と「注文情報変更」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、OrdersAccessCode を取得します。
     • 会員データ連携設定の場合：最初に「会員情報の（参照・登録・変更・削除）」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、MembersAccessCode を取得します。
     • 会員認証連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。

     GMO MakeShop アカウントの認証

     次の接続プロパティを設定して接続します。

     • ShopId：接続先のGMO MakeShop Store ID を設定。GMO MakeShop Store ID はログイン用の ID と同じです。
     • OrdersAccessCode：「注文データ連携設定」から取得した「認証コード」を設定。このプロパティは Orders テーブルにアクセスする場合に必要です。
     • ProductsAccessCode：「商品データ連携設定」から取得した「認証コード」を設定。このプロパティは Products テーブルにアクセスする場合に必要です。
     • MembersAccessCode：「会員データ連携設定」から取得した「認証コード」を設定。このプロパティは Members テーブルにアクセスする場合に必要です。
     • MemberAuthenticationCode：「会員認証連携設定」から取得した「認証コード」を設定。このプロパティは MemberAuthenticationConfirm を実行する場合に必要です。
     • Password：GMO MakeShop Store Manager のログインユーザーのパスワードを指定。このプロパティは ProductCategoryRegistrationOrModification,ProductMemberGroupPriceRegistrationOrModification,ProductOptionRegistrationOrModification,ProductRegistrationOrModification を実行する場合に必要です。

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

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

     java -jar cdata.jdbc.gmomakeshop.jar
     

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

     

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

     jdbc:gmomakeshop:ShopId=MyShopId;ProductsAccessCode=MyProductsAccessCode;MembersAccessCode=MyMembersAccessCode;OrdersAccessCode=MyOrdersAccessCode;

Hibernate から GMO MakeShop のデータ に接続

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

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

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

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

以下の手順に従って、GMO MakeShop テーブルの 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.gmomakeshop.GMOMakeShopDriver
    
    
      jdbc:gmomakeshop:ShopId=MyShopId;ProductsAccessCode=MyProductsAccessCode;MembersAccessCode=MyMembersAccessCode;OrdersAccessCode=MyOrdersAccessCode;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

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

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 Products P WHERE BrandCode = :BrandCode";
    Query q = session.createQuery(SELECT, Products.class);
    q.setParameter("BrandCode","99a87c0x3");
    List<Products> resultList = (List<Products>) q.list();

    for(Products s: resultList){
      System.out.println(s.getBrandCode());
      System.out.println(s.getPrice());
    }
  }
}