使用spray json的一点小经验

一个scala常用的json工具

java里面的fastjson,gson,和Jackson是我最熟悉的json序列化框架，用起来没什么问题，接触了scala之后，我看到很多项目使用sprayjson,尤其是akka相关的项目，使用特别多，因为刚接触scala，它的伴生对象和implicit隐式语义会让新手使用spray json的时候，有一点点困惑。

json序列化的流程

简单说就是json字符串和对象的互转，java里面的对象一般是指bean，有的也叫pojo，scala里面一般指case class的对象。
还有很多框架不提供到bean的转换，而是直接转成JsonObject和JsonArray对象，有的同时支持，比如fastJson，spray json 同样也都支持，基础类叫做JsonValue，具体的还有JSNumber、JSString、JSBoolean等更详细的数据类型，原理其实跟其它java的json框架没有太大的区别

image.png

具体用的时候，spray json是这样的：导入import spray.json._，

一个json串，调用parseJson方法
一个scala对象调用toJson方法

都可以转化为一个spray json的语法树对象

这个语法树对象可以打印成json字符串，也可以转化为一个scala对象
转为json字符串：
prettyPrint // or .compactPrint
转为对象val myObject = jsonAst.convertTo[MyObjectType]

https://github.com/spray/spray-json
具体的参考这个文档即可
调用方式都是死的，无非是convertTo，parseJson，toJson，但是具体怎么转，是需要协议的，框架本身内置了一大堆协议，用于scala基础对象类型的转化，而我们自定义的case class或者class需要我们自己实现转化的方式，这个是我们需要编码的地方。

两种比较常用的方式

1、JsonProtocol

对于没有显示声明伴生对象的情况，sprayjson给你准备了很多 jsonFormatX，x对应你的case class参数个数，比如

case class Color(name: String, red: Int, green: Int, blue: Int)

object MyJsonProtocol extends DefaultJsonProtocol {
  implicit val colorFormat = jsonFormat4(Color)
}

如果有22个参数，那就是jsonFormat22，这些框架提供的jsonFormatX使用的话，需要导入spray.json.DefaultJsonProtocol_,这也是scala隐式的特点
如果显示声明了伴生对象，那么就不能直接jsonFormat4(Color)这样写了，上面这个例子里，如果声明了Color伴生对象，那么jsonFormat4(Color)里的Color会被理解成Color对象，这时候需要我们提供伴生对象的apply方法，要写成这样

case class Color(name: String, red: Int, green: Int, blue: Int)
object Color

object MyJsonProtocol extends DefaultJsonProtocol {
  implicit val colorFormat = jsonFormat4(Color.apply)
}

2、普通 class的序列化

普通class即非case class的情况，多数用到RootJsonFormat，这时候需要我们重写read,write方法，即JSValue和class对象的转换关系
例如：

class Color(val name: String, val red: Int, val green: Int, val blue: Int)

object MyJsonProtocol extends DefaultJsonProtocol {
  implicit object ColorJsonFormat extends RootJsonFormat[Color] {
    def write(c: Color) =
      JsArray(JsString(c.name), JsNumber(c.red), JsNumber(c.green), JsNumber(c.blue))

    def read(value: JsValue) = value match {
      case JsArray(Vector(JsString(name), JsNumber(red), JsNumber(green), JsNumber(blue))) =>
        new Color(name, red.toInt, green.toInt, blue.toInt)
      case _ => deserializationError("Color expected")
    }
  }
}

import MyJsonProtocol._

val json = new Color("CadetBlue", 95, 158, 160).toJson
val color = json.convertTo[Color]

更复杂的用法，后面陆续补充

最后编辑于：2019.11.14 11:16:54