タイプ コーデックによるデータのエンコード

Overview

このガイドでは、ScalaドライバーでScalaオブジェクトとBSONデータのエンコードとデコードを処理するコーデックとサポート クラスについて学習できます。The Codec Scala abstraction allows you to map any Scala type to a corresponding BSON type.これを使用して、Document や BsonDocument などの中間マップベースのオブジェクトに依存する代わりに、ドメイン オブジェクトをBSONとの間で直接マップします。

コーデック インターフェース

Codec インターフェースには、Scala オブジェクトを BSON データとの間でエンコードおよびデコードするための抽象メソッドが含まれています。これらのメソッドを実装して、BSON と、ユーザーの Codec 実装の Scala 型の間の変換ロジックを定義します。

Codecencode()インターフェースを実装するには、インターフェースの 、decode() 、getEncoderClass() メソッドを定義します。これらのメソッドを実装するコード例については、「 基本的なカスタム コーデックの例 」セクションを参照してください。

sealed trait PowerStatus
object PowerStatus {
  case object On extends PowerStatus
  case object Off extends PowerStatus
}

class PowerStatusCodec extends Codec[PowerStatus] {
  override def encode(writer: BsonWriter, value: PowerStatus,
      encoderContext: EncoderContext): Unit = {
    if (value != null) {
      writer.writeBoolean(value == PowerStatus.On)
    }
  }
  override def decode(reader: BsonReader,
      decoderContext: DecoderContext): PowerStatus = {
    if (reader.readBoolean()) PowerStatus.On else PowerStatus.Off
  }
  override def getEncoderClass: Class[PowerStatus] = classOf[PowerStatus]
}

CodecRegistry コレクション

CodecRegistry は、Codec インスタンスの不可変コレクションです。CodecRegistry インスタンスを構築するには、次の CodecRegistries クラスの静的ファクトリメソッドのいずれかを使用します。各メソッドは、異なる Codec インスタンスのソースからレジストリをビルドします。

次の例では、2 つの Codec 実装を使用しています。

• IntegerCodec: BSON パッケージ内の Codec で、Java Integer 値を BSON 32ビット整数値にエンコードします。

• PowerStatusCodec: CodecPowerStatus値をBSONブール値にデコードするサンプル 。

次の例は、fromCodecs() メソッドを使用してこれらの実装をレジストリに割り当てることで CodecRegistry インスタンスを構築する方法を示しています。

val codecRegistry = CodecRegistries.fromCodecs(
  new IntegerCodec(), new PowerStatusCodec()
)

次の例では、前の例の Codec インスタンスを CodecRegistry コレクションから取得します。

val powerStatusCodec: Codec[PowerStatus] =
  codecRegistry.get(classOf[PowerStatus])
val integerCodec: Codec[Integer] =
  codecRegistry.get(classOf[Integer])

val newRegistry = CodecRegistries.fromRegistries(
  CodecRegistries.fromCodecs(new MyEnumCodec()),
  MongoClientSettings.getDefaultCodecRegistry()
)

CodecProvider インターフェース

CodecProvider インターフェースには、Codec インスタンスを作成し、それを CodecRegistry インスタンスに割り当てる抽象メソッドが含まれています。CodecRegistry インターフェースと同様に、CodecProvider インターフェースは Codec インスタンスを返す get() メソッドを定義します。BSON ライブラリはこれらの Codec インスタンスを使用して、Scala と BSON データ型間でエンコードします。

コードにクラスを追加する場合は、そのフィールドに対応する Codec オブジェクトが必要な場合は CodecProvider を使用します。各フィールドに固有の Codec インスタンスが必要な場合は、クラスの Codec インスタンスをインスタンス化する前に、各フィールドの Codec オブジェクトをインスタンス化する必要があります。get() メソッドの CodecRegistry パラメータを使用して、Codec が依存する Codec インスタンスのいずれかをコンストラクタに渡します。

次の例は、CodecProvider インターフェースを実装する方法を示しています。ドライバーは、実装された MonolightCodecProvider インターフェースを使用して、 Monolight クラスの MonolightCodec インスタンスを作成します。

class MonolightCodecProvider extends CodecProvider {
  override def get[T](clazz: Class[T], registry: CodecRegistry): Codec[T] = {
    if (clazz == classOf[Monolight]) {
      new MonolightCodec(registry).asInstanceOf[Codec[T]]
    } else {
      null
    }
  }
}

CodecProviderカスタム クラスを含む インターフェースの完全な実装については、このガイドの「 完全なカスタム コーデックの例 」セクションを参照してください。

このセクションのクラスとインターフェースの詳細については、次の API ドキュメントを参照してください。

• CodecProvider

カスタム Codec の完全な例

このセクションでは、Codec および CodecProvider インターフェースを実装してカスタム Scala クラスのエンコードおよびデコード ロジックを定義する方法を学べることができます。このセクションでは、カスタム実装を指定して使用し、挿入操作と検索操作を実行する方法も示します。

次のコード スニペットは、例としてのカスタム クラス Monolight とそのフィールドを示しています。

