Pular para o conteúdo principal

JSON fácil em Java com GSon !

Ola pessoal !

O formato JSON (JavaScript Object Notation) vem se consagrando cada vez mais na comunicação de dados, principalmente nos dispositivos móveis devido a esse formato ser mais leve que o XML e também mais legível.
Uma prova disso são as inúmeras bibliotecas que existem para manipular esse formato, e no caso do Android, o suporte ao JSON é nativo. Mas apesar de ter esse suporte nativo, algumas operações devem ser feitas manualmente e o código acaba ficando um pouco verboso e repetitivo, já que para cada objeto que se deseja transmitir é necessário fazer um método que lê as propriedades do JSON e faz as devidas atribuições no seu objeto Java.

Vamos supor o seguinte objeto sendo transmitido em JSON:

{
  user: {
    id: 123456,
    name: "Neto Marin",
    username: "netomarin",
    email: "netomarin@globalcode.com.br"
  }
}

Se você fosse tratar um Webservice que envia esse JSON para o seu aplicativo Android, além de criar a o Java Bean desse objeto, a classe User por exemplo, você também precisaria programar  um método em algum controller  (ou em uma classe qualquer) para carregar o bean com os dados que vieram pelo JSON, por exemplo:

public User loadUserFromJSON(String jsonString) {
    User user = new User();
    try {
        JSONObject userObject = new JSONObject(jsonString);
        user.setId(userObject.getInt("id"));
        user.setName(userObject.getString("name"));
        user.setUsername(userObject.getString("username"));
        user.setEmail(userObject.getString("email"));
    } catch (JSONException e) {
        e.printStackTrace();
    }
    
    return user;
}

E assim teria que fazer para cada objeto que você quisesse receber via JSON. Sem falar nas atualizações que teria que fazer em caso de mudança do objeto ou problemas que poderia ter com erros ou trocas nos nomes das propriedades.
Além do parser para carregar uma instância de User a partir de um JSON, caso você precise enviar o mesmo JSON para o servidor, teria que ter um método para converter o seu bean em uma String no formato, e então, teria um método parecido com isso:

public String userToJSON(User user) {
    JSONObject object = new JSONObject();
    try {
        object.put("id", user.getId());
        object.put("name", user.getName());
        object.put("username", user.getUsername());
        object.put("email", user.getEmail());
    } catch (JSONException e) {
        e.printStackTrace();
    }
    
    return object.toString();
}

Apresentando, Gson !

Então, pra dar uma ajuda nessa tarefa toda, o pessoal do Google criou o projeto Gson, que tem como principais objetivos:
  • Prover uma interface simples para ler e exportar no formato JSON.
  • Permitir que objetos pré-existentes e que não possam ser alterados sejam convertidos para e partir de JSON.
  • Suporte ao generics do Java.
  • Representação customizada de objetos.
  • Suporte a tipos complexos de objetos.
Dessa forma, a promessa do Gson é que com apenas poucas linhas você consiga gerar objetos a partir de uma String JSON. A conversão do objeto user que foi demonstrado acima, se for utilizar Gson, ficaria assim:

public User loadUserFromJSONGson(String jsonString) {
    Gson gson = new Gson();
    User user = gson.fromJson(jsonString, User.class);
    return user;
}

Bem mais fácil não? E na hora de enviar essa classe User para o servidor, seria tão simples assim? Vejamos:

//criação do objeto para demonstrar...
User user = new User();
user.setId(123);
user.setName("João da Silva");
user.setEmail("joaodasilva@mail.com");
user.setUsername("joaosilva");
    
//código que faz o trabalho ;-)
Gson gson = new Gson();
String userJSONString = gson.toJson(user);

//Para ver o resultado no Logcat    
Log.d("Gson", "user JSON String: "+userJSONString);

Mas é só isso ?!?!

Claro que não ! O próprio formato JSON tem uma série de particularidades e também limites. E a biblioteca Gson está em desenvolvimento, e é claro, também tem as suas limitações. Por isso, visite o site do projeto e também o Gson User Guide que conta com diversos exemplos mais avançados, envolvendo objetos complexos, arrays e generics!

Esse exemplo que apresentei serve para mostrar a simplicidade da idéia, e que será o suficiente caso você apenas receba e envie objetos simples. Boa sorte! ;-)

Da pra usar com projetos Android?

Sim, basta fazer o download do zip da biblioteca, descompactar e copiar o JAR para a pasta libs do seu projeto Android (caso não tenha a pasta, basta criar...). Depois, no Eclipse, clique com o botão direito em cima do JAR e selecione a opção Build Path --> Add to Build Pah e pronto, você já pode usar normalmente no seu projeto!

Abraços
Neto Marin

Comentários

Daniel disse…
Componente sagaz o Gson. Utilizamos em projetos, muito eficiente.
Rafael Spessotto disse…
Ola!

eu sei que esse post e antigo, mas comecei a seguir os seu tutorial de android, so que cada vez que eu dou "run as android application" ele roda o emulador mas a aplicacao nao aparece no emulador...ela esta instalada mas ela nao roda automaticamente... tem alguma ideia?

abracos
Unknown disse…
Uia!

Simples e objetivo! Parabéns pelo post.
Unknown disse…
Muito bom, parabéns.
Unknown disse…
Alguém poderia indicar uma fonte onde encontro a utilização do GSon para utilização com RESTFul?

Postagens mais visitadas deste blog

Saiba como programar para Arduino sem ter nenhum hardware disponível

O Arduino já é uma tecnologia muito difundida entre os amantes de tecnologia. É difícil encontrar um profissional da computação que não brincou um pouco com esta ferramenta de prototipagem ou, que gostaria de fazer isso. Porém, em alguns casos, o programador quer conhecer o arduino mas não dispõe de nenhum hardware, nem mesmo da placa. Como isso poderia ser resolvido? A primeira resposta seria aquela mais simples e direta: ir as compras. Isso pode ser feito em uma loja física ou pela internet. No meu caso, por exemplo, tive a felicidade de encontrar em um site (não me lembro qual) um kit arduino, com um conjunto de sensores e um DVD com 41 vídeo aulas. Mas digamos que o profissional não esteja passando por um bom momento financeiro, ou ainda, simplesmente não queira comprar o Arduino sem antes conhecê-lo um pouco melhor. Para a última situação também já existe uma resposta, e diga-se de passagem, uma excelente resposta. Trata-se do site 123D Circuits.io . Depois de criar seu u

Entendendo como funciona a programação de computadores: linguagens de programação, lógica, banco de dados

Nesse post, diferente dos últimos que foram mais enfáticos nas experiências com tecnologias, vou focar um pouco mais nos profissionais que estão começando, ou pretendem ingressar na área de desenvolvimento de software, falando sobre conceitos fundamentais relacionados a programação em geral . Mercado de trabalho para programação Conforme já sabemos, o mercado de desenvolvimento de software, especialmente no Brasil, continua em franca expansão, sendo que cada vez mais as empresas buscam desenvolver seus próprios sistemas usando as mais diferentes e novas tecnologias. Algumas matérias interessantes: As seis profissões mais valorizadas em 2010 no IDG Now! Muitas vagas e sensação de reaquecimento da economia Por isso, a área de desenvolvimento de software tem despertado interesse em muitos profissionais de outras áreas que desejam mudar de profissão, já que as oportunidades de trabalho tendem a ser maiores. Esse é um perfil presente em muitos dos clientes da Globalcode que acabou m