提问者:小点点

Jackson Scala JSON反序列化到case类


我有一个具有以下形式的 JSON:

{
"inventory": [
           {
        "productType": "someProduct1",
        "details": {
            "productId": "Some_id",
            "description": "some description"
        }
        },
 {
        "productType": "someProduct2",
        "details": {
            "productId": "Some_id",
            "description":{"someKey":"somevalue"}
        }
    }
]
}

我希望上述 json 反序列化的案例类如下所示:

case class Inventory(products:List[Product])
case class Product(productType:String,details:ProductDetails)
abstract class ProductDetails
case class ProductDetailsSimple(productId:String,description:String) extends ProductDetails
case class ProductDetailsComplex(productId:String,description:Map[String,String]) extends ProductDetails

我正在使用jackson-scala模块对上述JSON字符串进行反序列化,如下所示:

 val mapper = new ObjectMapper() with ScalaObjectMapper
 mapper.registerModule(DefaultScalaModule)
 mapper.readValue(jsonBody, classOf[Inventory])

我得到的错误如下:“意外的令牌 (END_OBJECT),预期FIELD_NAME:缺少属性'@details',该属性包含类型 id(对于类产品详细信息)\n 在 [源: java.io.StringReader@12dfbabd;行: 9, 列: 5]”

我已经浏览了有关多态反序列化的杰克逊文档,并尝试了上述组合,但没有运气。我想了解我在这里做错了什么,在使用杰克逊模块反序列化方面需要更正。


共1个答案

匿名用户

我认为这里有几个不同的问题需要解决,所以我列出了三种不同的方法。

或者正确使用Jackson多态性,或者在您的情况下,使用更简单的方法,消除多态性的需要。在github上查看我的代码。

格式化后的 JSON 为:

{ inventory:
   [ { productType: 'someProduct1',
       details:
        { productId: 'Some_id',
          description: 'some description' } },
     { productType: 'someProduct2',
       details:
        { productId: 'Some_id',
          description: { someKey: 'somevalue' } 
        }
     } 
   ]
}

在我看来,字段< code>productType放错了位置,但是如果这种格式是一个严格的要求,那么您可以编写自己的反序列化器,它查看< code>productType字段并实例化一个不同的具体类。

我不认为这是最好的解决方案,所以我没有编写示例代码,但我喜欢将Joda日期时间包作为自定义序列化/反序列化的参考

您用一个类型字段将ProductProductsDetails分开:

case class Product(productType:String,details:ProductDetails)

abstract class ProductDetails

我认为您已经混淆了Jackson的多态数据类型处理是如何工作的,并因此使您的类设计变得复杂。

也许您的业务规则要求产品具有“类型”,在这种情况下,我会将其命名为“类型”或其他非代码标签,并将其放入您所谓的Product详细信息中。

但是,如果在尝试获得类型多态性时包含“类型”,那么这不是正确的方法。

我将以下内容作为Scala中Jackson多态性的工作示例:

/**
 * The types here are close to the original question types but use 
 * Jackson annotations to mark the polymorphic JSON treatment.
 */

import scala.Array
import com.fasterxml.jackson.annotation.JsonSubTypes.Type
import com.fasterxml.jackson.annotation.{JsonSubTypes, JsonTypeInfo}

@JsonTypeInfo(
  use = JsonTypeInfo.Id.NAME,
  include = JsonTypeInfo.As.PROPERTY,
  property = "type")
@JsonSubTypes(Array(
  new Type(value = classOf[ProductDetailsSimple], name = "simple"),
  new Type(value = classOf[ProductDetailsComplex], name = "complex")
))
abstract class Product

case class ProductDetailsSimple(productId: String, description: String) extends Product

case class ProductDetailsComplex(productId: String, description: Map[String, String]) extends Product

case class PolymorphicInventory(products: List[Product])

请注意,我删除了ProductProductsDetails的区别,因此Inventory现在只是一个Product列表。我留下了名称ProductDetailsSimpleProductsDetailsComplex,尽管我认为它们应该重命名。

用法示例:

val inv = PolymorphicInventory(
  List(
    ProductDetailsSimple(productId="Some_id", description="some description"),
    ProductDetailsComplex(productId="Some_id", description=Map("someKey" -> "somevalue"))
  )
)

val s = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(inv)
println("Polymorphic Inventory as JSON: "+s)

输出:

Polymorphic Inventory as JSON: {
  "products" : [ {
    "type" : "simple",
    "productId" : "Some_id",
    "description" : "some description"
  }, {
    "type" : "complex",
    "productId" : "Some_id",
    "description" : {
      "someKey" : "somevalue"
    }
  } ]
}

我建议在这种情况下根本不需要多态性,错误在于尝试将“描述”设为单个字符串或键/值映射,而它们实际上是具有不同意图的字段。

也许涉及数据遗留问题(在这种情况下,请参阅自定义设计建议),但如果数据在您的控制之下,我投票支持“变得更简单”:

case class Product(productId: String,
                   description: String="",
                   attributes: Map[String, String]=Map.empty)

case class PlainInventory(products: List[Product])

使用< code>Option来表示缺少值更“标量”,所以:

case class Product(productId: String,
                   description: Option[String]=None,
                   attributes: Option[Map[String, String]]=None)

用法示例:

val inv = PlainInventory(
  List(
    Product(productId="Some_id", description=Some("some description")),
    Product(productId="Some_id", attributes=Some(Map("someKey" -> "somevalue")))
  )
)

val s = jsonMapper.writerWithDefaultPrettyPrinter().writeValueAsString(inv)
println("Plain Inventory as JSON: "+s)

输出:

Plain Inventory as JSON: {
  "products" : [ {
    "productId" : "Some_id",
    "description" : "some description"
  }, {
    "productId" : "Some_id",
    "attributes" : {
      "someKey" : "somevalue"
    }
  } ]
}

在github上运行最少的代码。