ドキュメントのデータ形式: レコード

Overview

このガイドでは、 Java レコードを使用して MongoDB Java ドライバー にデータを保存および検索する方法を学習します。 Java レコードは、データをモデル化し、ビジネス ロジックをデータ表現から分離するためによく使用される Java クラスのタイプです。

レコードの直列化と逆直列化

ドライバーは、デフォルトの コーデック レジストリを使用して MongoDB の読み取りおよび書込み (write) 操作の Java レコードのエンコードとデコードをネイティブでサポートしています。 デフォルトのコーデック レジストリは、Java 型をエンコードおよびデコードする方法を定義するコーデックと呼ばれるクラスのコレクションです。 コーデックとデフォルトのコーデック レジストリの詳細については、「 コーデック に関するガイド」を参照してください。

public record DataStorageRecord(
        String productName,
        double capacity
) {}

MongoCollection<DataStorageRecord> collection = database.getCollection("data_storage_devices", DataStorageRecord.class);
// insert the record
collection.insertOne(new DataStorageRecord("2TB SSD", 1.71));

MongoCollection<DataStorageRecord> collection = database.getCollection("data_storage_devices", DataStorageRecord.class);
// retrieve and print the records
List<DataStorageRecord> records = new ArrayList<DataStorageRecord>();
collection.find().into(records);
records.forEach(System.out::println);

DataStorageRecord[productName=1TB SSD, capacity=1.71]

注釈を使用したコンポーネント変換の指定

このセクションでは、注釈を使用してレコード コンポーネントの直列化動作を構成する方法について説明します。 サポートされている注釈の完全なリストについては、 org.bson.codecs.pojo.annotations パッケージ API ドキュメントを参照してください。

import org.bson.BsonType;
import org.bson.codecs.pojo.annotations.BsonProperty;
import org.bson.codecs.pojo.annotations.BsonId;
import org.bson.codecs.pojo.annotations.BsonRepresentation;
public record NetworkDeviceRecord(
        @BsonId()
        @BsonRepresentation(BsonType.OBJECT_ID)
        String deviceId,
        String name,
        @BsonProperty("type")
        String deviceType
        )
{}

MongoCollection<NetworkDeviceRecord> collection = database.getCollection("network_devices", NetworkDeviceRecord.class);
// insert the record
String deviceId = new ObjectId().toHexString();
collection.insertOne(new NetworkDeviceRecord(deviceId, "Enterprise Wi-fi", "router"));

{
  _id: ObjectId("fedc..."),
  name: 'Enterprise Wi-fi',
  type: 'router'
}

MongoCollection<NetworkDeviceRecord> collection = database.getCollection("network_devices", NetworkDeviceRecord.class);
// return all documents in the collection as records
List<NetworkDeviceRecord> records = new ArrayList<NetworkDeviceRecord>();
collection.find().into(records);
records.forEach(System.out::println);

NetworkDeviceRecord[deviceId=fedc..., name=Enterprise Wi-fi, deviceType=router]

再帰型による操作

ドライバーは、ランタイム再帰を発生させずに、再帰的に定義されたレコードのエンコードとデコードをネイティブでサポートしています。 このサポートは、タイプ定義内の複数のレコードタイプのサイクルに拡張されます。 次のコードは、再帰レコードの設計の例を示しています。

public record RecordTree(
        String content,
        RecordTree left,
        RecordTree right
) {}

再帰的に定義されたレコードに対して、他のレコードと同様に読み取りおよび書込み操作を実行できます。 次のコードは、 RecordTree型のコレクションに対して検索操作を実行する方法を示しています。

MongoDatabase database = mongoClient.getDatabase("myDB");
MongoCollection<RecordTree> collection = database.getCollection("myCollection", RecordTree.class);
Bson filter = Filters.eq("left.left.right.content", "Ikatere");
collection.find(filter).forEach(doc -> System.out.println(doc));

RecordTree[content=Ranginui, left=RecordTree[content=..., left=RecordTree[content=..., right=RecordTree[content=Ikatere...]]

レコード コーデックの取得

レコード コーデックを検索するには、 RecordCodecProviderを使用します。 重複コードを最小限に抑えながら、対応する との間で レコード オブジェクトをエンコードおよびデコードするようにコーデックをカスタマイズする場合は、このインターフェースを使用する必要があります。JavaBSON typesコーデックとその使用方法の詳細については、「コーデック 」を参照してください。

レコード コーデックを直接作成することはできませんが、 RecordCodecProviderを使用してコードにレコード コーデックを実装できます。 RecordCodecProviderの詳細については、 API ドキュメントを参照してください。