Spray中对复杂JSON的序列化与反序列化

在Spray中,倘若我们希望REST服务支持JSON格式的request与response,通常使用Spray提供的Json4sSupport,只需要Spray的Route继承它即可。它基本上可以应付常规的Scala类(多数情况是case class)与Json格式之间的序列化与反序列化。

倘若需要支持Scala的枚举类型,或者Joda框架提供的Time类型,可以利用Json4s的扩展,只需要在项目依赖文件sbt中添加该依赖:

val json4sExt = "org.json4s" %% "json4s-ext" % json4sVersion

那么就可以定义一个类,用于对Json的支持:

object MyJsonSupport extends Json4sSupport {

  implicit val formats = Serialization.formats(ShortTypeHints(List()))

  implicit lazy val json4sFormats: Formats =
    org.json4s.ext.JodaTimeSerializers.all +
      new EnumNameSerializer(FieldType)
}

上述代码的FieldType就是一个自定义的枚举类型。

在项目中,我碰到了一个复杂的Json结构,它是一个递归结构,且内部嵌套的对象还存在类型定义的多态。若从函数角度来讲,那种类型结构就是Algebraic Data Type的product类型。

大致的Json结构如下所示:

[
     {
         "fieldId": -1,
         "fieldType": "metric",
         "function": {
             "functionName": "sum",
             "functionType": "buildin",
             "parameters": [
                {
                   //此时参数为FieldParameter类型
                   "fieldId": 4  
                }
             ]
         }
     },
     {
         "fieldId": -1,
         "fieldType": "metric",
         "function": {
               "functionName": "yearOnYearBasis",
               "functionType": "udaf",
                  "parameters": [
                   {
                      "fieldId": 4
                   },
                   {
                       "fieldId": 5
                   },
                   {
                       //此时参数为ConstantParameter类型
                      "classType": "timestamp",  
                      "value": "2015-01-01 00:00:00"
                   },
                   {
                      "classType": "timestamp",
                      "value": "2015-12-31 11:59:59"
                   }
               ]
        }
    }
]

这个Json数据代表一个Field的数组。Field下定义了一个OptionFunctionFunction可以接收多个参数(Parameter),而参数存在三种类型,分别为:FieldParameterConstantParameterFunctionParameter。其中FunctionParameter尤其特殊,它实际上又是一个Function类型,形成了一种递归嵌套。

Json数据对应的Scala类如下:

  case class Field(fieldId: ID, fieldType: String, function: Option[Function] = None)

  case class Function(functionName: String, functionType: String, parameters: List[Parameter])

  sealed trait Parameter

  case class FieldParameter(fieldId: ID) extends Parameter

  case class ConstantParameter(classType: String, value: String) extends Parameter

  case class FunctionParameter(function: Function) extends Parameter

我们需要在给REST服务传入Json数据时,可以根据Json中parameters下传递的名称,来判断实例化哪一种类型的Parameter。在Scala中,其实是一个典型的模式匹配。

在Json4s中,可以认为Json值其实是一个它封装的JObject对象。一个JObject可以包含多个JField对象。此外,Json4s支持自定义序列化器。这就为类型多态提供了实现的可能。除了Parameter类型外,其余类型符合标准的Scala类(即使包含了Option类型),Json4s内置的序列化器已经支持;故而只需要为Parameter定义序列化器即可。

由于要支持序列化与反序列化,因此在模式匹配中需要支持两个方向的相互转换与映射,即在JObject与case class之间定义。

FunctionParameter的处理比较特殊,因为它的参数(即Json4s中的JField)又是另外一个对象。而Json4s中仅仅为基本类型提供了定义,例如JIntJString等。在JField中的值都被定义为JValue,所以可以通过调用JValueextract方法将JValue提取为Scala对象;通过调用Extraction.decompose方法将Scala对象转换为JValue对象。代码如下所示:

class ParameterSerializer extends CustomSerializer[Parameter](format => ( {
  case JObject(JField("fieldId", JInt(fieldId)) :: Nil) => FieldParameter(fieldId.toInt)
  case JObject(JField("classType", JString(classType)) ::  JField("value", JString(value)) :: Nil) => ConstantParameter(classType, value)
  case JObject(List(JField("function", function) :: Nil) => FunctionParameter(function.extract[Function])
}, {
  case FieldParameter(fieldId) => JObject(JField("fieldId", JInt(fieldId)) :: Nil)
  case ConstantParameter(classType, value) => JObject(JField("classType", JString(classType)) :: JField("value", JString(value)) :: Nil)
  case FunctionParameter(function) => JObject(JField("function", Extraction.decompose(Function)) :: Nil)
}))

最后,只需要将ParameterSerializer的实例追加到前面的json4sFormats中即可。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,539评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,594评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,871评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,963评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,984评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,763评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,468评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,850评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,002评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,144评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,823评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,483评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,026评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,150评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,415评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,092评论 2 355

推荐阅读更多精彩内容