Парсер JSON в Java от Jackson очень популярен и используется также в Spring Framework. API обработки JSON в Java не очень удобен для пользователя и не предоставляет функций для автоматического преобразования из JSON в объект Java и наоборот. К счастью, у нас есть несколько альтернативных API, которые мы можем использовать для обработки JSON. В последней статье мы узнали о API Google Gson и увидели, насколько легко его использовать.
Парсер JSON в Java от Jackson
Чтобы использовать API парсера JSON в Java от Jackson в нашем проекте, мы можем добавить его в путь сборки проекта, или, если вы используете Maven, мы можем добавить зависимость ниже.
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.2.3</version>
</dependency>
jackson-databind jar зависит от библиотек jackson-core и jackson-annotations, поэтому, если вы добавляете их напрямую в путь сборки, убедитесь, что добавили все три, иначе вы получите ошибку времени выполнения. API парсера JSON Jackson предоставляет простой способ преобразования JSON в объект POJO и поддерживает простое преобразование в Map из данных JSON. Jackson также поддерживает обобщения и непосредственно преобразует их из JSON в объекты.
Пример JSON с Jackson
Для нашего примера преобразования JSON в объект POJO/Java мы возьмем сложный пример с вложенным объектом и массивами. Мы будем использовать массивы, список и Map в объектах Java для преобразования. Наш сложный JSON хранится в файле employee.txt со следующей структурой:
{
"id": 123,
"name": "Pankaj",
"permanent": true,
"address": {
"street": "Albany Dr",
"city": "San Jose",
"zipcode": 95129
},
"phoneNumbers": [
123456,
987654
],
"role": "Manager",
"cities": [
"Los Angeles",
"New York"
],
"properties": {
"age": "29 years",
"salary": "1000 USD"
}
}
У нас есть следующие классы Java, соответствующие данным JSON.
package com.journaldev.jackson.model;
public class Address {
private String street;
private String city;
private int zipcode;
public String getStreet() {
return street;
}
public void setStreet(String street) {
this.street = street;
}
public String getCity() {
return city;
}
public void setCity(String city) {
this.city = city;
}
public int getZipcode() {
return zipcode;
}
public void setZipcode(int zipcode) {
this.zipcode = zipcode;
}
@Override
public String toString(){
return getStreet() + ", "+getCity()+", "+getZipcode();
}
}
Класс Address соответствует внутреннему объекту в корневых данных JSON.
package com.journaldev.jackson.model;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
public class Employee {
private int id;
private String name;
private boolean permanent;
private Address address;
private long[] phoneNumbers;
private String role;
private List<String> cities;
private Map<String, String> properties;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public boolean isPermanent() {
return permanent;
}
public void setPermanent(boolean permanent) {
this.permanent = permanent;
}
public Address getAddress() {
return address;
}
public void setAddress(Address address) {
this.address = address;
}
public long[] getPhoneNumbers() {
return phoneNumbers;
}
public void setPhoneNumbers(long[] phoneNumbers) {
this.phoneNumbers = phoneNumbers;
}
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
@Override
public String toString(){
StringBuilder sb = new StringBuilder();
sb.append("***** Employee Details *****\n");
sb.append("ID="+getId()+"\n");
sb.append("Name="+getName()+"\n");
sb.append("Permanent="+isPermanent()+"\n");
sb.append("Role="+getRole()+"\n");
sb.append("Phone Numbers="+Arrays.toString(getPhoneNumbers())+"\n");
sb.append("Address="+getAddress()+"\n");
sb.append("Cities="+Arrays.toString(getCities().toArray())+"\n");
sb.append("Properties="+getProperties()+"\n");
sb.append("*****************************");
return sb.toString();
}
public List<String> getCities() {
return cities;
}
public void setCities(List<String> cities) {
this.cities = cities;
}
public Map<String, String> getProperties() {
return properties;
}
public void setProperties(Map<String, String> properties) {
this.properties = properties;
}
}
Employee – это бин Java, представляющий корневой объект JSON. Теперь давайте посмотрим, как мы можем преобразовать JSON в объект Java, используя API парсера JSON Jackson.
package com.journaldev.jackson.json;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.journaldev.jackson.model.Address;
import com.journaldev.jackson.model.Employee;
public class JacksonObjectMapperExample {
public static void main(String[] args) throws IOException {
// считываем данные JSON из файла в строку
byte[] jsonData = Files.readAllBytes(Paths.get("employee.txt"));
// создаем экземпляр ObjectMapper
ObjectMapper objectMapper = new ObjectMapper();
// преобразуем строку JSON в объект
Employee emp = objectMapper.readValue(jsonData, Employee.class);
System.out.println("Employee Object\n"+emp);
// преобразуем объект в строку JSON
Employee emp1 = createEmployee();
// настраиваем Object mapper для красивой печати
objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true);
// выводим в консоль, можно записать в любой выходной поток, такой как файл
StringWriter stringEmp = new StringWriter();
objectMapper.writeValue(stringEmp, emp1);
System.out.println("Employee JSON is\n"+stringEmp);
}
public static Employee createEmployee() {
Employee emp = new Employee();
emp.setId(100);
emp.setName("David");
emp.setPermanent(false);
emp.setPhoneNumbers(new long[] { 123456, 987654 });
emp.setRole("Manager");
Address add = new Address();
add.setCity("Bangalore");
add.setStreet("BTM 1st Stage");
add.setZipcode(560100);
emp.setAddress(add);
List cities = new ArrayList();
cities.add("Los Angeles");
cities.add("New York");
emp.setCities(cities);
Map props = new HashMap();
props.put("salary", "1000 Rs");
props.put("age", "28 years");
emp.setProperties(props);
return emp;
}
}
При запуске вышеприведенной программы вы получите следующий вывод.
Employee Object
***** Employee Details *****
ID=123
Name=Pankaj
Permanent=true
Role=Manager
Phone Numbers=[123456, 987654]
Address=Albany Dr, San Jose, 95129
Cities=[Los Angeles, New York]
Properties={age=29 years, salary=1000 USD}
*****************************
Employee JSON is
//печать данных файла JSON такая же, как и выше
com.fasterxml.jackson.databind.ObjectMapper – самый важный класс в API Jackson, который предоставляет методы readValue() и writeValue() для преобразования JSON в объект Java и объект Java в JSON. Класс ObjectMapper может быть повторно использован, и мы можем инициализировать его один раз в виде объекта Singleton. Существует так много перегруженных версий методов readValue() и writeValue(), чтобы работать с массивом байтов, файлом, потоком ввода/вывода и объектами Reader/Writer.
Jackson JSON – Преобразование JSON в Map
Иногда у нас есть объект JSON, подобный ниже, в файле data.txt:
{
"name": "David",
"role": "Manager",
"city": "Los Angeles"
}
и мы хотим преобразовать его в Map, а не в объект Java с теми же свойствами и ключами. Мы можем сделать это очень легко в API Jackson JSON с помощью двух методов с следующим кодом:
//преобразование JSON в Map
byte[] mapData = Files.readAllBytes(Paths.get("data.txt"));
Map myMap = new HashMap();
ObjectMapper objectMapper = new ObjectMapper();
myMap = objectMapper.readValue(mapData, HashMap.class);
System.out.println("Map is: "+myMap);
//другой способ
myMap = objectMapper.readValue(mapData, new TypeReference>() {});
System.out.println("Map using TypeReference: "+myMap);
После выполнения вышеуказанного сниппета мы получаем следующий вывод:
Map is: {name=David, role=Manager, city=Los Angeles}
Map using TypeReference: {name=David, role=Manager, city=Los Angeles}
Jackson JSON – Чтение определенного ключа JSON
Иногда у нас есть данные в формате JSON, и нас интересуют только некоторые значения ключей, поэтому в этом случае преобразование всего JSON в объект не является хорошей идеей. API Jackson JSON предоставляет опцию для чтения данных JSON в виде дерева, подобного DOM-парсеру, и мы можем читать определенные элементы объекта JSON через него. Ниже приведен фрагмент кода для чтения конкретных записей из файла JSON.
//read json file data to String
byte[] jsonData = Files.readAllBytes(Paths.get("employee.txt"));
//create ObjectMapper instance
ObjectMapper objectMapper = new ObjectMapper();
//read JSON like DOM Parser
JsonNode rootNode = objectMapper.readTree(jsonData);
JsonNode idNode = rootNode.path("id");
System.out.println("id = "+idNode.asInt());
JsonNode phoneNosNode = rootNode.path("phoneNumbers");
Iterator elements = phoneNosNode.elements();
while(elements.hasNext()){
JsonNode phone = elements.next();
System.out.println("Phone No = "+phone.asLong());
}
Мы получим следующий вывод при выполнении указанного выше фрагмента кода.
id = 123
Phone No = 123456
Phone No = 987654
Jackson JSON – Редактирование JSON-документа
API Jackson JSON Java предоставляет полезные методы для добавления, редактирования и удаления ключей из данных JSON, а затем мы можем сохранить их как новый файл JSON или записать в любой поток. Ниже показан код, как это сделать легко.
byte[] jsonData = Files.readAllBytes(Paths.get("employee.txt"));
ObjectMapper objectMapper = new ObjectMapper();
//create JsonNode
JsonNode rootNode = objectMapper.readTree(jsonData);
//update JSON data
((ObjectNode) rootNode).put("id", 500);
//add new key value
((ObjectNode) rootNode).put("test", "test value");
//remove existing key
((ObjectNode) rootNode).remove("role");
((ObjectNode) rootNode).remove("properties");
objectMapper.writeValue(new File("updated_emp.txt"), rootNode);
Если вы выполните указанный выше код и посмотрите на новый файл, вы заметите, что в нем нет ключей “role” и “properties”. Вы также заметите, что значение “id” обновлено до 500, а в файле updated_emp.txt добавлен новый ключ “test”.
Пример использования Jackson JSON Streaming API
Jackson JSON Java API также предоставляет поддержку потоковой передачи данных, что полезно при работе с большими JSON-данными, потому что он считывает весь файл как токены и использует меньше памяти. Единственная проблема с потоковым API заключается в том, что нам нужно заботиться о всех токенах при разборе JSON-данных. Если у нас есть JSON-данные в виде {“role”:“Manager”}, то мы получим следующие токены в порядке – { (начало объекта), “role” (имя ключа), “Manager” (значение ключа) и } (конец объекта). Двоеточие (:) – разделитель в JSON и, следовательно, не считается токеном.
package com.journaldev.jackson.json;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.journaldev.jackson.model.Address;
import com.journaldev.jackson.model.Employee;
public class JacksonStreamingReadExample {
public static void main(String[] args) throws JsonParseException, IOException {
//создать объект JsonParser
JsonParser jsonParser = new JsonFactory().createParser(new File("employee.txt"));
//перебирать токены
Employee emp = new Employee();
Address address = new Address();
emp.setAddress(address);
emp.setCities(new ArrayList());
emp.setProperties(new HashMap());
List phoneNums = new ArrayList();
boolean insidePropertiesObj=false;
parseJSON(jsonParser, emp, phoneNums, insidePropertiesObj);
long[] nums = new long[phoneNums.size()];
int index = 0;
for(Long l :phoneNums){
nums[index++] = l;
}
emp.setPhoneNumbers(nums);
jsonParser.close();
//печать объекта сотрудника
System.out.println("Employee Object\n\n"+emp);
}
private static void parseJSON(JsonParser jsonParser, Employee emp,
List phoneNums, boolean insidePropertiesObj) throws JsonParseException, IOException {
//перебор токенов Json
while(jsonParser.nextToken() != JsonToken.END_OBJECT){
String name = jsonParser.getCurrentName();
if("id".equals(name)){
jsonParser.nextToken();
emp.setId(jsonParser.getIntValue());
}else if("name".equals(name)){
jsonParser.nextToken();
emp.setName(jsonParser.getText());
}else if("permanent".equals(name)){
jsonParser.nextToken();
emp.setPermanent(jsonParser.getBooleanValue());
}else if("address".equals(name)){
jsonParser.nextToken();
//вложенный объект, рекурсивный вызов
parseJSON(jsonParser, emp, phoneNums, insidePropertiesObj);
}else if("street".equals(name)){
jsonParser.nextToken();
emp.getAddress().setStreet(jsonParser.getText());
}else if("city".equals(name)){
jsonParser.nextToken();
emp.getAddress().setCity(jsonParser.getText());
}else if("zipcode".equals(name)){
jsonParser.nextToken();
emp.getAddress().setZipcode(jsonParser.getIntValue());
}else if("phoneNumbers".equals(name)){
jsonParser.nextToken();
while (jsonParser.nextToken() != JsonToken.END_ARRAY) {
phoneNums.add(jsonParser.getLongValue());
}
}else if("role".equals(name)){
jsonParser.nextToken();
emp.setRole(jsonParser.getText());
}else if("cities".equals(name)){
jsonParser.nextToken();
while (jsonParser.nextToken() != JsonToken.END_ARRAY) {
emp.getCities().add(jsonParser.getText());
}
}else if("properties".equals(name)){
jsonParser.nextToken();
while(jsonParser.nextToken() != JsonToken.END_OBJECT){
String key = jsonParser.getCurrentName();
jsonParser.nextToken();
String value = jsonParser.getText();
emp.getProperties().put(key, value);
}
}
}
}
}
JsonParser – это потоковый API jackson json для чтения json-данных, мы используем его для чтения данных из файла, а затем метод parseJSON() используется для перебора токенов и их обработки для создания нашего java-объекта. Обратите внимание, что метод parseJSON() вызывается рекурсивно для “address”, потому что это вложенный объект в данных json. Для разбора массивов мы перебираем json-документ. Мы можем использовать класс JsonGenerator для создания json-данных с использованием API потоковой передачи.
package com.journaldev.jackson.json;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Set;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.journaldev.jackson.model.Employee;
public class JacksonStreamingWriteExample {
public static void main(String[] args) throws IOException {
Employee emp = JacksonObjectMapperExample.createEmployee();
JsonGenerator jsonGenerator = new JsonFactory()
.createGenerator(new FileOutputStream("stream_emp.txt"));
//для красивого вывода
jsonGenerator.setPrettyPrinter(new DefaultPrettyPrinter());
jsonGenerator.writeStartObject(); // start root object
jsonGenerator.writeNumberField("id", emp.getId());
jsonGenerator.writeStringField("name", emp.getName());
jsonGenerator.writeBooleanField("permanent", emp.isPermanent());
jsonGenerator.writeObjectFieldStart("address"); //start address object
jsonGenerator.writeStringField("street", emp.getAddress().getStreet());
jsonGenerator.writeStringField("city", emp.getAddress().getCity());
jsonGenerator.writeNumberField("zipcode", emp.getAddress().getZipcode());
jsonGenerator.writeEndObject(); //end address object
jsonGenerator.writeArrayFieldStart("phoneNumbers");
for(long num : emp.getPhoneNumbers())
jsonGenerator.writeNumber(num);
jsonGenerator.writeEndArray();
jsonGenerator.writeStringField("role", emp.getRole());
jsonGenerator.writeArrayFieldStart("cities"); //start cities array
for(String city : emp.getCities())
jsonGenerator.writeString(city);
jsonGenerator.writeEndArray(); //closing cities array
jsonGenerator.writeObjectFieldStart("properties");
Set keySet = emp.getProperties().keySet();
for(String key : keySet){
String value = emp.getProperties().get(key);
jsonGenerator.writeStringField(key, value);
}
jsonGenerator.writeEndObject(); //closing properties
jsonGenerator.writeEndObject(); //closing root object
jsonGenerator.flush();
jsonGenerator.close();
}
}
JsonGenerator прост в использовании по сравнению с JsonParser. Вот краткое справочное руководство по быстрому обращению с Jackson JSON Parser Java API. Jackson JSON Java API легок в использовании и предоставляет множество опций для удобства разработчиков, работающих с данными JSON. Загрузите проект по ссылке ниже и попробуйте поиграть с ним, чтобы изучить больше опций о Jackson Json API.
Ссылка: Страница Jackson на GitHub
Source:
https://www.digitalocean.com/community/tutorials/jackson-json-java-parser-api-example-tutorial