scala-play 2.4.11,是否可以使用case类作为密钥对Map进行desearialize?

时间:2018-05-24 21:24:49

标签: scala playframework play-json

我正在尝试处理play-json而且它并不顺利。 这是我的案例类

sealed case class Items(items: List[Item])

sealed case class Item(path: String, itemCounters: Map[ItemCategory, Long])

sealed case class ItemCategory(repository: Repository)

sealed case class Repository(env: String)

这里我试图解析json:

implicit lazy val repositoryFormat = Json.format[Repository]
implicit lazy val itemCategoryFormat = Json.format[ItemCategory]
implicit lazy val itemFormat = Json.format[Item]
implicit lazy val itemsFormat = Json.format[Items]

Json.parse(str).as[Items]

我得到例外: 没有Map [ItemCategory,Long]的隐式格式。

为什么?

1 个答案:

答案 0 :(得分:1)

失败是因为play-json对如何在itemCounters: Map[ItemCategory, Long]中反序列化Item属性感到困惑。

实际上,如果密钥是String,则可以直接处理JSON映射。但是对于键中的其他结构化对象,例如问题中的ItemCategory,它变得有点困难。当然,具有此类密钥的JSON不能是{ "repository": { "env": "demo" } }: 1

因此,我们需要明确这种Map的反序列化。我假设ItemCategory的键是基础ItemCategory.repository.env值,但它可以是任何其他属性,具体取决于您的有效数据模型。

我们为此类地图提供Reads实施:

implicit lazy val itemCategoryMapReads = new Reads[Map[ItemCategory, Long]] {
  override def reads(jsVal: JsValue): JsResult[Map[ItemCategory, Long]] = {
    JsSuccess(
      // the original string -> number map is translated into ItemCategory -> Long
      jsVal.as[Map[String, Long]].map{
        case (category, id) => (ItemCategory(Repository(category)), id)
      }
    )
  }
}

相应的Format(带Writes的存根,我们现在不需要):

implicit lazy val itemCategoryMapFormat = Format(itemCategoryMapReads, (catMap: Map[ItemCategory, Long]) => ???)

现在可以正确映射基本JSON:

val strItemCat =
  """
    | {
    |   "rep1": 1,
    |   "rep2": 2,
    |   "rep3": 3
    | }
  """.stripMargin

println(Json.parse(strItemCat).as[Map[ItemCategory, Long]])
// Map(ItemCategory(Repository(rep1)) -> 1, ItemCategory(Repository(rep2)) -> 2, ItemCategory(Repository(rep3)) -> 3)

对于其他案例类,您已定义的简单格式应该可以正常工作,前提是它们按从大多数到最不具体(从RepositoryItems)的顺序声明。