Android
JSON в Android с org.json
Поиск…
Синтаксис
Объект : объект представляет собой неупорядоченный набор пар имя / значение. Объект начинается с {(левая скобка) и заканчивается на} (правая фигурная скобка). За каждым именем следует: (двоеточие), а пары имя / значение разделяются запятой.
Массив : массив представляет собой упорядоченный набор значений. Массив начинается с [(левая скобка) и заканчивается на] (правая скобка). Значения разделяются запятой.
Значение . Значение может быть строкой в двойных кавычках, или числом, или истинным, или ложным или нулевым, или объектом или массивом. Эти структуры могут быть вложенными.
Строка : Строка представляет собой последовательность из нуля или более символов Юникода, завернутую в двойные кавычки, с помощью обратных слэшей. Символ представляется как одна символьная строка. Строка очень похожа на строку C или Java.
Номер : число очень похоже на число C или Java, за исключением того, что восьмеричные и шестнадцатеричные форматы не используются.
замечания
Разбирайте простой объект JSON
Рассмотрим следующую строку JSON:
{
"title": "test",
"content": "Hello World!!!",
"year": 2016,
"names" : [
"Hannah",
"David",
"Steve"
]
}
Этот объект JSON может быть проанализирован с использованием следующего кода:
try {
// create a new instance from a string
JSONObject jsonObject = new JSONObject(jsonAsString);
String title = jsonObject.getString("title");
String content = jsonObject.getString("content");
int year = jsonObject.getInt("year");
JSONArray names = jsonObject.getJSONArray("names"); //for an array of String objects
} catch (JSONException e) {
Log.w(TAG,"Could not parse JSON. Error: " + e.getMessage());
}
Вот еще один пример: JSONArray, вложенный внутри JSONObject:
{
"books":[
{
"title":"Android JSON Parsing",
"times_sold":186
}
]
}
Это может быть проанализировано следующим кодом:
JSONObject root = new JSONObject(booksJson);
JSONArray booksArray = root.getJSONArray("books");
JSONObject firstBook = booksArray.getJSONObject(0);
String title = firstBook.getString("title");
int timesSold = firstBook.getInt("times_sold");
Создание простого объекта JSON
Создайте JSONObject
с помощью пустого конструктора и добавьте поля, используя метод put()
, который перегружен, чтобы он мог использоваться с различными типами:
try {
// Create a new instance of a JSONObject
final JSONObject object = new JSONObject();
// With put you can add a name/value pair to the JSONObject
object.put("name", "test");
object.put("content", "Hello World!!!1");
object.put("year", 2016);
object.put("value", 3.23);
object.put("member", true);
object.put("null_value", JSONObject.NULL);
// Calling toString() on the JSONObject returns the JSON in string format.
final String json = object.toString();
} catch (JSONException e) {
Log.e(TAG, "Failed to create JSONObject", e);
}
Полученная строка JSON
выглядит так:
{
"name":"test",
"content":"Hello World!!!1",
"year":2016,
"value":3.23,
"member":true,
"null_value":null
}
Добавить JSONArray в JSONObject
// Create a new instance of a JSONArray
JSONArray array = new JSONArray();
// With put() you can add a value to the array.
array.put("ASDF");
array.put("QWERTY");
// Create a new instance of a JSONObject
JSONObject obj = new JSONObject();
try {
// Add the JSONArray to the JSONObject
obj.put("the_array", array);
} catch (JSONException e) {
e.printStackTrace();
}
String json = obj.toString();
Полученная строка JSON выглядит так:
{
"the_array":[
"ASDF",
"QWERTY"
]
}
Создайте строку JSON с нулевым значением.
Если вам нужно создать строку JSON со значением null
например:
{
"name":null
}
Затем вам нужно использовать специальную константу JSONObject.NULL .
Пример функционирования:
jsonObject.put("name", JSONObject.NULL);
Работа с нулевой строкой при разборе json
{
"some_string": null,
"ather_string": "something"
}
Если мы будем использовать этот способ:
JSONObject json = new JSONObject(jsonStr);
String someString = json.optString("some_string");
У нас будет выход:
someString = "null";
Поэтому мы должны обеспечить это обходное решение:
/**
* According to http://stackoverflow.com/questions/18226288/json-jsonobject-optstring-returns-string-null
* we need to provide a workaround to opt string from json that can be null.
* <strong></strong>
*/
public static String optNullableString(JSONObject jsonObject, String key) {
return optNullableString(jsonObject, key, "");
}
/**
* According to http://stackoverflow.com/questions/18226288/json-jsonobject-optstring-returns-string-null
* we need to provide a workaround to opt string from json that can be null.
* <strong></strong>
*/
public static String optNullableString(JSONObject jsonObject, String key, String fallback) {
if (jsonObject.isNull(key)) {
return fallback;
} else {
return jsonObject.optString(key, fallback);
}
}
А затем позвоните:
JSONObject json = new JSONObject(jsonStr);
String someString = optNullableString(json, "some_string");
String someString2 = optNullableString(json, "some_string", "");
И мы будем иметь Output, как мы и ожидали:
someString = null; //not "null"
someString2 = "";
Использование JsonReader для чтения JSON из потока
JsonReader
считывает кодированное значение JSON как поток токенов.
public List<Message> readJsonStream(InputStream in) throws IOException {
JsonReader reader = new JsonReader(new InputStreamReader(in, "UTF-8"));
try {
return readMessagesArray(reader);
} finally {
reader.close();
}
}
public List<Message> readMessagesArray(JsonReader reader) throws IOException {
List<Message> messages = new ArrayList<Message>();
reader.beginArray();
while (reader.hasNext()) {
messages.add(readMessage(reader));
}
reader.endArray();
return messages;
}
public Message readMessage(JsonReader reader) throws IOException {
long id = -1;
String text = null;
User user = null;
List<Double> geo = null;
reader.beginObject();
while (reader.hasNext()) {
String name = reader.nextName();
if (name.equals("id")) {
id = reader.nextLong();
} else if (name.equals("text")) {
text = reader.nextString();
} else if (name.equals("geo") && reader.peek() != JsonToken.NULL) {
geo = readDoublesArray(reader);
} else if (name.equals("user")) {
user = readUser(reader);
} else {
reader.skipValue();
}
}
reader.endObject();
return new Message(id, text, user, geo);
}
public List<Double> readDoublesArray(JsonReader reader) throws IOException {
List<Double> doubles = new ArrayList<Double>();
reader.beginArray();
while (reader.hasNext()) {
doubles.add(reader.nextDouble());
}
reader.endArray();
return doubles;
}
public User readUser(JsonReader reader) throws IOException {
String username = null;
int followersCount = -1;
reader.beginObject();
while (reader.hasNext()) {
String name = reader.nextName();
if (name.equals("name")) {
username = reader.nextString();
} else if (name.equals("followers_count")) {
followersCount = reader.nextInt();
} else {
reader.skipValue();
}
}
reader.endObject();
return new User(username, followersCount);
}
Создание вложенного объекта JSON
Чтобы создать вложенный объект JSON, вам нужно просто добавить один объект JSON к другому:
JSONObject mainObject = new JSONObject(); // Host object
JSONObject requestObject = new JSONObject(); // Included object
try {
requestObject.put("lastname", lastname);
requestObject.put("phone", phone);
requestObject.put("latitude", lat);
requestObject.put("longitude", lon);
requestObject.put("theme", theme);
requestObject.put("text", message);
mainObject.put("claim", requestObject);
} catch (JSONException e) {
return "JSON Error";
}
Теперь mainObject
содержит ключ, называемый claim
с целым requestObject
в качестве значения.
Обработка динамического ключа для ответа JSON
Это пример того, как обрабатывать динамический ключ для ответа. Здесь A
и B
являются динамическими ключами, это может быть что угодно
отклик
{
"response": [
{
"A": [
{
"name": "Tango"
},
{
"name": "Ping"
}
],
"B": [
{
"name": "Jon"
},
{
"name": "Mark"
}
]
}
]
}
Код Java
// ResponseData is raw string of response
JSONObject responseDataObj = new JSONObject(responseData);
JSONArray responseArray = responseDataObj.getJSONArray("response");
for (int i = 0; i < responseArray.length(); i++) {
// Nodes ArrayList<ArrayList<String>> declared globally
nodes = new ArrayList<ArrayList<String>>();
JSONObject obj = responseArray.getJSONObject(i);
Iterator keys = obj.keys();
while(keys.hasNext()) {
// Loop to get the dynamic key
String currentDynamicKey = (String)keys.next();
// Get the value of the dynamic key
JSONArray currentDynamicValue = obj.getJSONArray(currentDynamicKey);
int jsonArraySize = currentDynamicValue.length();
if(jsonArraySize > 0) {
for (int ii = 0; ii < jsonArraySize; ii++) {
// NameList ArrayList<String> declared globally
nameList = new ArrayList<String>();
if(ii == 0) {
JSONObject nameObj = currentDynamicValue.getJSONObject(ii);
String name = nameObj.getString("name");
System.out.print("Name = " + name);
// Store name in an array list
nameList.add(name);
}
}
}
nodes.add(nameList);
}
}
Проверьте наличие полей на JSON
Иногда бывает полезно проверить наличие или отсутствие поля на вашем JSON, чтобы избежать исключения JSONException
в вашем коде.
Для этого используйте JSONObject#has(String)
или метод, например, в следующем примере:
Образец JSON
{
"name":"James"
}
Код Java
String jsonStr = " { \"name\":\"James\" }";
JSONObject json = new JSONObject(jsonStr);
// Check if the field "name" is present
String name, surname;
// This will be true, since the field "name" is present on our JSON.
if (json.has("name")) {
name = json.getString("name");
}
else {
name = "John";
}
// This will be false, since our JSON doesn't have the field "surname".
if (json.has("surname")) {
surname = json.getString("surname");
}
else {
surname = "Doe";
}
// Here name == "James" and surname == "Doe".
Обновление элементов в JSON
образец json для обновления
{
"student":{"name":"Rahul", "lastname":"sharma"},
"marks":{"maths":"88"}
}
Чтобы обновить значение элементов в json, нам нужно назначить значение и обновление.
try {
// Create a new instance of a JSONObject
final JSONObject object = new JSONObject(jsonString);
JSONObject studentJSON = object.getJSONObject("student");
studentJSON.put("name","Kumar");
object.remove("student");
object.put("student",studentJSON);
// Calling toString() on the JSONObject returns the JSON in string format.
final String json = object.toString();
} catch (JSONException e) {
Log.e(TAG, "Failed to create JSONObject", e);
}
обновленное значение
{
"student":{"name":"Kumar", "lastname":"sharma"},
"marks":{"maths":"88"}
}