使用Circe将包含HList的案例类解析为JSON字符串

Question

我在Scala做的事情.我有以下案例类:

import shapeless._
case class Foo(param1: String, param2: HList)

我想使用Circe获得这种类型的JSON表示.我还想将生成的JSON字符串映射回类型.

模块circe-shapes自动推导出HLists,并且很容易从HList到JSON再返回.看这个例子:

scala> import shapeless._
import shapeless._

scala> import io.circe._, io.circe.generic.auto._, io.circe.parser._, io.circe.syntax._
import io.circe._
import io.circe.generic.auto._
import io.circe.parser._
import io.circe.syntax._

scala> import io.circe.shapes._
import io.circe.shapes._

scala> val myList = 30 :: "car" :: HNil
myList: shapeless.::[Int,shapeless.::[String,shapeless.HNil]] = 30 :: car :: HNil

scala> val listJson = myList.asJson
listJson: io.circe.Json =
[
  30,
  "car"
]

scala> listJson.as[HList] // won't work
<console>:32: error: could not find implicit value for parameter d: io.circe.Decoder[shapeless.HList]
       listJson.as[HList]
                  ^

scala> listJson.as[::[Int, ::[String, HNil]]]
res3: io.circe.Decoder.Result[shapeless.::[Int,shapeless.::[String,shapeless.HNil]]] = Right(30 :: car :: HNil)

包含"标准"类型的案例类也很简单:

scala> case class Bar(one: String, a: Double, andAn: Int)
defined class Bar

scala> val myBar = Bar("pie", 4.35, 2)
myBar: Bar = Bar(pie,4.35,2)

scala> val barJson = myBar.asJson
barJson: io.circe.Json =
{
  "one" : "pie",
  "a" : 4.35,
  "andAn" : 2
}

scala> barJson.as[Bar]
res5: io.circe.Decoder.Result[Bar] = Right(Bar(pie,4.35,2))

明确HList的类型可以创造奇迹,但它有点挫败了HList的目的:

scala> case class Foo2(a: String, b: ::[Int, ::[String, HNil]])
defined class Foo2

scala> val myFoo2 = Foo2("ark", 42 :: "meg" :: HNil)
myFoo2: Foo2 = Foo2(ark,42 :: meg :: HNil)

scala> val foo2Json = myFoo2.asJson
foo2Json: io.circe.Json =
{
  "a" : "ark",
  "b" : [
    42,
    "meg"
  ]
}

scala> foo2Json.as[Foo2]
res8: io.circe.Decoder.Result[Foo2] = Right(Foo2(ark,42 :: meg :: HNil))

Circe可以解码任意HList吗？

Answer 1

是的,circe可以做到这一点,但您需要更改您的案例类,以使其保持有关以下内容的更多信息HList:

import shapeless._

case class Foo[L <: HList](param1: String, param2: L)

然后进口:

import io.circe.generic.auto._, io.circe.shapes._, io.circe.parser._, io.circe.syntax._

然后你可以打电话asJson等:

scala> val foo = Foo("ark", 42 :: "meg" :: HNil)
foo: Foo[shapeless.::[Int,shapeless.::[String,shapeless.HNil]]] = Foo(ark,42 :: meg :: HNil)

scala> foo.asJson
res0: io.circe.Json =
{
  "param1" : "ark",
  "param2" : [
    42,
    "meg"
  ]
}

scala> decode[Foo[Int :: String :: HNil]](res0.noSpaces).right.foreach(println)
Foo(ark,42 :: meg :: HNil)

在这种情况下,具体来说,circe中的派生机制需要有关hlist元素的静态信息才能生成编码器和解码器,但更常见的是,当你使用hlists时,你需要避免将成员或值键入为平凡的HList.

你可以用类似的东西做很多事情HList.您可以为它添加值,并且您可以通过获得字符串表示toString,但就是它 - 您不能使用任何Shapeless的ops类型类,您无法恢复有关各个类型等的任何信息.您几乎可以总是(可能总是总是)想要一个L <: HList,它允许你保持使类型有用的信息.