GUID

Overview

In this guide, you can learn how to serialize globally unique identifiers (GUIDs), also known as universally unique identifiers (UUIDs).

MongoDB の GUID

GUID は 16 バイトの整数で、MongoDB ドキュメントのユニークな ID として使用できます。次のコード ブロックは、GUID の例を示しています。

00112233-4455-6677-8899-aabbccddeeff

MongoDB は元々、GUIDBsonBinaryData をサブタイプ3 の 値として表していました。サブタイプ3 はエンコード中に GUID のバイト順序を標準化しなかったため、さまざまなMongoDBドライバーは GUID を異なるバイト順でエンコードしました。

次のタブには、前述の GUID から BsonBinaryData サブタイプ 3 へのさまざまなドライバー エンコーディングが表示されます。

33221100-5544-7766-8899-aabbccddeeff

00112233-4455-6677-8899-aabbccddeeff

77665544-3322-1100-ffee-ddccbbaa9988

アプリケーション間で GUID バイト順序を標準化するために、すべてのMongoDBドライバーが同じ方法でエンコードする BsonBinaryData サブタイプ 4 を追加しました。アプリケーションで GUID を使用する場合は、BsonBinaryData サブタイプ 4 を使用して保存することをお勧めします。

var doc = new MyDocument { Name = "Test" }; // Id will default to Guid.Empty
collection.InsertOne(doc); // doc.Id will now contain a generated GUID, not Guid.Empty

var collectionSettings = new MongoCollectionSettings { AssignIdOnInsert = false }
var collection = database.GetCollection<MyDocument>("MyCollection", collectionSettings);

全 BsonBinaryData サブタイプの一覧については、 BsonBinarySubType 列挙型のAPIドキュメントを参照してください。

GUID の直列化

すべての新しい BsonBinaryData GUID にサブタイプ 4 を使用することを推奨していますが、古い MongoDB コレクションには、サブタイプ 3 を使用する GUID フィールドとサブタイプ 4 を使用する GUID フィールドが含まれている場合があります。これらの違いを考慮するために、.NET/C# ドライバーは個々のプロパティのレベルで GUID 直列化を処理します。

.NET/C# ドライバーは GuidRepresentation 列挙型を使用してさまざまな BsonBinaryData サブタイプを表します。次の表は、GuidRepresentation 列挙メンバーと、それに対応する BsonBinaryData サブタイプを示しています。

CSharpLegacy 、JavaLegacy 、PythonLegacy GUID 表現はすべて BsonBinaryData サブタイプ 3 と同じですが、使用するバイト順が異なります。

var guid = new Guid("00112233-4455-6677-8899-aabbccddeeff");
var legacyGuid = new BsonBinaryData(guid, GuidRepresentation.CSharpLegacy);
var filter = new BsonDocument("legacyGuidField", legacyGuid);

次のセクションでは、アプリケーションで GUID 表現を構成する方法について説明します。

public class Widget
{
    public int Id { get; set; }
   [BsonGuidRepresentation(GuidRepresentation.Standard)]
   public Guid G { get; set; }
}

var guidSerializer = new GuidSerializer(GuidRepresentation.Standard);

BsonSerializer.RegisterSerializer(new GuidSerializer(GuidRepresentation.Standard));

オブジェクトの直列化

ObjectSerializer を使用して、階層オブジェクトをサブドキュメントに直列化できます。これらのオブジェクト内の GUID を正しく直列化および逆直列化するには、ObjectSerializer の構築時に正しい GUID 表現を選択します。

次のコード サンプルは、サブタイプ 4 の GUID 表現の ObjectSerializer を作成する方法を示しています。

var objectDiscriminatorConvention = BsonSerializer.LookupDiscriminatorConvention(typeof(object));
var objectSerializer = new ObjectSerializer(objectDiscriminatorConvention, GuidRepresentation.Standard);

アプリケーションで ObjectSerializer を使用して GUID を直列化する場合は、アプリケーションの早い段階（ブートストラップ段階など）でもシリアライザーを登録する必要があります。登録したシリアライザーは、オブジェクト シリアライザーが必要で、特に指定されていない場合は常にグローバルに使用されます。

ObjectSerializer を登録するには、BsonSerializer.RegisterSerializer() メソッドに渡します。

var objectDiscriminatorConvention = BsonSerializer.LookupDiscriminatorConvention(typeof(object));
var objectSerializer = new ObjectSerializer(objectDiscriminatorConvention, GuidRepresentation.Standard);
BsonSerializer.RegisterSerializer(objectSerializer);

詳細情報

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

• BsonBinaryData

• BsonGuidRepresentation

• GuidSerializer

• ObjectSerializer

• GuidRepresentation