Разобрать класс case, содержащий HList, в строку JSON, используя Circe

Question

Я делаю что-то в Скала. У меня есть следующий класс дела:

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

Я хотел бы получить JSON-представление этого типа, используя Circe. Я также хотел бы отобразить полученную строку JSON обратно на тип.

Модуль circe-shape осуществляет автоматический вывод HList, и его легко перевести из 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)

Классы case, содержащие "стандартные" типы, также тривиальны:

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's ops классы типов, вы не можете восстановить информацию об отдельных типах и т. д. Вы почти всегда (вероятно, всегда всегда) хотите L <: HList, что позволяет хранить информацию, которая делает тип полезным.