Jackson JSON Java Parser é muito popular e usado também no framework Spring. Java JSON Processing API não é muito amigável ao usuário e não fornece recursos para a transformação automática de JSON para objeto Java e vice-versa. Felizmente, temos algumas APIs alternativas que podemos usar para o processamento JSON. No último artigo, aprendemos sobre Google Gson API e vimos como é fácil usá-la.
Jackson JSON Java Parser
Para usar a API Jackson JSON Java em nosso projeto, podemos adicioná-la ao caminho de construção do projeto ou, se estivermos usando o Maven, podemos adicionar a dependência abaixo.
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.2.3</version>
</dependency>
O jar jackson-databind depende das bibliotecas jackson-core e jackson-annotations, então, se estiver adicionando-as diretamente ao caminho de construção, certifique-se de adicionar todas as três, caso contrário, ocorrerá um erro em tempo de execução. A API do Analisador JSON do Jackson fornece uma maneira fácil de converter JSON em Objeto POJO e oferece suporte à conversão fácil para Mapa a partir de dados JSON. O Jackson também oferece suporte a genéricos e os converte diretamente de JSON para objeto.
Exemplo JSON do Jackson
Para o nosso exemplo de conversão de JSON para POJO/objeto Java, vamos usar um exemplo complexo com objeto e arrays aninhados. Usaremos arrays, listas e Mapas em objetos Java para a conversão. Nosso JSON complexo está armazenado em um arquivo employee.txt com a estrutura abaixo:
{
"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"
}
}
Temos as seguintes classes Java correspondentes aos dados 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();
}
}
A classe Address corresponde ao objeto interno nos dados JSON raiz.
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 é o bean Java que representa o objeto JSON raiz. Agora, vamos ver como podemos transformar JSON em objeto Java usando a API do analisador JSON do 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 {
//ler dados do arquivo JSON como String
byte[] jsonData = Files.readAllBytes(Paths.get("employee.txt"));
//criar uma instância de ObjectMapper
ObjectMapper objectMapper = new ObjectMapper();
//converter a string JSON em objeto
Employee emp = objectMapper.readValue(jsonData, Employee.class);
System.out.println("Employee Object\n"+emp);
//converter Objeto para string JSON
Employee emp1 = createEmployee();
//configurar o mapeador de objetos para impressão bonita
objectMapper.configure(SerializationFeature.INDENT_OUTPUT, true);
//escrever no console, pode escrever em qualquer fluxo de saída, como arquivo
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;
}
}
Ao executar o programa acima, você obterá a seguinte saída.
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
//imprimindo os mesmos dados do arquivo json acima
com.fasterxml.jackson.databind.ObjectMapper é a classe mais importante na API Jackson que fornece os métodos readValue() e writeValue() para transformar JSON em Objeto Java e Objeto Java em JSON. A classe ObjectMapper pode ser reutilizada, e podemos inicializá-la uma vez como um objeto Singleton. Existem muitas versões sobrecarregadas dos métodos readValue() e writeValue() para trabalhar com arrays de bytes, arquivos, fluxo de entrada/saída e objetos Reader/Writer.
Jackson JSON – Convertendo JSON para Mapa
Às vezes, temos um objeto JSON como o abaixo, no arquivo data.txt:
{
"name": "David",
"role": "Manager",
"city": "Los Angeles"
}
e queremos convertê-lo em um Mapa e não em um objeto Java com as mesmas propriedades e chaves. Podemos fazer isso facilmente na API Jackson JSON com dois métodos usando o código abaixo:
//convertendo json para Mapa
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);
//outra maneira
myMap = objectMapper.readValue(mapData, new TypeReference>() {});
System.out.println("Map using TypeReference: "+myMap);
Depois de executar o trecho acima, obtemos a seguinte saída:
Map is: {name=David, role=Manager, city=Los Angeles}
Map using TypeReference: {name=David, role=Manager, city=Los Angeles}
Jackson JSON – Lendo Chave Específica do JSON
Às vezes temos dados em json e estamos interessados apenas em alguns dos valores das chaves, então, nesse caso, converter todo o JSON para objeto não é uma boa ideia. A API Jackson JSON fornece a opção de ler os dados json como uma árvore, semelhante ao DOM Parser, e podemos ler elementos específicos do objeto JSON através disso. O código abaixo fornece um trecho para ler entradas específicas de um arquivo json.
//ler dados do arquivo json como String
byte[] jsonData = Files.readAllBytes(Paths.get("employee.txt"));
//criar uma instância de ObjectMapper
ObjectMapper objectMapper = new ObjectMapper();
//ler JSON como 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());
}
Obtemos a seguinte saída quando executamos o trecho de código acima.
id = 123
Phone No = 123456
Phone No = 987654
Jackson JSON – Editar Documento JSON
A API Java Jackson JSON fornece métodos úteis para adicionar, editar e remover chaves dos dados JSON e então podemos salvá-los como um novo arquivo json ou escrevê-lo em qualquer fluxo. O código abaixo mostra como fazer isso facilmente.
byte[] jsonData = Files.readAllBytes(Paths.get("employee.txt"));
ObjectMapper objectMapper = new ObjectMapper();
//criar JsonNode
JsonNode rootNode = objectMapper.readTree(jsonData);
//atualizar dados JSON
((ObjectNode) rootNode).put("id", 500);
//adicionar nova chave valor
((ObjectNode) rootNode).put("test", "test value");
//remover chave existente
((ObjectNode) rootNode).remove("role");
((ObjectNode) rootNode).remove("properties");
objectMapper.writeValue(new File("updated_emp.txt"), rootNode);
Se você executar o código acima e procurar pelo novo arquivo, perceberá que ele não possui as chaves “role” e “properties”. Você também notará que o valor “id” foi atualizado para 500 e uma nova chave “test” foi adicionada ao arquivo updated_emp.txt.
Exemplo da API de Streaming Jackson JSON
A API Jackson JSON para Java também fornece suporte a streaming, o que é útil ao lidar com grandes dados JSON, pois lê o arquivo inteiro como tokens e consome menos memória. O único problema com a API de streaming é que precisamos cuidar de todos os tokens ao analisar os dados JSON. Se tivermos dados JSON como {“role”:“Gerente”}, então obteremos os seguintes tokens na ordem – { (início do objeto), “role” (nome da chave), “Gerente” (valor da chave) e } (fim do objeto). Dois-pontos (:) são o delimitador no JSON e, portanto, não são considerados como um token.
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 {
//criar objeto JsonParser
JsonParser jsonParser = new JsonFactory().createParser(new File("employee.txt"));
//iterar pelos tokens
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();
//imprimir objeto de funcionário
System.out.println("Employee Object\n\n"+emp);
}
private static void parseJSON(JsonParser jsonParser, Employee emp,
List phoneNums, boolean insidePropertiesObj) throws JsonParseException, IOException {
//iterar pelos JsonTokens
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();
//objeto aninhado, chamada recursiva
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 é a API de streaming JSON da Jackson para ler dados JSON, estamos usando-a para ler dados do arquivo e, em seguida, o método parseJSON() é usado para iterar pelos tokens e processá-los para criar nosso objeto Java. Observe que o método parseJSON() é chamado recursivamente para “address” porque é um objeto aninhado nos dados JSON. Para analisar arrays, estamos percorrendo o documento JSON. Podemos usar a classe JsonGenerator para gerar dados JSON com a API de streaming.
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"));
//para impressão formatada
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” é fácil de usar em comparação com “JsonParser”. Isso é tudo para um tutorial de referência rápida para a API Jackson JSON Parser em Java. A API Jackson JSON em Java é fácil de usar e oferece muitas opções para facilitar o trabalho dos desenvolvedores com dados JSON. Baixe o projeto no link abaixo e explore mais opções sobre a API Jackson Json.
Referência: Página do Jackson GitHub}
Source:
https://www.digitalocean.com/community/tutorials/jackson-json-java-parser-api-example-tutorial