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

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

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

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

Hibernate 設定ファイルの追加

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

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

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

   • Hibernate version:: 5.2
   • Database dialect: Derby
   • Driver class: cdata.jdbc.kintone.KintoneDriver

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

     Kintone 接続プロパティの設定方法

     それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

     • URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
     • User：アカウントのユーザー名
     • Password：アカウントのパスワード
     • AuthScheme：「Password」を指定

     パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

     Basic 認証の設定

     続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

     • BasicAuthUser：Basic 認証のユーザー名
     • BasicAuthPassword：Basic 認証のパスワード

     クライアント証明書認証の設定

     Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

     • SSLClientCert：クライアント証明書のパス
     • SSLClientCertType：証明書の種類
     • SSLClientCertSubject：証明書のサブジェクト
     • SSLClientCertPassword：証明書のパスワード

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

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

     java -jar cdata.jdbc.kintone.jar
     

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

     

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

     jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;

Hibernate から Kintone のデータ に接続

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

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

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

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

以下の手順に従って、Kintone テーブルの 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.kintone.KintoneDriver
    
    
      jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;
    
    
      org.hibernate.dialect.SQLServerDialect
    
    
    
    

SQL の実行

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

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 Apps A WHERE AppId = :AppId";
    Query q = session.createQuery(SELECT, Apps.class);
    q.setParameter("AppId","1354841");
    List<Apps> resultList = (List<Apps>) q.list();

    for(Apps s: resultList){
      System.out.println(s.getName());
      System.out.println(s.getDescription());
    }
  }
}