Overview
Hibernate ORM を使用すると、Javaオブジェクトを使用してデータベース操作を実行できます。また、Hibernate ORM 用の MongoDB Extension を使用すると、アプリケーションと MongoDB データのやり取りを簡素化できます。このガイドでは、Hibernate ORM 拡張機能のインストール、MongoDB配置を設定し、MongoDBコレクションにマップされたクラスを定義するJavaアプリケーションを作成する方法を示します。
Tip
MongoDB Atlas は、MongoDB 配置をホストする完全管理のクラウドデータベース サービスです。このガイドの手順に従い、独自の無料（クレジット カード不要）MongoDB Atlas 配置を作成できます。
ダウンロードとインストール
依存関係のインストール
開発を開始する前に、ローカル マシンに次の依存関係がインストールされていることを確認してください。
Javaバージョン 17 以降
注意
このチュートリアルでは、IDE で Maven または Gradle を使用してアプリケーションを作成する方法を示します。IDE を使用しない場合は、プロジェクトのセットアップ方法はMaven のビルドまたは新しい Gradle ビルドの作成を参照してください。
拡張機能のインストール
IDE に、MongoHibernateQuickstart という名前の新しい Maven または Gradleプロジェクトを作成します。Maven プロジェクトの場合は、次の依存関係を pom.xmlファイルに追加します。
<dependencies> <dependency> <groupId>org.mongodb</groupId> <artifactId>mongodb-hibernate</artifactId> <version>1.0.0</version> </dependency></dependencies>Gradle プロジェクトの場合は、次の依存関係を build.gradleファイルに追加します。
dependencies { implementation("org.mongodb:mongodb-hibernate:1.0.0")}IDE で、プロジェクトが 再ロードされているか、 が同期されている ことを確認してください。
これらの手順を完了すると、 Hibernetes ORM 拡張機能がインストールされ、 IDE に新しい Maven または Gradleプロジェクトが設定されます。
MongoDB 配置の作成
MongoDB Atlas で無料のクラスターを作成して、データを保存および管理できます。MongoDB Atlas は、クラウドで MongoDB データベースをホストし、管理します。
Atlas で無料の MongoDB 配置を作成
MongoDB の使用開始ガイドを完了して、新しい Atlas アカウントを設定し、サンプルデータを新しい無料階層のMongoDB配置にロードします。Cloud Deployment タブの手順に従って、クラウドにMongoDB Atlas の配置を作成します。
これらの手順を完了すると、Atlas に新しい無料クラスター、データベースユーザーの認証情報、およびデータベースにロードされたサンプルデータが用意されます。
接続文字列の作成
MongoDB配置に接続するには、 接続string とも呼ばれる 接続 URIMongoDB を提供します。これは、 配置に接続する方法と接続中の動作をドライバーに指示します。
接続stringには、配置のホスト名またはIPアドレスとポート、認証メカニズム、ユーザー認証情報（該当する場合）、および接続オプションが含まれます。
これらの手順を完了すると、ユーザー名、パスワード、およびデータベースを含む接続文字列が作成されます。
アプリケーションを構成する
Hibernetes ORM 拡張機能をインストールし、 MongoDB Atlasクラスターを作成したら、 MongoDBに接続するJavaアプリケーションを作成できます。
アプリケーションをMongoDBに接続する
MongoHibernateQuickstart プロジェクトの src/main/resourcesディレクトリに移動し、アプリケーションの構成設定を保存する hibernate.properties という名前の新しいファイルを作成します。
次のコードをこのファイルにコピーします。
jakarta.persistence.jdbc.url=<connection string>com.mongodb.hibernate.semantics.nulls=MQLjakarta.persistence.jdbc.urlプロパティで、<connection string> プレースホルダーを前の手順で作成した接続文字列に置き換えます。
MongoDB 接続文字列は、hibernate.dialect プロパティを MongoDB に自動的に構成します。
com.mongodb.hibernate.semantics.nulls プロパティは、null 値を比較するクエリが MQL セマンティクスに従うことを保証します。このプロパティの詳細については、「クエリの指定」ガイドの「必須の Null セマンティクス構成プロパティ」を参照してください。
セッションを管理するためのユーティリティクラスを作成する
注意
デフォルトのパッケージ ディレクトリ
このチュートリアルでは、Maven と Gradle のデフォルトの org.exampleパッケージを使用し、アプリケーションファイルを src/main/java/org/exampleディレクトリに追加します。別のパッケージ名を使用する場合は、対応するディレクトリにファイルを作成していることを確認してください。
プロジェクトの src/main/java/org/exampleディレクトリに、HibernateUtil.java という新しいファイルを作成します。このユーティリティクラスは、構成ファイルに基づいて SessionFactory を作成します。
次のコードをこのファイルにコピーします。
package org.example;
import org.hibernate.SessionFactory;import org.hibernate.cfg.Configuration;
public final class HibernateUtil { private static final SessionFactory SESSION_FACTORY = new Configuration() .addAnnotatedClass(Movie.class) .buildSessionFactory();
private HibernateUtil() {}
public static SessionFactory getSessionFactory() { return SESSION_FACTORY; }}Movie エンティティを定義する
プロジェクトの org/exampleディレクトリに、Movie.java という新しいファイルを作成します。このファイルには、Atlasサンプルデータセットの sample_mflix.moviesサンプルコレクションを表す Movie エンティティが含まれています。
次のコードをこのファイルにコピーします。
package org.example;
import com.mongodb.hibernate.annotations.ObjectIdGenerator;import org.bson.types.ObjectId;import java.util.List;
import jakarta.persistence.Entity;import jakarta.persistence.Id;import jakarta.persistence.Table;
@Entity@Table(name = "movies")public class Movie { @Id @ObjectIdGenerator private ObjectId id; private String title; private String plot; private int year; private List<String> cast; private List<String> directors;
public Movie(String title, String plot, int year, List<String> cast, List<String> directors) { this.title = title; this.plot = plot; this.year = year; this.cast = cast; this.directors = directors; }
public Movie() {
}
public ObjectId getId() { return id; }
public String getTitle() { return title; }
public void setTitle(String title) { this.title = title; }
public String getPlot() { return plot; }
public void setPlot(String plot) { this.plot = plot; } public int getYear() { return year; }
public void setYear(int year) { this.year = year; }
public List<String> getCast() { return cast; } public void setCast(List<String> cast) { this.cast = cast; }
public List<String> getDirectors() { return directors; }
public void setDirectors(List<String> directors) { this.directors = directors; }}このファイルは、次のフィールドを持つ Movie エンティティを定義します。
id: MongoDB_idフィールドにマッピングされる、映画の一意の識別子。title：映画のタイトル。year: 映画が公開された年。cast: 映画のキャストメンバーを表す string のリスト。
Tip
スキーマ修飾子
マッピングでは、@Table アノテーションの schema 要素を設定できます。schema 要素は、構成するデータベース内のコレクション名のプレフィックスとなります。詳細については、「Create Entities」ガイドの「スキーマ Qualifiers」セクションを参照してください。
メインのアプリケーションクラスを定義する
プロジェクトの org/exampleディレクトリに、Main.java という新しいファイルを作成します。このファイルには、アプリケーションのロジックが保存されるメインのアプリケーションのクラスが含まれています。
次のコードをこのファイルにコピーします。
package org.example;
import org.hibernate.Transaction;import org.hibernate.Session;
import java.util.ArrayList;import java.util.List;
public class Main { public static void main(String[] args) {
var sf = HibernateUtil.getSessionFactory(); Session session = sf.openSession(); Transaction tx = session.beginTransaction();
// Add CRUD operations here
tx.commit(); session.close(); sf.close(); }
}これらの手順を完了すると、Hibernate ORM拡張機能を使用し、MongoDB配置に接続するように構成されたJavaアプリケーションが作成されます。アプリケーションのファイル構造は次のとおりです。
MongoHibernateQuickstart├── src│ └── main│ ├── java│ │ └── org/example│ │ ├── HibernateUtil.java│ │ ├── Main.java│ │ └── Movie.java│ └── resources│ └── hibernate.properties├── .gitignore├── pom.xml (for Maven projects)└── build.gradle (for Gradle projects)サンプル クエリの実行
Movie オブジェクトに対してクエリを実行できます。これは拡張機能によってMongoDBクエリに変換されます。
titleフィールドでクエリを実行する
Main.javaファイルに移動し、// Add CRUD operations here コメントの下に次のコードを貼り付けます。
var searchTitle = "Little Women";var results = session.createQuery("from Movie m where m.title = :t", Movie.class) .setParameter("t", searchTitle) .getResultList();for (var m : results) { System.out.println("Title: " + m.getTitle() + ", Year: " + m.getYear());}このコードでは、Hibernate ORM の Hibernate クエリ言語（HQL）を使用して、title の値が "Little Women" である sample_mflix.movies ドキュメントを検索します。次に、各結果の title と year の値が出力されます。
Tip
HQL の詳細については、 Hibernet ORM ユーザーガイドの 非表示のクエリ言語 を参照してください。
MongoDB へのデータの書込み (write)
Movie オブジェクトを作成および変更することで、MongoDB配置にデータを書き込むことができます。
moviesコレクションへのドキュメントの挿入
Main.javaファイルに次のコードを追加して、myMovie という Movie エンティティインスタンスを作成し、データベースに保存します。
var title = "A Real Pain";var plot = "Mismatched cousins David and Benji tour Poland to honor their grandmother. " + "Their adventure becomes complicated as old tensions resurface while exploring their family history.";var year = 2024;var cast = new ArrayList<>(List.of("Jesse Eisenberg", "Kieran Culkin", "Will Sharpe"));
var myMovie = new Movie(title, plot, year, cast);session.persist(myMovie);System.out.println("Movie created with ID: " + myMovie.getId());このコードでは、新しい Movie エンティティインスタンスが作成され、session.persist() メソッドを使用してそれがデータベースに保存されます。
次のステップ
チュートリアルを完了しました。
注意
このチュートリアルで問題が発生した場合は、このページの右側にある Rate this pageタブを使用してフィードバックを提出してください。
MongoDB Stack Overflowタグ または MongoDB Reddit Community を使用して、一般的な質問のサポートを見つけることができます。
このチュートリアルでは、MongoDB AtlasでホストされているMongoDB配置に接続し、Hibernate ORM拡張機能を使用してデータを操作するJavaアプリケーションを作成しました。
Hibernate ORM 拡張機能について詳しく学ぶには、次のリソースを参照してください。
非表示の ORM 拡張APIドキュメント
Java 永続化に関するドキュメント
Hibernate ORM 拡張機能をインストールし、書籍データと交流する方法を示す「使用開始」のチュートリアルについては、Hibernate ORM と MongoDB の使用開始 Foojay のブログ記事を参照してください。