Java で Access のデータ エンティティのオブジェクト リレーショナル マッピング(ORM)を行う
Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for Access を使用して Hibernate で Access リポジトリの ORM を生成する方法を説明します。
本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for Access は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から Access のデータ に接続するためのチュートリアルも用意しています。
Hibernate のインストール
以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。
- Eclipse で、Help -> Install New Software を選択します。
- Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
- フィルタボックスに「Hibernate」と入力します。
- Hibernate Tools を選択します。
新規プロジェクトの作成
以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。
- 新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
- プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
- Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.access.jar ライブラリを追加します。
Hibernate 設定ファイルの追加
以下の手順に従って、Access のデータ への接続プロパティを設定します。
- 新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
- src を親フォルダとして選択し、Next をクリックします。
以下の値を入力します:
- Hibernate version:: 5.2
- Database dialect: Derby
- Driver class: cdata.jdbc.access.AccessDriver
Connection URL: JDBC URL です。jdbc:access: から始まり、セミコロン区切りの接続プロパティが続きます。
Access接続の設定方法
ローカルファイルへの接続設定
ローカル環境からAccess への接続は非常にシンプルです。ConnectionType をLocal に設定することで、CRUD 操作(SELECT、INSERT、UPDATE、DELETE)をすべて実行できます。接続にはDataSource プロパティに以下のようなAcces sデータベースファイルのフルパスを指定します。
C:\Users\Public\Documents\MyDatabase.accdb
詳細な接続手順については、ヘルプドキュメントの「はじめに」セクションをご参照ください。
クラウドストレージ上のAccess ファイルへの接続設定
各種クラウドストレージに保存されているAccess ファイルへのアクセスにも対応しています。ただし、クラウド上のファイルに対するデータ操作は、INSERT、UPDATE、DELETE に制限されますのでご注意ください。
S3、Google Driver、OneDrive など、各種クラウドストレージ内のAccess ファイルへの接続方法はこちらの記事をご確認ください。
クラウド上のファイルを更新したい場合は、以下の手順で実施いただけます。
- 対応するCData ドライバーを利用し、クラウドサービスからAccess ファイルをダウンロード
- Access ドライバーを使用して、ローカル環境でファイルを編集
- クラウドサービス用ドライバーのストアドプロシージャを使用して、更新ファイルをアップロード
具体例として、SharePoint 上のファイルを更新する場合の手順をご紹介します。
- CData SharePoint ドライバーのDownloadDocument プロシージャを使用してファイルを取得
- CData Access ドライバーでファイルの更新を実施
- SharePoint ドライバーのUploadDocument プロシージャで更新内容を反映
DataSource 接続プロパティの設定について補足いたします。接続先のクラウドストレージを識別するための一意の接頭辞を指定し、続けて目的のファイルパスまたはフォルダパスを記述します。フォルダを指定した場合は1ファイルが1テーブルとして、単一ファイルの場合は単一テーブルとして扱われます。
組み込みの接続文字列デザイナー
JDBC URL の構築には、Access JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行してください。
java -jar cdata.jdbc.access.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
一般的な JDBC URL は以下のとおりです:
jdbc:access:DataSource=C:/MyDB.accdb;
Hibernate から Access のデータ に接続
以下の手順に従って、前のステップで作成した設定を選択します。
- Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
- Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
- Hibernate version を 5.2 に設定します。
- Browse ボタンをクリックし、プロジェクトを選択します。
- Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
- Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
- 新しく作成した Hibernate 設定ファイルの Database ノードを展開します。
Access のデータ のリバースエンジニアリング
以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。
- Package Explorer に戻ります。
- プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
- src を親フォルダとして選択し、Next をクリックします。
- Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
- ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。
Hibernate の実行設定
以下の手順に従って、Access テーブルの POJO(Plain Old Java Object)を生成します。
- メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
- Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
- Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所(このデモでは src フォルダ内)を選択します。
- Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
- Run をクリックします。
前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。
マッピングタグの挿入
生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:
cdata.access.AccessDriver
jdbc:access:DataSource=C:/MyDB.accdb;
org.hibernate.dialect.SQLServerDialect
SQL の実行
前のステップで作成したエンティティを使用して、Access のデータ のデータの検索と変更が可能になります:
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 Orders O WHERE ShipCity = :ShipCity";
Query q = session.createQuery(SELECT, Orders.class);
q.setParameter("ShipCity","New York");
List<Orders> resultList = (List<Orders>) q.list();
for(Orders s: resultList){
System.out.println(s.getOrderName());
System.out.println(s.getFreight());
}
}
}