Decodificar en case classes

Un Decoder[A] sabe leer un valor Json y convertirlo en un tipo de Scala A.

Circe proporciona decodificadores para tipos primitivos y colecciones de forma integrada, y puede crear automáticamente decodificadores para sus propias case classes.

Suponga que su API devuelve registros de usuarios. Modele su estructura con una case class cuyos nombres de campo coincidan con las claves JSON.

La coincidencia de nombres permite que Circe derive un decodificador sin configuración manual.

Importe io.circe.generic.auto._ y Circe derivará implícitamente un Decoder[User] cuando sea necesario.

A continuación, puede llamar a decode[User] sin código adicional.

Para obtener tiempos de compilación mejores y un control explícito, use io.circe.generic.semiauto.deriveDecoder.

Defina el decodificador una sola vez, normalmente en el objeto complementario, y reutilice esa única instancia en todas partes.

Si falta un campo obligatorio o tiene un tipo incorrecto, la decodificación falla con un DecodingFailure.

El error contiene un historial de operaciones del cursor que señala exactamente qué campo causó el problema.

Haga que un campo sea Option[A] cuando la clave JSON pueda faltar o ser nula.

Circe decodifica automáticamente una clave ausente como None, por lo que no necesita un decodificador personalizado solo para admitir opcionalidad.

Los valores predeterminados de una case class pueden completar las claves JSON ausentes, pero solo cuando utiliza una derivación configured que habilite los valores predeterminados.

El módulo circe-generic-extras proporciona esta funcionalidad mediante Configuration.default.withDefaults.

La decodificación es composicional: si Circe puede decodificar el tipo de cada campo, también puede decodificar una clase que anide otras case classes.

La derivación recurre automáticamente, por lo que una sola importación gestiona estructuras profundamente anidadas.

Cuando las claves JSON difieren de los nombres de Scala, por ejemplo, al usar snake_case, utilice la derivación configurada con Configuration.default.withSnakeCaseMemberNames.

Esto asigna created_at al campo de Scala createdAt sin escribir un decodificador manual.

De forma predeterminada, la decodificación falla rápidamente ante el primer error. decodeAccumulating, en cambio, recopila todos los errores en un ValidatedNel.

Esto resulta útil para validar formularios cuando desea informar de todos los problemas a la vez.

Use auto para prototipos rápidos y semiauto para código de producción cuando quiera instancias fijas y compilaciones más rápidas.

Recurra a generic-extras cuando necesite cambiar nombres, usar valores predeterminados o trabajar con discriminadores.

Compruebe lo que ha aprendido sobre la decodificación en case classes.

Un Decoder[A] convierte JSON en valores tipados. Use generic.auto o semiauto.deriveDecoder para case classes cuyos nombres coincidan con las claves.

Las claves ausentes decodifican los campos Option como None; generic-extras añade valores predeterminados y cambios de nombre; decodeAccumulating recopila todos los errores.