Kotlin Sync ドライバーを使い始める

Kotlin プロジェクトの作成

まず、システムに Kotlin がインストールされ、JDK 1.8以降で実行されていることを確認します。

IntelliJ IDEA などの統合開発環境（IDE）の使用をお勧めします。または Eclipse IDE を使用して、 Gradle または Maven を構成し、プロジェクトをビルドおよび実行することをお勧めします。

Kotlin の使用を開始し、最初のプロジェクトを作成する方法の詳細については、 「 Kotlin/JVM を使い始める 」を 参照してください。 Kotlin 言語ドキュメント。

ドライバー 請求書を追加する

IDE で、新しい Maven または Gradleプロジェクトを作成します。 MongoDB JVMアーティファクトのアイテム請求書（BOM）をプロジェクトに追加して、依存関係バージョンを整理します。 BOM は、 Kotlin Syncドライバーと Core ドライバー ライブラリ間など、一貫した互換性のあるバージョンの依存関係を維持することで、依存関係の管理を簡素化します。 BOM を使用すると、バージョンの競合を回避し、アップグレードを簡素化できます。

次の Maven タブと Gradle タブから選択すると、各依存関係マネージャーに BOM を追加する手順が表示されます。

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.mongodb</groupId>
            <artifactId>mongodb-driver-bom</artifactId>
            <version>5.5.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

dependencies {
    implementation(platform("org.mongodb:mongodb-driver-bom:5.5.0"))
}

BOM が管理する依存関係のリストを表示するには、 Maven Repositoryウェブサイトの mongodb-Driver-bom 依存関係リスト を参照してください。

MongoDB を依存関係として追加する

Gradle を使用してパッケージを管理している場合は、次のエントリをbuild.gradle.kts依存関係リストに追加します。

dependencies {
    implementation("org.mongodb:mongodb-driver-kotlin-sync")
}

Maven を使用してパッケージを管理している場合は、次のエントリをpom.xml依存関係リストに追加します。

<dependencies>
    <dependency>
        <groupId>org.mongodb</groupId>
        <artifactId>mongodb-driver-kotlin-sync</artifactId>
    </dependency>
</dependencies>

BOM をインストールしたため、 Kotlin Syncドライバーの依存関係エントリでバージョンを省略できます。 BOM で指定したバージョンによって、インストールする依存関係バージョンが決まります。

依存関係を構成したら、依存関係マネージャーを実行し、IDE でプロジェクトを更新して、依存関係がプロジェクトで使用できることを確認します。

直列化ライブラリの依存関係を追加する

ドライバーで Kotlin オブジェクトと MongoDB のドキュメントのデータ形式である BSON の間で変換できるようにするには、次の直列化パッケージの 1 つまたは両方をアプリケーションに追加する必要があります。

• bson-kotlinx （推奨）

• bson-kotlin

Gradle を使用してパッケージを管理している場合は、次のいずれかのエントリをbuild.gradle.kts依存関係リストに追加します。

implementation("org.mongodb:bson-kotlinx")
// OR
implementation("org.mongodb:bson-kotlin")

Maven を使用してパッケージを管理している場合は、次のいずれかのエントリをpom.xml依存関係リストに追加します。

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>bson-kotlinx</artifactId>
</dependency>
<!--OR-->
<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>bson-kotlin</artifactId>
</dependency>

依存関係を構成したら、依存関係マネージャーを実行し、IDE でプロジェクトを更新して、依存関係がプロジェクトで使用できることを確認します。

これらのパッケージの詳細については、 Kotlin 直列化 を参照してください。

Atlas で無料の MongoDB 配置を作成

Atlas の使用開始ガイドを完了して、新しい Atlas アカウントを設定し、サンプル データを新しい無料階層 MongoDB 配置にロードします。

認証情報の保存

データベースユーザーを作成したら、ユーザーのユーザー名とパスワードを安全な場所に保存して、後の手順で使用します。

MongoDB Atlas 接続文字列を見つける

