A quick tour of JSON libraries in Scala

Update (18.11.2015): added spray-json-shapeless library
Update (06.11.15): added circe library

Some time ago I wrote a post on relational database access in Scala since I was looking for a library and there were many of them available, making it hard to make a choice. It turns out that the situation is similar if not worse when it comes to JSON libraries in Scala.

There are just plenty of them. You have no idea. (me neither until I wrote this post)

The following is an attempt to provide a quick overview at how a subset of the libraries I found does a few of the most common things one would likely need to do in regard to JSON:

  • parsing it from a raw string
  • browsing the AST
  • building an AST
  • mapping to a case class

There are of course plenty more valid use-cases but this post is not going to cover those.

Let’s get started!

Scala JSON libraries

play-json

The Play Framework comes with a JSON library that covers most of the common use-cases one would encounter when building web applications:

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
scala> import play.api.libs.json._
import play.api.libs.json._
 
scala> val rawJson = """{"hello": "world", "age": 42}"""
rawJson: String = {"hello": "world", "age": 42}
 
scala> Json.parse(rawJson)
res0: play.api.libs.json.JsValue = {"hello":"world","age":42}
 

Browsing the AST

 
 
1
2
3
scala> (res0 \ "hello").as[String]
res1: String = world
 

Building a JSON AST

 
 
1
2
3
scala> Json.obj("hello" -> "world", "age" -> 42)
res2: play.api.libs.json.JsObject = {"hello":"world","age":42}
 

Mapping to a case class

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
scala> case class Model(hello: String, age: Int)
defined class Model
 
scala> implicit val modelFormat = Json.format[Model]
modelFormat: play.api.libs.json.OFormat[Model] = play.api.libs.json.OFormat$$anon$1@81116d
 
scala> Json.fromJson[Model](res0)
res3: play.api.libs.json.JsResult[Model] = JsSuccess(Model(world,42),)
 
scala> res3.get
res4: Model = Model(world,42)
 
scala> Json.toJson(Model("bar", 23))
 
res5: play.api.libs.json.JsValue = {"hello":"bar","age":23}
 

lift-json

lift-json is the JSON library of the Lift framework. It is one of the oldest one out there if I’m not mistaken.

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
scala> import net.liftweb.json._
import net.liftweb.json._
 
scala> val rawJson = """{"hello": "world", "age": 42, "nested": { "deeper": { "treasure": true }}}"""
rawJson: String = {"hello": "world", "age": 42, "nested": { "deeper": { "treasure": true }}}
 
scala> parse(rawJson)
res0: net.liftweb.json.JValue = JObject(List(JField(hello,JString(world)), JField(age,JInt(42)), JField(nested,JObject(List(JField(deeper,JObject(List(JField(treasure,JBool(true))))))))))
 

Browsing the AST

 
 
1
2
3
scala> res0 \ "nested" \ "deeper" \ "treasure"
res1: net.liftweb.json.JsonAST.JValue = JBool(true)
 

Building a JSON AST

 
 
1
2
3
4
5
6
scala> import net.liftweb.json.JsonDSL._
import net.liftweb.json.JsonDSL._
 
scala> ("hello" -> "world") ~ ("age" -> 42)
res2: net.liftweb.json.JsonAST.JObject = JObject(List(JField(hello,JString(world)), JField(age,JInt(42))))
 

Mapping to a case class

 
 
1
2
3
4
5
6
7
8
9
10
11
12
object LiftJsonExample {
  def main(args: Array[String]): Unit = {
    import net.liftweb.json._
    implicit val formats = DefaultFormats
 
    case class Model(hello: String, age: Int)
    val rawJson = """{"hello": "world", "age": 42}"""
 
    println(parse(rawJson).extract[Model])
  }
}
 

spray-json

spray rols its own JSON library that focuses on working with case classes:

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
10
11
12
scala> import spray.json._
import spray.json._
 
scala> import DefaultJsonProtocol._
import DefaultJsonProtocol._
 
