Scala Language
JSON

JSON z spray-json

spray-json zapewnia łatwy sposób pracy z JSON. Używając niejawnych formatów, wszystko dzieje się „za kulisami”:

Udostępnij bibliotekę za pomocą SBT

Aby zarządzać spray-json z zależnościami biblioteki zarządzanej SBT :

libraryDependencies += "io.spray" %% "spray-json" % "1.3.2"

Należy pamiętać, że ostatni parametr, numer wersji ( 1.3.2 ), może być inny w różnych projektach.

Biblioteka spray-json jest hostowana na repo.spray.io .

Zaimportuj bibliotekę

import spray.json._
import DefaultJsonProtocol._

Domyślny protokół JSON DefaultJsonProtocol zawiera formaty dla wszystkich podstawowych typów. Aby zapewnić funkcjonalność JSON dla typów niestandardowych, użyj programów budujących wygodę dla formatów lub wyraźnego zapisu formatów.

Przeczytaj JSON

// generates an intermediate JSON representation (abstract syntax tree)
val res = """{ "foo": "bar" }""".parseJson // JsValue = {"foo":"bar"}

res.convertTo[Map[String, String]] // Map(foo -> bar)

Napisz JSON

val values = List("a", "b", "c")
values.toJson.prettyPrint // ["a", "b", "c"]

DSL

DSL nie jest obsługiwany.

Odczyt i zapis do klas przypadków

Poniższy przykład pokazuje, jak serializować obiekt klasy sprawy do formatu JSON.

case class Address(street: String, city: String)
case class Person(name: String, address: Address)

// create the formats and provide them implicitly
implicit val addressFormat = jsonFormat2(Address)
implicit val personFormat = jsonFormat2(Person)

// serialize a Person
Person("Fred", Address("Awesome Street 9", "SuperCity"))
val fredJsonString = fred.toJson.prettyPrint

Powoduje to następujący JSON:

{
  "name": "Fred",
  "address": {
    "street": "Awesome Street 9",
    "city": "SuperCity"
  }
}

Z kolei JSON może zostać przekształcony z postaci szeregowej z powrotem w obiekt:

val personRead = fredJsonString.parseJson.convertTo[Person] 
//Person(Fred,Address(Awesome Street 9,SuperCity))

Format niestandardowy

Napisz niestandardowy JsonFormat jeśli JsonFormat jest specjalna serializacja typu. Na przykład, jeśli nazwy pól są inne w Scali niż w JSON. Lub, jeśli na podstawie danych wejściowych tworzone są różne typy betonu.

implicit object BetterPersonFormat extends JsonFormat[Person] {
    // deserialization code
    override def read(json: JsValue): Person = {
        val fields = json.asJsObject("Person object expected").fields
        Person(
            name = fields("name").convertTo[String],
            address = fields("home").convertTo[Address]
        )
    }

    // serialization code
    override def write(person: Person): JsValue = JsObject(
        "name" -> person.name.toJson,
        "home" -> person.address.toJson
    )
}

JSON z Circe

Circe zapewnia kodeki pochodzące z czasu kompilacji dla en / decode json na klasy przypadków. Prosty przykład wygląda następująco:

import io.circe._
import io.circe.generic.auto._
import io.circe.parser._
import io.circe.syntax._

case class User(id: Long, name: String)

val user = User(1, "John Doe")

// {"id":1,"name":"John Doe"}
val json = user.asJson.noSpaces

// Right(User(1L, "John Doe"))
val res: Either[Error, User] = decode[User](json)

JSON z play-json

play-json używa niejawnych formatów jak inne frameworki json

Zależność SBT: libraryDependencies += ""com.typesafe.play" %% "play-json" % "2.4.8"

import play.api.libs.json._
import play.api.libs.functional.syntax._ // if you need DSL

DefaultFormat zawiera domyślne formaty do odczytu / zapisu wszystkich podstawowych typów. Aby zapewnić funkcjonalność JSON dla własnych typów, możesz użyć konstruktorów wygody dla formatów lub zapisać formaty jawnie.

