Перейти к содержимому

Как обработать json ответ js

  • автор:

API JavaScript Fetch: как обрабатывать данные JSON

Я использую Fetch API в JavaScript, чтобы отправить HTTP-запрос GET к конечной точке JSON. Однако у меня возникли проблемы с обработкой данных JSON после их получения. Как я могу правильно получать и обрабатывать данные JSON в JavaScript?

Вот мой текущий код:

Хотя этот код работает, я не знаю, как обрабатывать потенциальные ошибки или исключения, такие как проблемы с сетью или неправильное форматирование JSON. Кроме того, я хотел бы дополнительно обработать данные JSON, например отобразить их на веб-странице или извлечь определенные значения.

Может ли кто-нибудь предоставить лучшие методы обработки данных JSON, полученных через Fetch API, включая обработку ошибок и манипулирование данными? Будем очень признательны за любые примеры кода или предложения. Спасибо!

killua2
12.09.23 11:11:56 MSK

  • Ответить на это сообщение
  • Ссылка

Форматы JSON и XML

JSON (JavaScript Object Notation) представляет легковесный формат хранения данных. JSON описывает структуру и организацию данных JavaScript. Простота JSON привела к тому, что в настоящий момент он является наиболее популярным форматом передачи данных в среде web, вытеснив другой некогда популярный формат xml.

Объекты JSON очень похожи на объекты JavaScript, тем более что JSON является подмножеством JavaScript. В то же время важно их различать: JavaScript является языком программирования, а JSON является форматом данных.

JSON поддерживает три типа данных: примитивные значения, объекты и массивы. Примитивные значения представляют стандартные строки, числа, значение null, логические значения true и false.

Объекты представляют набор простейших данных, других объектов и массивов. Например, типичный объект JSON:

В javascript этому объекту соответствовал бы следующий:

const user =

Несмотря на общее сходство, в то же время есть и различия: в JSON названия свойств заключаются в двойные кавычки, как обычные строки. Кроме того, объекты JSON не могут хранить функции, переменные, как объекты javascript.

Объекты могут быть сложными:

Массивы в JSON похожи на массивы javascript и также могут хранить простейшие данные или объекты:

["Tom", true, 30]

Сериализация в JSON и десериализация

Для работы с форматом JSON в языке JavaScript предназначен JSON . Он позволяет преобразовать объект JavaScript в формат json и наоборот.

Для сериализации объекта javascript в json применяется функция JSON.stringify() :

// объект javascript const user = < name: "Tom", married: false, age: 39 >; // объект json const serializedUser = JSON.stringify(user); console.log(serializedUser); //

Для обратной операции — десериализации или парсинга json-объекта в javascript применяется метод JSON.parse() :

const user = < name: "Tom", married: false, age: 39 >; // сериализация const serializedUser = JSON.stringify(user); // десериализация const tomUser = JSON.parse(serializedUser); console.log(tomUser.name); // Tom

JSON.parse()

Обычно JSON используется для обмена данными с сервером.

При получении с сервера данные всегда передаются в виде строки.

Если обработать эти данные при помощи функции JSON.parse(), то они станут объектом JavaScript.

Парсинг данных JSON

Представьте, что с сервера мы получили такой текст:

Используем JavaScript функцию JSON.parse(), чтобы преобразовать этот текст в объект JavaScript:

 var obj = JSON.parse('< "name":"John", "age":30, "city":"New York">'); 

Внимание! Убедитесь, что преобразуемый текст записан в формате JSON, иначе вы получите ошибку синтаксиса.

Используем полученный объект JavaScript на странице:

   

Получение данных JSON с сервера

Получить данные JSON с сервера можно, например, используя запрос AJAX.

Так как ответ сервера записан в формате JSON, вы можете преобразовать строку в объект JavaScript.

В следующем примере используется XMLHttpRequest, чтобы получить данные с сервера:

 var xmlhttp = new XMLHttpRequest(); xmlhttp.onreadystatechange = function() < if (this.readyState == 4 && this.status == 200) < var myObj = JSON.parse(this.responseText); document.getElementById("demo").innerHTML = myObj.name; >>; xmlhttp.open("GET", "json_demo.txt", true); xmlhttp.send(); 

