Circe asJson 不编码抽象基类的属性

Question

假设我有以下抽象基类：

package Models

import reactivemongo.bson.BSONObjectID


abstract class RecordObject {
  val _id: String = BSONObjectID.generate().stringify
}

由以下具体案例类扩展：

package Models

case class PersonRecord(name: String) extends RecordObject

然后我尝试使用如下代码获取 JSON 字符串：

import io.circe.syntax._
import io.circe.generic.auto._
import org.http4s.circe._
// ...

val person = new PersonRecord(name = "Bob")
println(person._id, person.name) // prints some UUID and "Bob"
println(person.asJso) // {"name": "Bob"} -- what happened to "_id"? 

如您所见，继承自RecordObject 的属性_id: String 丢失了。我希望内置编码器应该可以很好地用于这个用例。我真的需要自己构建吗？

Answer 1

让我们看看编码器生成过程中发生了什么。 Circe 使用 shapeless 来派生其编解码器，因此足以检查 shapeless 解析为什么来回答您的问题。所以在菊石中：

@ abstract class RecordObject {
    val _id: String = java.util.UUID.randomUUID.toString
  }
defined class RecordObject

@ case class PersonRecord(name: String) extends RecordObject
defined class PersonRecord

@  import $ivy.`com.chuusai::shapeless:2.3.3`, shapeless._
import $ivy.$                             , shapeless._

@ Generic[PersonRecord]
res3: Generic[PersonRecord]{type Repr = String :: shapeless.HNil} = ammonite.$sess.cmd3$anon$macro$2$1@1123d461

好的，那就是String :: HNil。很公平 - shapeless 所做的是提取构造函数中可用的所有字段转换一种方式，如果转换另一种方式，则通过构造函数将所有字段放回。

基本上所有类型类派生都以这种方式工作，因此您应该可以将_id 作为构造函数传递：

abstract class RecordObject {
    val _id: String
}

case class PersonRecord(
  name: String,
  _id: String = BSONObjectID.generate().stringify
) extends RecordObject

这将有助于类型类派生完成它的工作。如果您无法更改 PersonRecord 的外观......那么是的，您必须编写自己的编解码器。虽然我怀疑这会很容易，因为您使 _id 不可变并且无法通过构造函数从外部设置，因此使用任何其他方式也很难实现。