CODEWITHSUNDEEP
scalasprayspray-json
saad
saad

Reputation: 381

spray json attribute with special char

I have json where the attribute name has a special char. Trying to get it to parse with spray json. Below is code How can I get the attribute name in json @xml:lang be parsed into the case class.

import spray.json._
import DefaultJsonProtocol._

object SpecialCharInName extends App {

  case class Person(name: String, `@xml:lang`: String)

  val json = """ {"name":"MyName", "@xml:lang":"US"} """

  object PersonProtocol extends DefaultJsonProtocol {
    implicit val personFormat = jsonFormat2(Person)
  }

  import PersonProtocol._
  val person = json.parseJson
  val personClass = person.convertTo[Person]

  println(personClass)

}

The code above throws exception as below

[error] (run-main-0) spray.json.DeserializationException: Object is missing required member '@xml$colonlang'
spray.json.DeserializationException: Object is missing required member '@xml$colonlang'
at spray.json.package$.deserializationError(package.scala:23)
at spray.json.ProductFormats$class.fromField(ProductFormats.scala:60)
at c.c.s.f.v.d.SpecialCharInName$PersonProtocol$.fromField(SpecialCharInName.scala:12)
at spray.json.ProductFormatsInstances$$anon$2.read(ProductFormatsInstances.scala:56)
at spray.json.ProductFormatsInstances$$anon$2.read(ProductFormatsInstances.scala:46)
at spray.json.JsValue.convertTo(JsValue.scala:31)
at c.c.s.f.v.d.SpecialCharInName$.delayedEndpoint$com$comcast$sv$fabric$vimond$domain$SpecialCharInName$1(SpecialCharInName.scala:20)
at c.c.s.f.v.d.SpecialCharInName$delayedInit$body.apply(SpecialCharInName.scala:6)
at scala.Function0$class.apply$mcV$sp(Function0.scala:40)
at scala.runtime.AbstractFunction0.apply$mcV$sp(AbstractFunction0.scala:12)
at scala.App$$anonfun$main$1.apply(App.scala:76)
at scala.App$$anonfun$main$1.apply(App.scala:76)
at scala.collection.immutable.List.foreach(List.scala:381)
at scala.collection.generic.TraversableForwarder$class.foreach(TraversableForwarder.scala:35)
at scala.App$class.main(App.scala:76)
at c.c.s.f.v.d.SpecialCharInName$.main(SpecialCharInName.scala:6)
at c.c.s.f.v.d.SpecialCharInName.main(SpecialCharInName.scala)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:497)
Caused by: java.util.NoSuchElementException: key not found: @xml$colonlang
at scala.collection.MapLike$class.default(MapLike.scala:228)
at scala.collection.AbstractMap.default(Map.scala:59)
at scala.collection.MapLike$class.apply(MapLike.scala:141)
at scala.collection.AbstractMap.apply(Map.scala:59)
at spray.json.ProductFormats$class.fromField(ProductFormats.scala:57)
at c.c.s.f.v.d.SpecialCharInName$PersonProtocol$.fromField(SpecialCharInName.scala:12)
at spray.json.ProductFormatsInstances$$anon$2.read(ProductFormatsInstances.scala:56)
at spray.json.ProductFormatsInstances$$anon$2.read(ProductFormatsInstances.scala:46)
at spray.json.JsValue.convertTo(JsValue.scala:31)
at c.c.s.f.v.d.SpecialCharInName$.delayedEndpoint$com$comcast$sv$fabric$vimond$domain$SpecialCharInName$1(SpecialCharInName.scala:20)
at c.c.s.f.v.d.SpecialCharInName$delayedInit$body.apply(SpecialCharInName.scala:6)
at scala.Function0$class.apply$mcV$sp(Function0.scala:40)
at scala.runtime.AbstractFunction0.apply$mcV$sp(AbstractFunction0.scala:12)
at scala.App$$anonfun$main$1.apply(App.scala:76)
at scala.App$$anonfun$main$1.apply(App.scala:76)
at scala.collection.immutable.List.foreach(List.scala:381)
at scala.collection.generic.TraversableForwarder$class.foreach(TraversableForwarder.scala:35)
at scala.App$class.main(App.scala:76)
at c.c.s.f.v.d.SpecialCharInName$.main(SpecialCharInName.scala:6)
at c.c.s.f.v.d.SpecialCharInName.main(SpecialCharInName.scala)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:497)

Thanks for your help in advance.

Saad

Upvotes: 2

Views: 787

Answers (1)

jdevelop
jdevelop

Reputation: 12296

import spray.json._
import DefaultJsonProtocol._

object SpecialCharInName extends App {

  case class Person(name: String, `@xml:lang`: String)

  val json = """ {"name":"MyName", "@xml:lang":"US"} """

  object PersonProtocol extends DefaultJsonProtocol {
    implicit val personFormat = jsonFormat(Person.apply, "name", "@xml:lang")
  }

  import PersonProtocol._

  val person = json.parseJson
  val personClass = person.convertTo[Person]
  println(personClass)
}

Enjoy :)

Simply put, use the dedicated jsonFormat method that accepts a builder method (like apply) and a list of named properties that must present in a JSON document being parsed. The default one doesn't work very well in your case.

Upvotes: 3

Related Questions