Массивы как данные JSON

Если функция JSON.parse() используется для парсинга данных JSON, полученных из массива, то будет возвращен массив JavaScript, а не объект.

В следующем примере возвращенные с сервера данные JSON являются массивом:

 var xmlhttp = new XMLHttpRequest(); xmlhttp.onreadystatechange = function() < if (this.readyState == 4 && this.status == 200) < var myArr = JSON.parse(this.responseText); document.getElementById("demo").innerHTML = myArr[0]; >>; xmlhttp.open("GET", "json_demo_array.txt", true); xmlhttp.send(); 

Парсинг дат

Объекты даты и времени (тип Date) нельзя использовать в JSON.

Если вам необходимо включить в данные дату, записывайте ее как строку.

Когда это потребуется, вы сможете преобразовать ее обратно в объект:

 var text = '< "name":"John", "birth":"1986-12-14", "city":"New York">'; var obj = JSON.parse(text); obj.birth = new Date(obj.birth); document.getElementById("demo").innerHTML = obj.name + ", " + obj.birth; 

Либо можно воспользоваться вторым параметром функции JSON.parse().

В качестве второго параметра передается функция, которая проверяет каждое свойство перед тем, как вернуть его значение.

В следующем примере строка преобразуется в объект даты, при помощи второго параметра JSON.parse():

 var text = '< "name":"John", "birth":"1986-12-14", "city":"New York">'; var obj = JSON.parse(text, function (key, value) < if (key == "birth") < return new Date(value); >else < return value; >>); document.getElementById("demo").innerHTML = obj.name + ", " + obj.birth; 

Парсинг функций

Функции нельзя использовать в JSON.

Если вам необходимо включить в данные функцию, записывайте ее как строку.

Когда это потребуется, вы сможете преобразовать ее обратно в функцию:

 var text = '< "name":"John", "age":"function () ", "city":"New York">'; var obj = JSON.parse(text); obj.age = eval("(" + obj.age + ")"); document.getElementById("demo").innerHTML = obj.name + ", " + obj.age(); 

Внимание! Следует избегать использования функций в JSON, так как в этом случае теряется их область видимости, а для обратного преобразования приходится использовать функцию eval(), что нежелательно.

Поддержка браузерами

Функция JSON.parse() включена во все основные браузеры и в последний стандарт ECMAScript (JavaScript).

Формат JSON, метод toJSON

Допустим, у нас есть сложный объект, и мы хотели бы преобразовать его в строку, чтобы отправить по сети или просто вывести для логирования.

Естественно, такая строка должна включать в себя все важные свойства.

Мы могли бы реализовать преобразование следующим образом:

let user = < name: "John", age: 30, toString() < return `", age: $>`; > >; alert(user); //

…Но в процессе разработки добавляются новые свойства, старые свойства переименовываются и удаляются. Обновление такого toString каждый раз может стать проблемой. Мы могли бы попытаться перебрать свойства в нём, но что, если объект сложный, и в его свойствах имеются вложенные объекты? Мы должны были бы осуществить их преобразование тоже.

К счастью, нет необходимости писать код для обработки всего этого. У задачи есть простое решение.

JSON.stringify

JSON (JavaScript Object Notation) – это общий формат для представления значений и объектов. Его описание задокументировано в стандарте RFC 4627. Первоначально он был создан для JavaScript, но многие другие языки также имеют библиотеки, которые могут работать с ним. Таким образом, JSON легко использовать для обмена данными, когда клиент использует JavaScript, а сервер написан на Ruby/PHP/Java или любом другом языке.

JavaScript предоставляет методы:

  • JSON.stringify для преобразования объектов в JSON.
  • JSON.parse для преобразования JSON обратно в объект.

Например, здесь мы преобразуем через JSON.stringify данные студента:

