How to access values inside JSON?
Info: JavaScript is currently disabled, code tabs will still work, but preferences will not be remembered.
Using Scala CLI, you can require the entire toolkit in a single line:
//> using toolkit latest
Alternatively, you can require just a specific version of UPickle:
//> using dep com.lihaoyi::upickle:4.1.0
In your build.sbt file, you can add the dependency on the Toolkit:
lazy val example = project.in(file("."))
.settings(
scalaVersion := "3.4.2",
libraryDependencies += "org.scala-lang" %% "toolkit" % "0.7.0"
)
Alternatively, you can require just a specific version of UPickle:
libraryDependencies += "com.lihaoyi" %% "upickle" % "4.1.0"
In your build.sc file, you can add the dependency to the upickle library:
object example extends ScalaModule {
def scalaVersion = "3.4.2"
def ivyDeps =
Agg(
ivy"org.scala-lang::toolkit:0.7.0"
)
}
Alternatively, you can require just a specific version of UPickle:
ivy"com.lihaoyi::upickle:4.1.0"
Accessing values inside JSON
To parse a JSON string and access fields inside it, you can use uJson, which is part of uPickle.
The method ujson.read parses a JSON string into memory:
val jsonString = """{"name": "Peter", "age": 13, "pets": ["Toolkitty", "Scaniel"]}"""
val json: ujson.Value = ujson.read(jsonString)
println(json("name").str)
// prints: Peter
To access the "name" field, we do json("name") and then call str to type it as a string.
To access the elements by index in a JSON array,
val pets: ujson.Value = json("pets")
val firstPet: String = pets(0).str
val secondPet: String = pets(1).str
println(s"The pets are $firstPet and $secondPet")
// prints: The pets are Toolkitty and Scaniel
You can traverse the JSON structure as deeply as you want, to extract any nested value.
For instance, json("field1")(0)("field2").str is the string value of field2 in the first element of the array in field1.
JSON types
In the previous examples we used str to type a JSON value as a string.
Similar methods exist for other types of values, namely:
numfor numeric values, returningDoubleboolfor boolean values, returningBooleanarrfor arrays, returning a mutableBuffer[ujson.Value]objfor objects, returning a mutableMap[String, ujson.Value]
import scala.collection.mutable
val jsonString = """{"name": "Peter", "age": 13, "pets": ["Toolkitty", "Scaniel"]}"""
val json = ujson.read(jsonString)
val person: mutable.Map[String, ujson.Value] = json.obj
val age: Double = person("age").num
val pets: mutable.Buffer[ujson.Value] = person("pets").arr
If a JSON value does not conform to the expected type, uJson throws a ujson.Value.InvalidData exception.
val name: Boolean = person("name").bool
// throws a ujson.Value.InvalidData: Expected ujson.Bool (data: "Peter")