Przeczytaj json

// generates an intermediate JSON representation (abstract syntax tree)
val res = Json.parse("""{ "foo": "bar" }""") // JsValue = {"foo":"bar"}

res.as[Map[String, String]]                  // Map(foo -> bar)
res.validate[Map[String, String]]            //JsSuccess(Map(foo -> bar),)

Napisz Json

val values = List("a", "b", "c")
Json.stringify(Json.toJson(values))          // ["a", "b", "c"]

DSL

val json = parse("""{ "foo": [{"foo": "bar"}]}""")
(json \ "foo").get                    //Simple path: [{"foo":"bar"}]
(json \\ "foo")                       //Recursive path:List([{"foo":"bar"}], "bar")
(json \ "foo")(0).get                  //Index lookup (for JsArrays): {"foo":"bar"}

Jak zawsze wolą dopasowywania wzorców przeciw JsSuccess / JsError i starają się unikać .get , array(i) połączeń.

Czytaj i pisz do klasy sprawy

case class Address(street: String, city: String)
case class Person(name: String, address: Address)

// create the formats and provide them implicitly
implicit val addressFormat = Json.format[Address]
implicit val personFormat = Json.format[Person]

// serialize a Person
val fred = Person("Fred", Address("Awesome Street 9", "SuperCity"))
val fredJsonString = Json.stringify(Json.toJson(Json.toJson(fred)))

val personRead = Json.parse(fredJsonString).as[Person] //Person(Fred,Address(Awesome Street 9,SuperCity))

Własny format

Możesz napisać własny format JsonFormat, jeśli potrzebujesz specjalnej serializacji swojego typu (np. Nazwij pola inaczej w Scala i Json lub utwórz instancję różnych typów betonu na podstawie danych wejściowych)

case class Address(street: String, city: String)

// create the formats and provide them implicitly
implicit object AddressFormatCustom extends Format[Address] {
  def reads(json: JsValue): JsResult[Address] = for {
    street <- (json \ "Street").validate[String]
    city <- (json \ "City").validate[String]
  } yield Address(street, city)

  def writes(x: Address): JsValue = Json.obj(
    "Street" -> x.street,
    "City" -> x.city
  )
}
// serialize an address
val address = Address("Awesome Street 9", "SuperCity")
val addressJsonString = Json.stringify(Json.toJson(Json.toJson(address)))
//{"Street":"Awesome Street 9","City":"SuperCity"}

val addressRead = Json.parse(addressJsonString).as[Address] 
//Address(Awesome Street 9,SuperCity)

Alternatywny

Jeśli json nie dokładnie dopasowane do pól klasy etui ( isAlive w przypadku klasy vs is_alive w json):

case class User(username: String, friends: Int, enemies: Int, isAlive: Boolean)

object User {

  import play.api.libs.functional.syntax._
  import play.api.libs.json._

  implicit val userReads: Reads[User] = (
      (JsPath \ "username").read[String] and
      (JsPath \ "friends").read[Int] and
      (JsPath \ "enemies").read[Int] and
      (JsPath \ "is_alive").read[Boolean]
    ) (User.apply _)
}

Json z opcjonalnymi polami

case class User(username: String, friends: Int, enemies: Int, isAlive: Option[Boolean])

object User {

  import play.api.libs.functional.syntax._
  import play.api.libs.json._

  implicit val userReads: Reads[User] = (
      (JsPath \ "username").read[String] and
      (JsPath \ "friends").read[Int] and
      (JsPath \ "enemies").read[Int] and
      (JsPath \ "is_alive").readNullable[Boolean]
    ) (User.apply _)
}

Odczytywanie znaczników czasu z JSON

Wyobraź sobie, że masz obiekt Json z uniksowym polem czasowym:

{
  "field": "example field",
  "date": 1459014762000
}

rozwiązanie:

