Scala Circe 实现嵌套对象字符串化编码及正常编解码的方法
问题根因
当前实现的解码报错来自编解码逻辑的结构不匹配:
- 自定义的
Encoder[Mailbox]会将 Mailbox 类型直接序列化为JSON字符串,不生成嵌套对象 - 配套使用的
deriveDecoder[Mailbox]是针对嵌套对象结构生成的解码器,会在当前JSON位置下查找名为value的子字段。但实际JSON中mailbox字段是纯字符串值,不存在嵌套子对象,因此游标查找失败,抛出对应的DecodingFailure错误。
修正步骤
只需要将Mailbox的解码器替换为和编码器结构对齐的实现,直接读取当前位置的字符串值并映射为Mailbox实例即可:
- 不再使用自动派生的嵌套结构解码器
- 基于Circe内置的字符串解码器,通过map操作将读到的字符串包装为Mailbox类型
- 由于这两个编解码实例定义在Mailbox的伴生对象中,Group类型的自动派生编解码会自动识别并使用它们,不需要为Group单独编写自定义逻辑
正确实现的完整代码
import io.circe.{Decoder, Encoder, Json} import io.circe.parser import io.circe.syntax._ // 原有样例类定义保持不变 case class Mailbox(value: String) case class Group(objectType: String, mailbox: Mailbox) object Mailbox { // 原有编码器逻辑保持不变 implicit val encoder: Encoder[Mailbox] = (m: Mailbox) => Json.fromString(m.value) // 替换为和编码器结构对齐的解码器:直接读当前位置的字符串,不查找嵌套字段 implicit val decoder: Decoder[Mailbox] = Decoder.decodeString.map(Mailbox(_)) } object Sandbox { def main(args: Array[String]): Unit = { val group: Group = Group("Group", Mailbox("mailto:info@example.com")) // 编码输出目标JSON结构 val json: String = group.asJson.spaces2 println(json) // 正确解码流程 parser.decode[Group](json) match { case Right(group) => println(s"解码成功:$group") case Left(err) => println(s"解码失败:$err") } } }
运行后输出效果
- 编码生成的JSON完全匹配预期结构,没有嵌套的mailbox对象:
{ "objectType" : "Group", "mailbox" : "mailto:info@example.com" }
- 解码流程可以正常执行,正确解析回Group实例,不会抛出光标查找失败的错误。
常见避坑提示
- 同一类型的编码器和解码器必须对应完全一致的JSON结构,不能出现编码器输出纯字符串、解码器解析嵌套对象的错配情况
- 定义在伴生对象中的自定义编解码实例优先级高于自动派生的逻辑,不需要额外手动为Group类型编写自定义编解码规则,自动派生机制会自动识别使用Mailbox的自定义编解码实现
- 编写这类扁平映射的解码器时,不需要额外使用
downField查找子字段。Group类型的自动派生解码器在处理mailbox字段时,会自动将光标移动到mailbox对应的JSON值位置,再调用Mailbox的解码器处理,因此解码器直接读取当前光标位置的字符串即可。如果额外添加字段查找逻辑,会再次触发光标失败的错误。
内容的提问来源于stack exchange,提问作者Andrew Kirk
相关产品推荐
相关产品推荐

