使用Circe

时间:2016-11-28 15:41:46

标签: json scala shapeless hlist circe

我在Scala中做了一件事。我有以下案例类:

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

我想获取此类型的JSON代表使用Circe 。我还希望将生成的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)

案例类包含&#34;标准&#34;类型也很简单:

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吗?

1 个答案:

答案 0 :(得分:5)

是的,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,这样您就可以保留使该类型有用的信息