case class JsonExampleV1(field: String, date: DateTime)
object JsonExampleV1{
  implicit val r: Reads[JsonExampleV1] = (
    (__ \ "field").read[String] and
      (__ \ "date").read[DateTime](Reads.DefaultJodaDateReads)
    )(JsonExampleV1.apply _)
}

Czytanie niestandardowych klas spraw

Teraz, jeśli otoczysz identyfikatory obiektów dla bezpieczeństwa typu, spodoba ci się to. Zobacz następujący obiekt json:

{
  "id": 91,
  "data": "Some data"
}

i odpowiednie klasy spraw:

case class MyIdentifier(id: Long)

case class JsonExampleV2(id: MyIdentifier, data: String)

Teraz musisz tylko przeczytać typ pierwotny (Długi) i odwzorować na swój identyfikator:

object JsonExampleV2 {
  implicit val r: Reads[JsonExampleV2] = (
      (__ \ "id").read[Long].map(MyIdentifier) and
    (__ \ "data").read[String]
    )(JsonExampleV2.apply _)
}

kod na https://github.com/pedrorijo91/scala-play-json-examples

JSON z json4s

json4s używa niejawnych formatów jak inne frameworki json.

Zależność SBT:

libraryDependencies += "org.json4s" %% "json4s-native" % "3.4.0"
//or
libraryDependencies += "org.json4s" %% "json4s-jackson" % "3.4.0"

Import

import org.json4s.JsonDSL._
import org.json4s._
import org.json4s.native.JsonMethods._

implicit val formats = DefaultFormats

DefaultFormats zawiera domyślne formaty do odczytu / zapisu wszystkich podstawowych typów.

Przeczytaj json

// generates an intermediate JSON representation (abstract syntax tree)
val res = parse("""{ "foo": "bar" }""")           // JValue = {"foo":"bar"}
res.extract[Map[String, String]]                  // Map(foo -> bar)

Napisz Json

val values = List("a", "b", "c")
compact(render(values))         // ["a", "b", "c"]

DSL

json \ "foo"       //Simple path: JArray(List(JObject(List((foo,JString(bar))))))
json \\ "foo"      //Recursive path: ~List([{"foo":"bar"}], "bar")
(json \ "foo")(0)  //Index lookup (for JsArrays): JObject(List((foo,JString(bar))))
("foo" -> "bar") ~ ("field" -> "value")    // {"foo":"bar","field":"value"}

Czytaj i pisz do klasy sprawy

import org.json4s.native.Serialization.{read, write}

case class Address(street: String, city: String)
val addressString = write(Address("Awesome stree", "Super city")) 
// {"street":"Awesome stree","city":"Super city"}

read[Address](addressString) // Address(Awesome stree,Super city)
//or
parse(addressString).extract[Address]

Czytaj i pisz listy heterogeniczne

Aby serializować i deserializować heterogeniczną (lub polimorficzną) listę, należy podać konkretne wskazówki dotyczące typu.

trait Location
case class Street(name: String) extends Location
case class City(name: String, zipcode: String) extends Location
case class Address(street: Street, city: City) extends Location
case class Locations (locations : List[Location])

implicit val formats = Serialization.formats(ShortTypeHints(List(classOf[Street], classOf[City], classOf[Address])))

val locationsString = write(Locations(Street("Lavelle Street"):: City("Super city","74658")))

read[Locations](locationsString)

Własny format

class AddressSerializer extends CustomSerializer[Address](format => (
  {
    case JObject(JField("Street", JString(s)) :: JField("City", JString(c)) :: Nil) =>
      new Address(s, c)
  },
  {
    case x: Address => ("Street" -> x.street) ~ ("City" -> x.city)
  }
  ))

implicit val formats = DefaultFormats + new AddressSerializer
val str = write[Address](Address("Awesome Stree", "Super City"))
// {"Street":"Awesome Stree","City":"Super City"}
read[Address](str) 
// Address(Awesome Stree,Super City)