let student = < name: 'John', age: 30, isAdmin: false, courses: ['html', 'css', 'js'], wife: null >; let json = JSON.stringify(student); alert(typeof json); // мы получили строку! alert(json); /* выведет объект в формате JSON: < "name": "John", "age": 30, "isAdmin": false, "courses": ["html", "css", "js"], "wife": null >*/

Метод JSON.stringify(student) берёт объект и преобразует его в строку.

Полученная строка json называется JSON-форматированным или сериализованным объектом. Мы можем отправить его по сети или поместить в обычное хранилище данных.

Обратите внимание, что объект в формате JSON имеет несколько важных отличий от объектного литерала:

  • Строки используют двойные кавычки. Никаких одинарных кавычек или обратных кавычек в JSON. Так ‘John’ становится «John» .
  • Имена свойств объекта также заключаются в двойные кавычки. Это обязательно. Так age:30 становится «age»:30 .

JSON.stringify может быть применён и к примитивам.

JSON поддерживает следующие типы данных:

  • Объекты
  • Массивы [ . ]
  • Примитивы:
    • строки,
    • числа,
    • логические значения true/false ,
    • null .
    // число в JSON остаётся числом alert( JSON.stringify(1) ) // 1 // строка в JSON по-прежнему остаётся строкой, но в двойных кавычках alert( JSON.stringify('test') ) // "test" alert( JSON.stringify(true) ); // true alert( JSON.stringify([1, 2, 3]) ); // [1,2,3]

    JSON является независимой от языка спецификацией для данных, поэтому JSON.stringify пропускает некоторые специфические свойства объектов JavaScript.

    • Свойства-функции (методы).
    • Символьные ключи и значения.
    • Свойства, содержащие undefined .
    let user = < sayHi() < // будет пропущено alert("Hello"); >, [Symbol("id")]: 123, // также будет пропущено something: undefined // как и это - пропущено >; alert( JSON.stringify(user) ); // <> (пустой объект)

    Обычно это нормально. Если это не то, чего мы хотим, то скоро мы увидим, как можно настроить этот процесс.

    Самое замечательное, что вложенные объекты поддерживаются и конвертируются автоматически.

    let meetup = < title: "Conference", room: < number: 23, participants: ["john", "ann"] >>; alert( JSON.stringify(meetup) ); /* вся структура преобразована в строку: < "title":"Conference", "room":, > */

    Важное ограничение: не должно быть циклических ссылок.

    let room = < number: 23 >; let meetup = < title: "Conference", participants: ["john", "ann"] >; meetup.place = room; // meetup ссылается на room room.occupiedBy = meetup; // room ссылается на meetup JSON.stringify(meetup); // Ошибка: Преобразование цикличной структуры в JSON

    Здесь преобразование завершается неудачно из-за циклической ссылки: room.occupiedBy ссылается на meetup , и meetup.place ссылается на room :

    Исключаем и преобразуем: replacer

    Полный синтаксис JSON.stringify :

    let json = JSON.stringify(value, [replacer, space])

    value Значение для кодирования. replacer Массив свойств для кодирования или функция соответствия function(key, value) . space Дополнительное пространство (отступы), используемое для форматирования.

    В большинстве случаев JSON.stringify используется только с первым аргументом. Но если нам нужно настроить процесс замены, например, отфильтровать циклические ссылки, то можно использовать второй аргумент JSON.stringify .

    Если мы передадим ему массив свойств, будут закодированы только эти свойства.

    let room = < number: 23 >; let meetup = < title: "Conference", participants: [, ], place: room // meetup ссылается на room >; room.occupiedBy = meetup; // room ссылается на meetup alert( JSON.stringify(meetup, ['title', 'participants']) ); // <"title":"Conference","participants":[<>,<>]>

    Здесь мы, наверное, слишком строги. Список свойств применяется ко всей структуре объекта. Так что внутри participants – пустые объекты, потому что name нет в списке.

    Давайте включим в список все свойства, кроме room.occupiedBy , из-за которого появляется цикличная ссылка:

    let room = < number: 23 >; let meetup = < title: "Conference", participants: [, ], place: room // meetup ссылается на room >; room.occupiedBy = meetup; // room ссылается на meetup alert( JSON.stringify(meetup, ['title', 'participants', 'place', 'name', 'number']) ); /* < "title":"Conference", "participants":[,], "place": > */

    Теперь всё, кроме occupiedBy , сериализовано. Но список свойств довольно длинный.

    К счастью, в качестве replacer мы можем использовать функцию, а не массив.

    Функция будет вызываться для каждой пары (key, value) , и она должна возвращать заменённое значение, которое будет использоваться вместо исходного. Или undefined , чтобы пропустить значение.

    В нашем случае мы можем вернуть value «как есть» для всего, кроме occupiedBy . Чтобы игнорировать occupiedBy , код ниже возвращает undefined :

    let room = < number: 23 >; let meetup = < title: "Conference", participants: [, ], place: room // meetup ссылается на room >; room.occupiedBy = meetup; // room ссылается на meetup alert( JSON.stringify(meetup, function replacer(key, value) < alert(`$: $`); return (key == 'occupiedBy') ? undefined : value; >)); /* пары ключ:значение, которые приходят в replacer: : [object Object] title: Conference participants: [object Object],[object Object] 0: [object Object] name: John 1: [object Object] name: Alice place: [object Object] number: 23 occupiedBy: [object Object] */

    Обратите внимание, что функция replacer получает каждую пару ключ/значение, включая вложенные объекты и элементы массива. И она применяется рекурсивно. Значение this внутри replacer – это объект, который содержит текущее свойство.

    Первый вызов – особенный. Ему передаётся специальный «объект-обёртка»: . Другими словами, первая (key, value) пара имеет пустой ключ, а значением является целевой объект в общем. Вот почему первая строка из примера выше будет «:[object Object]» .

    Идея состоит в том, чтобы дать как можно больше возможностей replacer – у него есть возможность проанализировать и заменить/пропустить даже весь объект целиком, если это необходимо.

    Форматирование: space

    Третий аргумент в JSON.stringify(value, replacer, space) – это количество пробелов, используемых для удобного форматирования.

    Ранее все JSON-форматированные объекты не имели отступов и лишних пробелов. Это нормально, если мы хотим отправить объект по сети. Аргумент space используется исключительно для вывода в удобочитаемом виде.

    Ниже space = 2 указывает JavaScript отображать вложенные объекты в несколько строк с отступом в 2 пробела внутри объекта:

    let user = < name: "John", age: 25, roles: < isAdmin: false, isEditor: true >>; alert(JSON.stringify(user, null, 2)); /* отступ в 2 пробела: < "name": "John", "age": 25, "roles": < "isAdmin": false, "isEditor": true >> */ /* для JSON.stringify(user, null, 4) результат содержит больше отступов: < "name": "John", "age": 25, "roles": < "isAdmin": false, "isEditor": true >> */

    Третьим аргументом также может быть строка. В этом случае строка будет использоваться для отступа вместо ряда пробелов.

    Параметр space применяется исключительно для логирования и красивого вывода.

    Пользовательский «toJSON»

    Как и toString для преобразования строк, объект может предоставлять метод toJSON для преобразования в JSON. JSON.stringify автоматически вызывает его, если он есть.

    let room = < number: 23 >; let meetup = < title: "Conference", date: new Date(Date.UTC(2017, 0, 1)), room >; alert( JSON.stringify(meetup) ); /* < "title":"Conference", "date":"2017-01-01T00:00:00.000Z", // (1) "room": // (2) > */

    Как видим, date (1) стал строкой. Это потому, что все объекты типа Date имеют встроенный метод toJSON , который возвращает такую строку.

    Теперь давайте добавим собственную реализацию метода toJSON в наш объект room (2) :

    let room = < number: 23, toJSON() < return this.number; >>; let meetup = < title: "Conference", room >; alert( JSON.stringify(room) ); // 23 alert( JSON.stringify(meetup) ); /* < "title":"Conference", "room": 23 >*/

    Как видите, toJSON используется как при прямом вызове JSON.stringify(room) , так и когда room вложен в другой сериализуемый объект.

    JSON.parse

    Чтобы декодировать JSON-строку, нам нужен другой метод с именем JSON.parse.

    let value = JSON.parse(str, [reviver]);

    str JSON для преобразования в объект. reviver Необязательная функция, которая будет вызываться для каждой пары (ключ, значение) и может преобразовывать значение.

    // строковый массив let numbers = "[0, 1, 2, 3]"; numbers = JSON.parse(numbers); alert( numbers[1] ); // 1

    Или для вложенных объектов:

    let user = '< "name": "John", "age": 35, "isAdmin": false, "friends": [0,1,2,3] >'; user = JSON.parse(user); alert( user.friends[1] ); // 1

    JSON может быть настолько сложным, насколько это необходимо, объекты и массивы могут включать другие объекты и массивы. Но они должны быть в том же JSON-формате.

    Вот типичные ошибки в написанном от руки JSON (иногда приходится писать его для отладки):

    let json = `< name: "John", // Ошибка: имя свойства без кавычек "surname": 'Smith', // Ошибка: одинарные кавычки в значении (должны быть двойными) 'isAdmin': false, // Ошибка: одинарные кавычки в ключе (должны быть двойными) "birthday": new Date(2000, 2, 3), // Ошибка: не допускается конструктор "new", только значения "gender": "male" // Ошибка: отсутствует запятая после непоследнего свойства "friends": [0,1,2,3], // Ошибка: не должно быть запятой после последнего свойства >`;

    Кроме того, JSON не поддерживает комментарии. Добавление комментария в JSON делает его недействительным.

    Существует ещё один формат JSON5, который поддерживает ключи без кавычек, комментарии и т.д. Но это самостоятельная библиотека, а не спецификация языка.

    Обычный JSON настолько строг не потому, что его разработчики ленивы, а потому, что позволяет легко, надёжно и очень быстро реализовывать алгоритм кодирования и чтения.

    Использование reviver

    Представьте, что мы получили объект meetup с сервера в виде строки данных.

    // title: (meetup title), date: (meetup date) let str = '';

    …А теперь нам нужно десериализовать её, т.е. снова превратить в объект JavaScript.

    Давайте сделаем это, вызвав JSON.parse :

    let str = ''; let meetup = JSON.parse(str); alert( meetup.date.getDate() ); // Ошибка!

    Значением meetup.date является строка, а не Date объект. Как JSON.parse мог знать, что он должен был преобразовать эту строку в Date ?

    Давайте передадим JSON.parse функцию восстановления вторым аргументом, которая возвращает все значения «как есть», но date станет Date :

    let str = ''; let meetup = JSON.parse(str, function(key, value) < if (key == 'date') return new Date(value); return value; >); alert( meetup.date.getDate() ); // 30 - теперь работает!

    Кстати, это работает и для вложенных объектов:

    let schedule = `< "meetups": [ , ] >`; schedule = JSON.parse(schedule, function(key, value) < if (key == 'date') return new Date(value); return value; >); alert( schedule.meetups[1].date.getDate() ); // 18 - отлично!

    Итого

    • JSON – это формат данных, который имеет собственный независимый стандарт и библиотеки для большинства языков программирования.
    • JSON поддерживает простые объекты, массивы, строки, числа, логические значения и null .
    • JavaScript предоставляет методы JSON.stringify для сериализации в JSON и JSON.parse для чтения из JSON.
    • Оба метода поддерживают функции преобразования для интеллектуального чтения/записи.
    • Если объект имеет метод toJSON , то он вызывается через JSON.stringify .

    Задачи

    Преобразуйте объект в JSON, а затем обратно в обычный объект

    важность: 5

    Преобразуйте user в JSON, затем прочитайте этот JSON в другую переменную.

    let user = < name: "Василий Иванович", age: 35 >;

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *