【问题标题】:Using Circe to decode Json String使用 Circe 解码 Json 字符串
【发布时间】:2020-06-02 20:49:09
【问题描述】:

我有一个 Json 字符串作为

val configInfo =   {
      "car": {
        "requesters": {
          "request1": "key1",
          "request2": "key2"
        },
        "provider": {
          "request1": "key3",
          "request2": "key4"
        }
      },
      "truck": {
        "requesters": {
          "request1": "key2",
          "request2": "key3"
        },
        "provider": {
          "request1": "key2",
          "request2": "key3"
        }
      }
    }

我有以下案例类来解码 json 字符串。

final case class TenantSettings(requesters: Map[String, String], provider: Map[String, String] = Map.empty)

此外,上述案例类中的提供者是可选的,它可能存在也可能不存在于 json 字符串中。

我想用 circe 解码这个

val value = decode[Map[String, TenantSettings]](configInfo)

我知道我需要使用自定义 circe 编解码器,但我无法做到,有人可以帮忙解决这个问题。

【问题讨论】:

  • @LuisMiguelMejíaSuárez 我更正了代码
  • @LuisMiguelMejíaSuárez 自从地图以来,我也一直在编写自定义代码。我不知道如何继续。

标签: json scala decode circe


【解决方案1】:

您不需要自定义编解码器。您只需要使用circe-generic-extras配置派生编解码器即可。

所以给定:

val configInfo =
    """{
        "car": {
          "requesters": {
            "request1": "key1",
            "request2": "key2"
          },
          "provider": {
            "request1": "key3",
            "request2": "key4"
          }
        },
        "truck": {
          "requesters": {
            "request1": "key2",
            "request2": "key3"
          },
          "provider": {
            "request1": "key2",
            "request2": "key3"
          }
        },
        "blah": {
          "requesters": {
            "request1": "key2"
          }
        }
      }"""

你可以:

import io.circe.Decoder
import io.circe.generic.extras.Configuration
import io.circe.generic.extras.semiauto.deriveConfiguredDecoder

final case class TenantSettings(requesters: Map[String, String], provider: Map[String, String] = Map.empty)
object TentantSettings {
  private implicit final val customConfig: Configuration = Configuration.default.withDefaults
  implicit final val TenantSettingsDecoder: Decoder[TenantSettings] = deriveConfiguredDecoder
}

然后:

io.circe.parser.decode[Map[String, TenantSettings]](configInfo)
// res: Either[io.circe.Error, Map[String, TenantSettings]] = Right(
//   Map(
//     "car" -> TenantSettings(Map("request1" -> "key1", "request2" -> "key2"), Map("request1" -> "key3", "request2" -> "key4")),
//     "truck" -> TenantSettings(Map("request1" -> "key2", "request2" -> "key3"), Map("request1" -> "key2", "request2" -> "key3")),
//     "blah" -> TenantSettings(Map("request1" -> "key2"), Map())
//   )
// )

【讨论】:

  • 我得到以下错误找不到 io.circe.generic.extras.decoding.ConfiguredDecoder[A] [错误] 隐式最终 val decodeTenantSettings: Decoder[TenantSettings] = derivedConfiguredDecoder I 类型的延迟隐式值在我的项目中安装了 wartRemover 来解决这个问题
  • @ArjunKarnwal 如果你禁用它?代码是否编译?顺便说一句,尝试将 -Ywarn-macros:after 添加到您的 scalac 选项中。
  • 其实我错了。疣未启用,但我仍然收到此错误。 :(
  • @ArjunKarnwal 您的代码与问题中的代码不同吗?您确定您在我的回答中做了我所做的一切吗?另外,您使用的是哪个 Scala 版本和 circe 版本?
  • scala 版本 2.13 和 circe 0.13.0
【解决方案2】:

Circe 提供了您需要的所有 Decoder 实例,但 TenantSettings 的实例除外,因为它是一种自定义类型。 Map 和 String 没问题。

circe-generic-extras 或 circe-derivation 对于为案例类生成 Decoder 实例非常有用。在这种情况下,您希望在配置中启用“默认值”,因此它会退回到空地图而不是失败。

代码如下:

// you need circe-core, circe-parser and circe-generic-extras as dependencies
import io.circe._
import io.circe.parser.decode
import io.circe.generic.extras.Configuration
import io.circe.generic.extras.semiauto._

val configInfo = """{
    "car": {
      "requesters": {
        "request1": "key1",
        "request2": "key2"
      },
      "provider": {
        "request1": "key3",
        "request2": "key4"
      }
    },
    "truck": {
      "requesters": {
        "request1": "key2",
        "request2": "key3"
      },
      "provider": {
        "request1": "key2",
        "request2": "key3"
      }
    }
  }
  """

final case class TenantSettings(
  requesters: Map[String, String],
  provider: Map[String, String] = Map.empty
)
object TenantSettings {
  implicit private val derivationConfig: Configuration = Configuration.default.withDefaults

  implicit val decodeTenantSettings: Decoder[TenantSettings] = deriveConfiguredDecoder
}

val value = decode[Map[String, TenantSettings]](configInfo)
println(value) // Right(Map(car -> TenantSettings(Map(request1 -> key1, request2 -> ...

【讨论】:

  • 我得到以下错误,找不到类型为 io.circe.generic.extras.decoding.ConfiguredDecoder[A] [error] implicit final val decodeTenantSettings: Decoder[TenantSettings] = derivedConfiguredDecoder I 的延迟隐式值在我的项目中安装了 wartRemover 来解决这个问题
  • 如果您在案例类中使用的类型在范围内没有解码器实例,则派生将失败(这很好)。遗憾的是,错误消息无法准确告诉您问题是哪种类型,但通常很容易发现。您可能添加了没有解码器的东西。
  • 你也可以使用“circe-derivation”而不是“circe-generic”,它做同样的事情,但应该有更好的错误信息。
  • 是的,我确实做出了改变。最终案例类 TenantSettings(requesters: Map[String, String], provider: Map[String, String] = Map.empty)Map[String, String] = Map.empty) 改为类型 TenantSettings = Map[String, String]因此,当我输入 type 而不是 case 类时,尽管我有 type 的解码器,但它失败了。你能告诉我这个问题吗?
  • type TenantSettings = Map[String, String] 只是一个类型别名,派生对此毫无意义。你想做什么?
【解决方案3】:

这就是我所做的和为我工作的

implicit val decodeTenantSetting: Decoder[TenantSettings] = new Decoder[TenantSettings] {
      final def apply(c: HCursor): Decoder.Result[TenantSettings] =
        for {
          requesters <- c.downField("requesters").as[Map[String, String]]
        } yield {
          TenantSettings(requesters)
        }
    }

val abc = decode[Map[String, TenantSettings]](configInfo)

【讨论】:

    猜你喜欢
    • 2018-03-10
    • 1970-01-01
    • 2017-04-12
    • 2018-05-28
    • 2018-12-23
    • 2017-10-03
    • 2019-05-03
    • 2019-04-03
    • 2019-01-03
    相关资源
    最近更新 更多