case class Monolight(
  powerStatus: PowerStatus = PowerStatus.Off,
  colorTemperature: Int = 0
)

Monolight クラスには次のフィールドが含まれており、それぞれに Codec インターフェースの**実装**が必要です。

• powerStatus ライトがオンまたはオフに切り替えられたかどうかを示します。 PowerStatusCodecクラスは PowerStatus値をBSONブール値にエンコードします。

• colorTemperature はライトの色を記述し、Int 値が含まれます。BSON ライブラリに含まれる IntegerCodec クラスは、colorTemperature 値を BSON 32ビット整数にエンコードします。

次のコード例は、Monolight クラスに Codec インターフェースを実装する方法を示しています。コンストラクターは CodecRegistry インスタンスを使用して、Monolight フィールドをエンコードおよびデコードするために必要な Codec インスタンスを検索します。

class MonolightCodec(registry: CodecRegistry) extends Codec[Monolight] {
  private val powerStatusCodec: Codec[PowerStatus] =
    registry.get(classOf[PowerStatus])
  private val integerCodec: Codec[Integer] =
    registry.get(classOf[Integer])
  override def encode(writer: BsonWriter, value: Monolight,
      encoderContext: EncoderContext): Unit = {
    writer.writeStartDocument()
    writer.writeName("powerStatus")
    powerStatusCodec.encode(writer, value.powerStatus, encoderContext)
    writer.writeName("colorTemperature")
    integerCodec.encode(writer, value.colorTemperature, encoderContext)
    writer.writeEndDocument()
  }
  override def decode(reader: BsonReader,
      decoderContext: DecoderContext): Monolight = {
    var powerStatus: PowerStatus = PowerStatus.Off
    var colorTemperature: Int = 0
    reader.readStartDocument()
    while (reader.readBsonType() != BsonType.END_OF_DOCUMENT) {
      reader.readName() match {
        case "powerStatus" =>
          powerStatus = powerStatusCodec.decode(reader, decoderContext)
        case "colorTemperature" =>
          colorTemperature = integerCodec.decode(reader, decoderContext)
        case "_id" =>
          reader.readObjectId()
        case _ =>
          reader.skipValue()
      }
    }
    reader.readEndDocument()
    Monolight(powerStatus, colorTemperature)
  }
  override def getEncoderClass: Class[Monolight] = classOf[Monolight]
}

以下のコード例は、Monolight クラスのフィールドの Codec インスタンスを構築し、カスタム CodecProvider を実装する方法を示しています。

class MonolightCodecProvider extends CodecProvider {
  override def get[T](clazz: Class[T], registry: CodecRegistry): Codec[T] = {
    if (clazz == classOf[Monolight]) {
      new MonolightCodec(registry).asInstanceOf[Codec[T]]
    } else {
      null
    }
  }
}

get() メソッドは、ドライバーが Monolight クラスの Codec をリクエストすると、新しい MonolightCodec を返します。メソッドは CodecRegistry を MonolightCodec コンストラクタに渡し、MonolightCodec が PowerStatusCodec や IntegerCodec などのフィールドの Codec インスタンスを取得できるようにします。ドライバーが他のクラスの Codec をリクエストすると、メソッドは null を返します。

変換ロジックを定義した後、次の操作を実行できます。

• Monolight クラスのインスタンスのデータを MongoDB に保存する

• MongoDBから Monolightクラスのインスタンスにデータを取得する

次の例では、MonolightCodecProvider クラスを withCodecRegistry() メソッドに渡すことで、MongoCollection インスタンスに割り当てています。次に、insertOne() メソッドを呼び出して新しい Monolight インスタンスをコレクションに挿入し、find() メソッドを呼び出して保存された Monolight インスタンスを返します。出力には、取得された Monolight インスタンスが表示され、カスタム コーデックがデータを正常にエンコードおよびデコードしたことが確認されます。

object MonolightCodecExample {
  def main(args: Array[String]): Unit = {
    val uri = "<connection string URI>"
    val mongoClient = MongoClient(uri)
    val codecRegistry = CodecRegistries.fromRegistries(
      CodecRegistries.fromCodecs(
        new IntegerCodec(), new PowerStatusCodec()
      ),
      CodecRegistries.fromProviders(new MonolightCodecProvider()),
      MongoClientSettings.getDefaultCodecRegistry()
    )
    val database = mongoClient.getDatabase("codecs_example_products")
    val collection: MongoCollection[Monolight] = database
      .getCollection[Monolight]("monolights")
      .withCodecRegistry(codecRegistry)
    val myMonolight = Monolight(PowerStatus.On, 5200)
    Await.result(
      collection.insertOne(myMonolight).toFuture(),
      Duration.Inf
    )
    val lights = Await.result(
      collection.find().toFuture(),
      Duration.Inf
    )
    println(lights)
    mongoClient.close()
  }
}

List(Monolight(On,5200))

このセクションで説明されるメソッドとクラスの詳細については、次の API ドキュメントを参照してください。

• MongoCollection.withCodecRegistry()

• MongoClientSettings.getDefaultCodecRegistry()

• コーデック

• CodecProvider