Codificar JSON en Java usando org.json

Hace algún tiempo vimos cómo decodificar o parsear el formato JSON en Java, pero no vimos cómo convertir un objeto de Java a una cadena de JSON.

Lo que vamos a hacer en este post es mostrar cómo codificar o convertir un objeto que definamos en Java a su representación JSON.

Esto va a funcionar para todos los tipos de datos y clases dentro de clases, siempre y cuando definamos los getters de las cosas que queremos que se expongan.

Resumen

Agrega la librería de org.json, luego define los getters en la clase que quieres codificar. En el código donde quieras convertir a JSON crea un nuevo objeto de tipo JSONObject y pásale la instancia de la clase a codificar en el constructor.

Luego llama al método toString del objeto que acabas de crear y ya está, tendrás la representación.

Si algo no te quedó claro, sigue leyendo.

Librería para trabajar con JSON

Recuerda ver el tutorial anterior para que instales la librería de org.json. También recomiendo que instales NetBeans para que puedas agregar la librería JAR fácilmente.

Las clases y los getters

No voy a explicar la ventaja o razón de usar getters en Java. Simplemente daré un pequeño repaso.

Una clase tiene propiedades o variables dentro de ella. Por ejemplo, la clase Mascota tiene la propiedad nombre de tipo String. Al declarar la variable la ponemos como privada:

private String nombre;

De esta manera no se puede acceder a ella usando:

String nombre = instanciaDeMascota.nombre;

Sino que debemos definir un método llamado getter en donde devolvemos el nombre:

public String getNombre{return nombre;}

Y al querer acceder a la propiedad usamos:

String nombre = instanciaDeMascota.getNombre();

Esto debemos hacer con todas las propiedades que queramos que sean codificadas con JSON.

Clases de ejemplo

Ahora que ya entendimos esa parte vamos a hacer un pequeño ejercicio. Lo que haremos será definir dos clases, una que va dentro de otra y al final codificar a esta última. Será una clase de tipo Mascota y otra de tipo Raza.

La raza tiene Nombre y País. Tal vez en la vida real no es así pero no importa, es un ejemplo. Esta clase es una propiedad de Mascota. Veamos el código de Raza:

Y el de Mascota, que a su vez usa a Raza:

Vemos que tiene un arreglo de tipo String junto con otras propiedades. Recuerda que todo esto es para demostrar cómo es que la codificación JSON llega a esa profundidad y lee todos los datos.

Crear instancia de clase

Para codificar a JSON primero debemos tener una instancia de una clase. Es decir, crear un objeto a partir de una clase. Así:

Estamos creando un objeto de la clase Mascota. Antes de crearla definimos la lista de amigos y la raza para que el código sea más legible.

Vuelvo a recordar que todas las propiedades que queremos que sean codificadas deben ser expuestas a través de los getters.

Codificar instancia de clase con JSON

Ahora sí a lo que venimos. Importamos lo que vamos a usar:

import org.json.JSONObject;

Es lo único que necesitamos. La magia radica en crear un objeto de tipo JSONObject pasando la instancia del objeto a codificar en el constructor y luego llamar a su método toString; eso automáticamente regresará el JSON como String.

No es magia, simplemente el método lee todos los getters y los pone en un JSON. Si no encuentra getters, no pondrá los datos. En fin, la salida es la siguiente:

JSON codificado con Java y JSONObject

JSON codificado con Java y JSONObject

La ventaja de esto es que si agregamos más propiedades simplemente hay que agregar los getters y todo seguirá funcionando de maravilla.

El código completo del método main queda así:

Conclusión

Con JSONObject es fácil codificar un objeto de cualquier tipo a su representación como JSON. Después esa cadena puede ser enviada a un servidor.

Te invito a ver más sobre Java aquí.