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

Jerod Johnson
Director, Technology Evangelism

オブジェクトリレーショナルマッピング（ORM）技術を使用すると、リレーショナルデータソースの操作が容易になり、論理的なビジネスモデルと物理ストレージモデルを橋渡しできます。本記事では、Java ベースの ORM フレームワーク Hibernate に RabbitMQ のデータへの接続を組み込む方法を説明します。

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

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

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

Hibernate 設定ファイルの追加

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

新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
src を親フォルダとして選択し、Next をクリックします。
以下の値を入力します:
- Hibernate version:: 5.2
- Database dialect: Derby
- Driver class: cdata.jdbc.api.APIDriver
- Connection URL: JDBC URL です。jdbc:api: から始まり、セミコロン区切りの接続プロパティが続きます。
  
  RabbitMQ Management HTTP API について
  
  RabbitMQ は、複数のメッセージングプロトコルをサポートするオープンソースのメッセージブローカーです。RabbitMQ Management HTTP API は、RabbitMQ サーバーの管理データと監視データに HTTP 経由でアクセスする手段を提供します。この API では、仮想ホスト、エクスチェンジ、キュー、バインディング、コネクション、チャネル、コンシューマー、ユーザー、権限、ポリシー、クラスター全体の統計情報を取得できます。
  
  HTTP API を利用するには、RabbitMQ サーバーで Management プラグインを有効化する必要があります。デフォルトでは、管理インターフェースはポート 15672 でリッスンします。
  
  Basic 認証の設定
  
  RabbitMQ Management HTTP API は HTTP Basic 認証を使用します。RabbitMQ 管理ユーザーのユーザー名とパスワードを指定する必要があります。
  
  管理 API へのアクセスを有効にするには、以下のステップで進めます：
  1. サーバーで RabbitMQ Management プラグインが有効になっていることを確認します（rabbitmq-plugins enable rabbitmq_management）。
  2. 既存の管理ユーザーを使用するか、適切な管理タグ（management、policymaker、monitoring、または administrator）を持つユーザーを作成します。
  3. RabbitMQ Management HTTP API の完全なベース URL を控えておきます（例：http://localhost:15672）。
  RabbitMQ サーバーを設定したら、以下の接続プロパティを設定して接続します：
  - AuthScheme：Basic に設定します。
  - URL：RabbitMQ Management HTTP API のベース URL に設定します（例：http://localhost:15672）。
  - User：RabbitMQ の管理ユーザー名に設定します（例：guest）。
  - Password：RabbitMQ の管理パスワードに設定します。
  接続文字列の例：
```
Profile=C:\profiles\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
```
  利用可能なテーブル
  
  RabbitMQ プロファイルでは、以下のテーブルにアクセスできます：
  - Overview - クラスター全体の統計情報と RabbitMQ ノードに関する情報
  - Nodes - RabbitMQ クラスター内の個々のノードに関する情報
  - NodeMemory - 特定のクラスターノードの詳細なメモリ使用状況の内訳
  - Connections - ブローカーへのすべてのオープンな AMQP コネクションの一覧
  - Channels - すべてのコネクションにわたるオープンな AMQP チャネルの一覧
  - Consumers - すべてのキューに登録されたコンシューマーの一覧
  - Exchanges - すべての仮想ホストで宣言されたエクスチェンジの一覧
  - Queues - すべての仮想ホストで宣言されたキューの一覧
  - Bindings - エクスチェンジとキュー間のすべてのバインディングの一覧
  - VirtualHosts - ブローカーに設定された仮想ホストの一覧
  - VhostPermissions - 特定の仮想ホスト内のユーザー権限
  - Users - すべての RabbitMQ ユーザーの一覧
  - Permissions - すべての仮想ホストにわたる全ユーザーの権限レコード
  - TopicPermissions - 全ユーザーのトピックレベルの権限レコード
  - Policies - 仮想ホスト内のキューおよびエクスチェンジに適用されたポリシーの一覧
  - OperatorPolicies - 仮想ホスト内のキューに適用されたオペレーターポリシーの一覧
  - Parameters - 仮想ホストごとのコンポーネントパラメータ（例：federation、shovel）の一覧
  - GlobalParameters - すべての仮想ホストに適用されるグローバルパラメータの一覧
  - VhostLimits - 特定の仮想ホストに設定されたリソース制限
  - UserLimits - 特定のユーザーに設定されたリソース制限
  - FeatureFlags - フィーチャーフラグの一覧と、ノード上での有効／無効の状態
  - DeprecatedFeatures - 非推奨機能の一覧と、その使用状態
  - AuthAttempts - ノードの認証試行統計
  - ClusterName - RabbitMQ クラスターの名前
  - WhoAmI - 現在認証されている管理ユーザーに関する情報
  - ExchangeBindingsSource - 特定のエクスチェンジがソースとなっているバインディング
  - ExchangeBindingsDestination - 特定のエクスチェンジが宛先となっているバインディング
  - QueueBindings - 仮想ホスト内の特定のキューのバインディング
  組み込みの接続文字列デザイナー
  
  JDBC URL の構築には、RabbitMQ JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから jar ファイルを実行してください。
```
java -jar cdata.jdbc.api.jar
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  一般的な JDBC URL は以下のとおりです:
```
jdbc:api:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
```

Hibernate から RabbitMQ のデータに接続

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

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

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

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

Package Explorer に戻ります。
プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
src を親フォルダとして選択し、Next をクリックします。
Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、RabbitMQ テーブルの 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.api.APIDriver
    
    
      jdbc:api:Profile=C:\profiles\\RabbitMQ.apip;AuthScheme=Basic;URL=http://localhost:15672;User=guest;Password=guest;
    
    
      org.hibernate.dialect.SQLServerDialect

SQL の実行

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


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 AuthAttempts A WHERE NodeName = :NodeName";
    Query q = session.createQuery(SELECT, AuthAttempts.class);
    q.setParameter("NodeName","rabbit@hostname");
    List<AuthAttempts> resultList = (List<AuthAttempts>) q.list();

    for(AuthAttempts s: resultList){
      System.out.println(s.get());
      System.out.println(s.get());
    }
  }
}

はじめる準備はできましたか？

API Driver で RabbitMQ のライブデータに接続

RabbitMQ に接続

CData は、AI を本番環境で機能させるデータレイヤーです。数百の主要エンタープライズソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ

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

Hibernate のインストール

新規プロジェクトの作成

Hibernate 設定ファイルの追加

RabbitMQ Management HTTP API について

Basic 認証の設定

接続文字列の例：

利用可能なテーブル

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

Hibernate から RabbitMQ のデータに接続

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

Hibernate の実行設定

マッピングタグの挿入

SQL の実行

はじめる準備はできましたか？

この記事の内容

関連記事

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

Hibernate のインストール

新規プロジェクトの作成

Hibernate 設定ファイルの追加

RabbitMQ Management HTTP API について

Basic 認証の設定

接続文字列の例：

利用可能なテーブル

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

Hibernate から RabbitMQ のデータ に接続

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

Hibernate の実行設定

マッピングタグの挿入

SQL の実行

はじめる準備はできましたか？

この記事の内容

関連記事

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

Hibernate から RabbitMQ のデータに接続

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