MongoDB Scala驱动Set字段反序列化异常：是否需自定义编解码器？

这个问题我之前也碰到过，核心原因是Mongo Scala驱动的宏编解码器默认会把MongoDB中的数组解码成Scala的List（也就是堆栈里的scala.collection.immutable.$colon$colon，List的底层实现类），但你的Config case class里定义的是Set类型字段，所以直接抛出了类型转换异常。针对这个问题，你有两种可行的解决方案：

方案一：编写自定义Set编解码器（推荐） #

你需要为Set类型实现一个通用的编解码器，让驱动能正确将MongoDB数组和Scala Set互相转换。

1. 实现通用Set编解码器 #

import org.bson.codecs.{Codec, DecoderContext, EncoderContext}
import org.bson.{BsonReader, BsonWriter}
import scala.collection.immutable.Set

class SetCodec[T](private val itemCodec: Codec[T]) extends Codec[Set[T]] {
  // 编码：将Scala Set转为MongoDB数组
  override def encode(writer: BsonWriter, value: Set[T], encoderContext: EncoderContext): Unit = {
    writer.writeStartArray()
    value.foreach(item => itemCodec.encode(writer, item, encoderContext))
    writer.writeEndArray()
  }

  // 解码：将MongoDB数组转为Scala Set
  override def decode(reader: BsonReader, decoderContext: DecoderContext): Set[T] = {
    reader.readStartArray()
    val setBuilder = Set.newBuilder[T]
    while (reader.readBsonType() != org.bson.BsonType.END_OF_DOCUMENT) {
      setBuilder += itemCodec.decode(reader, decoderContext)
    }
    reader.readEndArray()
    setBuilder.result()
  }

  override def getEncoderClass: Class[Set[T]] = classOf[Set[T]]
}

2. 编写CodecProvider自动适配泛型类型 #

为了让驱动能自动识别Set的泛型参数（比如Set[Location]、Set[Language]），需要实现一个CodecProvider：

import org.bson.codecs.configuration.{CodecProvider, CodecRegistry}
import java.lang.reflect.ParameterizedType

class SetCodecProvider extends CodecProvider {
  override def get[T](clazz: Class[T], registry: CodecRegistry): Codec[T] = {
    if (classOf[Set[_]].isAssignableFrom(clazz)) {
      // 获取Set的泛型参数类型
      val genericType = clazz.getGenericSuperclass.asInstanceOf[ParameterizedType]
      val itemClass = genericType.getActualTypeArguments(0).asInstanceOf[Class[_]]
      // 获取泛型类型对应的编解码器
      val itemCodec = registry.get(itemClass)
      new SetCodec(itemCodec).asInstanceOf[Codec[T]]
    } else {
      null // 返回null表示不处理该类型
    }
  }
}

3. 注册自定义编解码器到CodecRegistry #

更新你的数据库连接配置，把SetCodecProvider加入编解码器注册表：

private val customCodecs = fromProviders(classOf[Config], classOf[Language], classOf[Location], classOf[JobPortal], classOf[WorkArea])
private val javaCodecs = fromCodecs(new LocalDateTimeDateCodec(), new LocalDateDateCodec())
private val setCodecProvider = new SetCodecProvider()
// 注意顺序：自定义Provider要放在前面，优先使用
private val codecRegistry = fromRegistries(
  CodecRegistries.fromProviders(setCodecProvider),
  customCodecs,
  javaCodecs,
  DEFAULT_CODEC_REGISTRY
)

val dbConnection = MongoClient(dbURI)
val database: MongoDatabase = dbConnection.getDatabase(dbName).withCodecRegistry(codecRegistry)

方案二：临时调整字段类型（快速 workaround） #

如果不想编写自定义编解码器，可以暂时把Config中的Set字段改为List，然后在业务逻辑中转为Set使用：

case class Config(
  _id: Option[ObjectId] = None, 
  var locations: List[Location] = List(), 
  var languages: List[Language] = List(), 
  var workAreas: List[WorkArea] = List(), 
  var websites: List[WebSite] = List()
) {
  // 提供转为Set的便捷方法
  def locationsSet: Set[Location] = locations.toSet
  def languagesSet: Set[Language] = languages.toSet
  def workAreasSet: Set[WorkArea] = workAreas.toSet
  def websitesSet: Set[WebSite] = websites.toSet
}

这种方法不需要修改编解码器，但会改变数据模型，适合快速验证问题，长期来看还是方案一更规范。

补充说明 #

Mongo Scala驱动的宏编解码器是基于反射自动生成的，默认会将MongoDB的数组类型映射为Scala的List（因为List是Scala的默认集合类型）。而Set是无序、不可重复的集合，宏编解码器没有内置这种类型的转换逻辑，所以必须手动提供自定义编解码器来处理。

内容的提问来源于stack exchange，提问作者BPetike