如何使用Circe解码Scala中的JSON列表/数组

Question

我有代码片段

cursor.downField("params").downField("playlist").downField("items").as[List[Clip]]

Clip是一个简单的字符串和数字类。 传入的Json应该包含一个json对象“播放列表”，其中包含一个“项目”数组，其中每个项目都是一个剪辑。 所以json看起来应该是这样的

{
  "playlist": {
      "name": "Sample Playlist",
      "items": [
        {
          "clipId":"xyz", 
          "name":"abc"
        },
        {
          "clipId":"pqr", 
          "name":"def"
        } 
      ]
   }
}

使用上面的代码片段，我收到编译错误：

 Error:(147, 81) could not find implicit value for parameter d:     
 io.circe.Decoder[List[com.packagename.model.Clip]]
      cursor.downField("params").downField("playlist").downField("items").as[List[Clip]]

我究竟做错了什么？ 如何使用circe为简单项目的列表/数组设置解码？

Answer 1

为了完整起见，您可以创建一个自定义解码器，在其处理中包含导航，而不是导航到JSON值然后解码剪辑：

import io.circe.Decoder, io.circe.generic.auto._

case class Clip(clipId: String, name: String)

val decodeClipsParam = Decoder[List[Clip]].prepare(
  _.downField("params").downField("playlist").downField("items")
)

如果你有这个：

val json = """{ "params": {
  "playlist": {
      "name": "Sample Playlist",
      "items": [
        {
          "clipId":"xyz", 
          "name":"abc"
        },
        {
          "clipId":"pqr", 
          "name":"def"
        } 
      ]
   }
}}"""

您可以像这样使用解码器：

scala> io.circe.parser.decode(json)(decodeClipsParam)
res3: Either[io.circe.Error,List[Clip]] = Right(List(Clip(xyz,abc), Clip(pqr,def)))

我可能更进一步使用自定义案例类：

import io.circe.generic.auto._
import io.circe.generic.semiauto.deriveDecoder

case class Clip(clipId: String, name: String)
case class PlaylistParam(name: String, items: List[Clip])

object PlaylistParam {
  implicit val decodePlaylistParam: Decoder[PlaylistParam] =
    deriveDecoder[PlaylistParam].prepare(
      _.downField("params").downField("playlist")
    )
}

现在你可以这样写：

scala> io.circe.parser.decode[PlaylistParam](json).foreach(println)
PlaylistParam(Sample Playlist,List(Clip(xyz,abc), Clip(pqr,def)))

但是，如何分割导航和解码主要是为了品味。

Answer 2

谢谢您的帮助。 走了一会儿，然后又带着新鲜的眼睛回来，我弄明白了。

我认为使用downArray函数我出错了。

我的解决方案是执行以下操作：

override def main(args: Array[String]): Unit = {
    import ClipCodec.decodeClip

    val json = parse(Source.fromFile("playlist.json").mkString).right.get
    val clips = json.hcursor.downField("params").downField("playlist")
                   .downField("items").as[Seq[Clip]]

  }

Answer 3

Circe正在为List[Clip]寻找隐式声明的解码器，但无法找到它。

我怀疑你没有手动或（半）自动定义解码器。 您可以按照官方文档https://circe.github.io/circe/codec.html执行这两项操作。

不幸的是，我无法提供比这更详细的信息，因为问题相当模糊。 当给出更多细节时，我会更新我的答案。