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

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

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

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

Hibernate 構成ファイルを追加

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

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.amazons3.AmazonS3Driver

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

     Amazon S3 リクエストを認可するには、管理者アカウントまたはカスタム権限を持つIAM ユーザーの認証情報を入力します。AccessKey をアクセスキーID に設定します。SecretKey をシークレットアクセスキーに設定します。

     Note: AWS アカウント管理者として接続できますが、AWS サービスにアクセスするにはIAM ユーザー認証情報を使用することをお勧めします。

     尚、本製品はAmazon S3 のファイルの一覧表示やユーザー管理情報の取得用です。S3 に保管されているExcel、CSV、JSON などのファイル内のデータを読み込みたい場合には、Excel Driver、CSV Driver、JSON Driver をご利用ください。

     アクセスキーの取得

     IAM ユーザーの資格情報を取得するには：

     1. IAM コンソールにサインインします。
     2. ナビゲーションペインで「ユーザー」を選択します。
     3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してから「セキュリティ認証情報」タブを選択します。

     AWS ルートアカウントの資格情報を取得するには：

     1. ルートアカウントの資格情報を使用してAWS 管理コンソールにサインインします。
     2. アカウント名または番号を選択し、表示されたメニューで「My Security Credentials」を選択します。
     3. 「Continue to Security Credentials」をクリックし、「Access Keys」セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

     AWS ロールとして認証

     多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。RoleARN を指定することでAWS ロールを代わりに使用できます。これにより、本製品は指定されたロールの資格情報を取得しようと試みます。

     （すでにEC2 インスタンスなどで接続されているのではなく）AWS に接続している場合は、ロールを引き受けるIAM ユーザーのAccessKey とSecretKey を追加で指定する必要があります。AWS ルートユーザーのAccessKey および SecretKey を指定する場合、ロールは使用できません。

     SSO 認証

     SSO 認証を必要とするユーザーおよびロールには、RoleARN およびPrincipalArn 接続プロパティを指定してください。各Identity Provider に固有のSSOProperties を指定し、AccessKey とSecretKey を空のままにする必要があります。これにより、本製品は一時的な認証資格情報を取得するために、リクエストでSSO 認証情報を送信します。

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

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

     java -jar cdata.jdbc.amazons3.jar

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

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

     jdbc:amazons3:AccessKey=a123;SecretKey=s123;

Hibernate のAmazon S3 データへの接続

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

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

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

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

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

前の手順で作成したエンティティを使用して、Amazon S3 のsearchを行うことができます。 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 ObjectsACL O WHERE Name = :Name"; Query q = session.createQuery(SELECT, ObjectsACL.class); q.setParameter("Name","TestBucket"); List<ObjectsACL> resultList = (List<ObjectsACL>) q.list(); for(ObjectsACL s: resultList){ System.out.println(s.getName()); System.out.println(s.getOwnerId()); } } }