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

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

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

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

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

Hibernate 構成ファイルを追加

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

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.sharepoint.SharePointDriver

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

     SharePoint のベースサイトもしくはサブサイトのURL を設定します。これにより、サイト・サブサイトのすべてのリストを含むSharePoint エンティティをクエリできます。

     Authentication セクションのUser、Password を設定します。SharePoint のオンプレミス版の際にはこの値は必須です。

     SharePoint Online に接続する場合にはSharePointEdition をSHAREPOINTONLINE に設定し、User とPassword を設定します。詳細はヘルプドキュメントの「はじめに」を参照してください。

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

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

     java -jar cdata.jdbc.sharepoint.jar

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

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

     jdbc:sharepoint:User=myuseraccount;Password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePointOnPremise;

Hibernate のSharePoint データへの接続

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

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

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

以下のステップに従って、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) をSharePoint テーブルに生成します。

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を実行

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