scala> val rawJson = """{"hello": "world", "age": 42}"""
rawJson: String = {"hello": "world", "age": 42}
 
scala> rawJson.parseJson
res0: spray.json.JsValue = {"hello":"world","age":42}
 

Browsing the AST

No can do?

Building a JSON AST

No can do?

Mapping to a case class

 
 
1
2
3
4
5
6
7
8
9
scala> case class Model(hello: String, age: Int)
defined class Model
 
scala> implicit val modelFormat = jsonFormat2(Model)
modelFormat: spray.json.RootJsonFormat[Model] = spray.json.ProductFormatsInstances$$anon$2@7bc880f8
 
scala> res1.convertTo[Model]
res4: Model = Model(world,42)
 

spray-json-shapeless

spray-json-shapeless derives spray-json’s JsonFormat-s automatically using shapeless (no need to define an implicit JsonFormat

Mapping to a case class

 
 
1
2
3
4
5
6
7
8
9
10
11
12
scala> import spray.json._
import spray.json._
 
scala> import fommil.sjs.FamilyFormats._
import fommil.sjs.FamilyFormats._
 
scala> case class Model(hello: String, age: Int)
defined class Model
 
scala> Model("hello", 42).toJson
res0: spray.json.JsValue = {"hello":"hello","age":42}
 

This is quite useful, it removes the boilerplate formats hanging around

json4s

json4s is a bit like slf4j in the sense that it tries to unite all kind of rogue libraries serving the same purpose by providing a common interface. But not every library uses it, which means that chances are high that your project will contain json4s in addition to another (few) Scala JSON libraries. Hopefully it will one day succeed with its slogan “One AST to rule them all”.

json4s has its roots in lift-json so this will look familiar:

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
10
11
12
scala> import org.json4s._
import org.json4s._
 
scala> import org.json4s.native.JsonMethods._
import org.json4s.native.JsonMethods._
 
scala> val rawJson = """{"hello": "world", "age": 42}"""
rawJson: String = {"hello": "world", "age": 42}
 
scala> parse(rawJson)
res0: org.json4s.JValue = JObject(List((hello,JString(world)), (age,JInt(42))))
 

Browsing the AST

 
 
1
2
3
scala> res0 \ "hello"
res1: org.json4s.JValue = JString(world)
 

Building a JSON AST tree

 
 
1
2
3
scala> ("hello" -> "world") ~ ("age" -> 42)
res2: org.json4s.JsonAST.JObject = JObject(List((hello,JString(world)), (age,JInt(42))))
 

Mapping to a case class

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
object Json4sExample {
  def main(args: Array[String]): Unit = {
    import org.json4s._
    import org.json4s.native.JsonMethods._
    implicit val formats = DefaultFormats
 
    case class Model(hello: String, age: Int)
    val rawJson = """{"hello": "world", "age": 42}"""
 
    println(parse(rawJson).extract[Model])
  }
}
 

argonaut

Argonaut promotes “purely functional JSON in Scala”. It uses scalaz under the hood and

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import scalaz._, Scalaz._
import scalaz._
import Scalaz._
 
scala> import argonaut._, Argonaut._
import argonaut._
import Argonaut._
 
scala> val rawJson = """{"hello": "world", "age": 42, "nested": { "deeper": { "treasure": true }}}"""
rawJson: String = {"hello": "world", "age": 42, "nested": { "deeper": { "treasure": true }}}
 
scala> rawJson.parseOption
res0: Option[argonaut.Json] = Some({"hello":"world","age":42,"nested":{"deeper":{"treasure":true}}})
 

Browsing the AST

There are several mechanisms available, let’s use a lense. Those are funky:

 
 
1
2
3
4
5
6
scala> val ohMyLens = jObjectPL >=> jsonObjectPL("nested") >=> jObjectPL >=> jsonObjectPL("deeper") >=> jObjectPL >=> jsonObjectPL("treasure") >=> jBoolPL
ohMyLens: scalaz.PLensFamily[argonaut.Json,argonaut.Json,Boolean,Boolean] = scalaz.PLensFamilyFunctions$$anon$2@8c894ab
 
scala> ohMyLens.get(res0.get)
res1: Option[Boolean] = Some(true)
 

Building a JSON AST tree

 
 
1
2
3
scala> ("hello", jString("world")) ->: ("age", jNumber(42)) ->: jEmptyObject
res2: argonaut.Json = {"age":42,"hello":"world"}
 

Mapping to a case class

 
 
1
2
3
4
5
6
7
8
9
scala> case class Model(hello: String, age: Int)
defined class Model
 
scala> implicit def ModelCodecJson: CodecJson[Model] = casecodec2(Model.apply, Model.unapply)("hello", "age")
ModelCodecJson: argonaut.CodecJson[Model]
 
scala> rawJson.decodeOption[Model]
res3: Option[Model] = Some(Model(world,42))
 

circe

Circe is a fork of Argonaut that uses cats instead of scalaz and uses shapeless to generate codecs.

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
scala> import io.circe._, io.circe.generic.auto._, io.circe.parse._, io.circe.syntax._      
import io.circe._        
import io.circe.generic.auto._      
import io.circe.parse._      
import io.circe.syntax._        
scala> val rawJson = """{"hello": "world", "age": 42, "nested": { "deeper": { "treasure": true }}}"""        
rawJson: String = {"hello": "world", "age": 42, "nested": { "deeper": { "treasure": true }}}        
scala> parse(rawJson).getOrElse(Json.empty)      
res0: io.circe.Json =        
{        
"hello" : "world",      
"age" : 42,        
"nested" : {        
"deeper" : {        
"treasure" : true      
}      
}      
}
 

Browsing the AST

So far there’s only support for cursors which let you move around the JSON tree and do changes if you would like, not for Lenses yet:

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
scala> val cursor = res0.cursor      
cursor: io.circe.Cursor =        
CJson({      
"hello" : "world",      
"age" : 42,        
"nested" : {        
"deeper" : {        
"treasure" : true      
}      
}      
})      
scala> for {        
| nested <- cursor.downField("nested")      
| deeper <- nested.downField("deeper")      
| treasure <- deeper.downField("treasure")      
| } yield treasure.as[Boolean]      
res1: Option[io.circe.Decoder.Result[Boolean]] = Some(Right(true))
 

Mapping to a case class hierarchy

I didn’t get this to work with the example below. The example in the documentation works though so here is that one:

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
scala> sealed trait Foo      
defined trait Foo        
scala> case class Bar(xs: List[String]) extends Foo      
defined class Bar        
scala> case class Qux(i: Int, d: Option[Double]) extends Foo        
defined class Qux        
scala> val foo: Foo = Qux(13, Some(14.0))        
foo: Foo = Qux(13,Some(14.0))        
scala> foo.asJson.noSpaces      
res0: String = {"Qux":{"d":14.0,"i":13}}        
scala> decode[Foo](foo.asJson.spaces4)      
res1: cats.data.Xor[io.circe.Error,Foo] = Right(Qux(13,Some(14.0)))
 

sphere-json

The sphere-json library focuses on providing an easy way to get de/serializers for entire families of case classes. This is really useful when working with any kind of protocol-related system. I am using it in a CQRS system where commands and events are travelling back and forth between the server and a Javascript UI. Instead of having to define a codec for each one of my case classes, I simply have them extend a common abstract class and let the library take care of the rest. Watch for yourselves:

Mapping to a case class hierarchy

 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
import io.sphere.json.generic._
import io.sphere.json._
 
object Messages {
 
  sealed abstract class Message
  case class Hello(hello: String) extends Message
  case class Age(age: Int) extends Message
 
}
object SphereJsonExample {
  import Messages._
 
  val rawHello = """{ "hello": "world", "type": "Hello" }"""
  val rawAge = """{ "age": 42, "type": "Age" }"""
 
  implicit val allYourJson = deriveJSON[Message]
 
  def magic(json: String) = fromJSON[Message](json).fold(
    fail => println("Oh noes: " + fail),
    hi => println(hi)
  )
 
  def main(args: Array[String]): Unit = {
    magic(rawHello)
    magic(rawAge)
  }
 
}
 

jawn

jawn is a library that focuses on speed. It defines a lightweight AST and is compatible with all kind of other ASTs that we have seen here.

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
10
11
12
scala> import jawn._
import jawn._
 
scala> import jawn.ast._
import jawn.ast._
 
scala> val rawJson = """{"hello": "world", "age": 42}"""
rawJson: String = {"hello": "world", "age": 42}
 
scala> jawn.ast.JParser.parseFromString(rawJson).get
res0: jawn.ast.JValue = {"age":42,"hello":"world"}
 

rapture

rapture’s json library is the ultimate Scala JSON library. It doesn’t really do anything with JSON itself, instead, it abstracts over the following JSON libraries (which it callsbackends):

  • Argonaut
  • Jackson
  • Jawn
  • JSON4S
  • Lift
  • Play
  • Scala standard library JSON
  • Spray

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
scala> import rapture.json._
 
scala> import rapture.json.jsonBackends.play._
import rapture.json.jsonBackends.play._
 
scala> Json.parse(rawJson)
res2: rapture.json.Json = {"hello":"world","age":42}
 

Browsing the AST

Rapture is using Scala’s Dynamic trait, which makes this fun:

 
 
1
2
3
scala> res2.hello.as[String]
res3: String = world
 

Building a JSON AST tree

 
 
1
2
3
scala> json"""{ "hello": "world", "age": 42}"""
res6: rapture.json.Json = {"hello":"world","age":42}
 

The Scala standard library

Up until recently I did not know that Scala had a JSON utility in its standard library. But here it is!

Parsing raw JSON

 
 
1
2
3
4
5
6
7
8
9
10
scala> import scala.util.parsing.json._
import scala.util.parsing.json._
 
scala> val rawJson = """{"hello": "world", "age": 42}"""
rawJson: String = {"hello": "world", "age": 42}
 
scala> JSON.parseFull(rawJson)
warning: there was one deprecation warning; re-run with -deprecation for details
res0: Option[Any] = Some(Map(hello -> world, age -> 42.0))
 

Browsing the “AST”

 
 
1
2
3
scala> res0.get.asInstanceOf[Map[String, Any]]("hello").asInstanceOf[String]
res4: String = world
 

Even more!

I am forgetting a ton of libraries here I am sure. That, and I am tired and my glass ofUigeadail is getting empty.

So let me mention a few more:

Great, now which one to pick?

Honestly I don’t have any good advice here. These days I am sticking to play-json and sphere-json, but that’s for no particular reason other than these libraries being there and doing what I need to do (parse and write JSON, traverse and some rare times transform the AST, bind to case classes, make it possible to support custom Java types). If play-json had support for hierarchies out of the box I would probably not have even looked for anything else.

Because for all the joy there seems to be in implementing JSON libraries in Scala, one thing has to be said: JSON de/serialization is boring. It’s this annoying thing that you have to do in order to get your application to talk to another computerized system, period.

I have never met a developer who told me how much pleasure they derived from turning classes into JSON strings and back. That’s just not a thing.

I have, however, met more than one developer that has run into trouble getting library X to cover one of the simple use-cases outlined above. Believe me, there is nothing more frustrating than having to spend time on the annoying task of setting up JSON de/serialization in order to do the boring thing of tossing strings back and forth the network. That’s time you will never get back.

Good night, and good luck.

原文

A quick tour of JSON libraries in Scala的更多相关文章

  1. Avro schemas are defined with JSON . This facilitates implementation in languages that already have JSON libraries.

    https://avro.apache.org/docs/current/ Introduction Apache Avro™ is a data serialization system. Avro ...

  2. 开发工具-scala处理json格式利器-json4s

    1.为什么是json4s 从json4s的官方描述 At this moment there are at least 6 json libraries for scala, not counting ...

  3. scala读取解析json文件

    import scala.util.parsing.json.JSON._ import scala.io.Source object ScalaJsonParse { def main(args: ...

  4. scala解析json —— json4s 解析json方法汇总

    使用json4s的框架,包括spark,flink 1.org.json4s 引入pom的方法 对于本地支持,引入以下依赖项添加到pom中 <dependency> <groupId ...

  5. Awesome Go精选的Go框架，库和软件的精选清单.A curated list of awesome Go frameworks, libraries and software

    Awesome Go      financial support to Awesome Go A curated list of awesome Go frameworks, libraries a ...

  6. scala vs java 相同点和差异

    本贴是我摘抄自国外网站,用作备忘,也作为分享! Similarities between Scala and Java Following are some of the major similari ...

  7. scala攻略--简介

    在个人学习scala的过程中,产生了写一系列随笔的想法,这些随笔包括:翻译自官网.其他英文网站的文章以及自己的心得体会,本文章作为这个系列中的第一个. 由于本人能力所限,以及对scala还处于初级阶段 ...

  8. spark2.1操作json（save/read）

    建筑物配置信息: case class BuildingConfig(buildingid: String, building_height: Long, gridcount: Long, gis_d ...

  9. 数据序列化导读(3)[JSON v.s. YAML]

    前面两节介绍了JSON和YAML,本文则对下面的文章做一个中英文对照翻译. Comparison between JSON and YAML for data serialization用于数据序列化 ...

随机推荐

  1. loj 1038(dp求期望）

    题目链接:http://acm.hust.edu.cn/vjudge/problem/viewProblem.action?id=25915 题意:求一个数不断地除以他的因子,直到变成1的时候 除的次 ...

  2. 在Xcode中想要清屏该怎么实现

    XCODE的控制台不会有清屏效果,并没有像终端一样可以clear.但在某些时候我们非得想要清屏该怎么办呢??你去打开可执行文件,就会有类似清屏的效果.实际上是它帮你自动换页了,xcode左边是可以看到 ...

  3. 圆形图片CircleImageView

    github源码路径: https://github.com/hdodenhof/CircleImageView 第一步:将CircleImageView复制 第二步:将attrs.xml复制 第三步 ...

  4. 改了哪里vs调试直接用iis运行

    OAS2Web.csproj 中的useiis为true,但必须要先配置好iis网站指向文件目录  

  5. DSP using Matlab 示例Example2.2

    a. n = -2:10; x = [1:7,6:-1:1]; % generate x(n) [x11,n11] = sigshift(x,n,5); [x12,n12] = sigshift(x, ...

  6. iOS10 UI教程视图调试

    iOS10 UI教程视图调试 iOS10 UI教程视图调试,当视图很复杂的时候,层次结构就不会很简单了.Xcode可以通过视图(View)调试帮助开发者解决层次结构复杂的问题.视图调试是在Xcode ...

  7. 解决Genymotion无法创建新设备或无法显示设备列表问题

    准备工作: 链接: https://pan.baidu.com/s/1i5v4IBN 密码: jc3m 用2.8的和最新VirtualBox-5.1.10-112026-Win 注意事项: 1.笔记本 ...

  8. ashx 文件 与js文件数据交互

    //js代码 //城市下拉列表             $("#selPro").change(function() {                 var option = ...

  9. PHP历程（封装的增删改查方法）

    db.class.php   主要方法 <?php /** * 数据库配置信息 */ define('DB_HOST','127.0.0.1'); //服务器 define('DB_USER', ...

  10. jQuery入门第三天

    每个HTML元素根据继承属性都有父parent元素. 举个例子,h3 元素的父元素是 <div class="container-fluid">,<div cla ...