前のステップ で作成した配置の接続文字列を取得するには、AtlasDatabase アカウントにログ、Connect セクションに移動し、新しい配置の [ ボタンをクリックします。

Connect your applicationセクションに進み、 Driver選択メニューからKotlinを選択します。

Password (SCRAM)認証メカニズムを選択します。

接続stringのみを表示するには、Include full driver code example オプションの選択を解除します。

接続stringのコピー

次のスクリーンショットに示すように、接続stringの右側にある ボタンをクリックして、クリップボードにコピーします。

プレースホルダーを更新します

この接続stringをテキストエディタのファイルに貼り付け、<username> と <password> のプレースホルダーをデータベースユーザーのユーザー名とパスワードに置き換えます。

このファイルを安全な場所に保存して、次の手順で使用します。

アプリケーション ファイルを作成する

プロジェクトにDemoDataClassExample.ktというファイルを作成します。

次のサンプル コードを ファイルにコピーし、<connection URI string> プレースホルダーの値を、前の手順で保存したMongoDB Atlas接続stringに置き換えます。

import com.mongodb.client.model.Filters.eq
import com.mongodb.kotlin.client.MongoClient
// Create data class to represent a MongoDB document
data class Movie(val title: String, val year: Int, val directors: List<String>)
fun main() {
    // Replace the placeholder with your MongoDB deployment's connection string
    val uri = "<connection URI string>"
    val mongoClient = MongoClient.create(uri)
    val database = mongoClient.getDatabase("sample_mflix")
    val collection = database.getCollection<Movie>("movies")
    // Find a document with the specified title
    val doc = collection.find(eq(Movie::title.name, "Before Sunrise")).firstOrNull()
    if (doc != null) {
        // Print the matching document
        println(doc)
    } else {
        println("No matching documents found.")
    }
}

アプリケーションの実行

アプリケーションを実行すると、次の出力に示すように、クエリに一致する映画ドキュメントの詳細が出力されます。

Movie(title=Before Sunrise, year=1995, directors=[Richard Linklater])

出力が表示されない場合やエラーが表示される場合は、アプリケーションに適切な接続stringが含まれているかどうかを確認してください。 また、サンプル データセットが MongoDB Atlas クラスターに正常にロードされたことを確認してください。

この手順を完了すると、 Kotlin Sync ドライバーを使用して MongoDB クラスターに接続し、サンプル データに対してクエリを実行し、結果を出力する動作するアプリケーションが作成されます。

ドキュメント クラスを使用したデータのモデル化（代替）

前の手順では、 Kotlin データ クラス を使用してサンプル コレクションに対してクエリを実行し、データを取得する方法を示します。 このセクションでは、 ドキュメント を使用する方法を示します MongoDB からデータを保存および検索するためのクラス。

DemoDocumentExample.ktというファイルに次のサンプル コードを貼り付けて、MongoDB Atlas のサンプル データセットに対してクエリを実行します。 <connection URI string> プレースホルダーの値を [ MongoDB Atlas接続string ] に置き換えます。

import com.mongodb.client.model.Filters.eq
import com.mongodb.kotlin.client.MongoClient
import org.bson.Document
fun main() {
    // Replace the placeholder with your MongoDB deployment's connection string
    val uri = "<connection URI string>"
    val mongoClient = MongoClient.create(uri)
    val database = mongoClient.getDatabase("sample_mflix")
    val collection = database.getCollection<Document>("movies")
    // Find a document with the specified title
    val doc = collection.find(eq("title", "Before Sunrise")).firstOrNull()
    if (doc != null) {
        // Print the matching document
        println(doc)
    } else {
        println("No matching documents found.")
    }
}

アプリケーションを実行すると、次の出力に示すように、クエリに一致する映画ドキュメントの詳細が出力されます。

Document{{_id=..., plot=A young man and woman ..., genres=[Drama, Romance], ...}}

出力が表示されない場合やエラーが表示される場合は、アプリケーションに適切な接続stringが含まれているかどうかを確認してください。 また、サンプル データセットが MongoDB Atlas クラスターに正常にロードされたことを確認してください。