Decodificando em classes de caso

Um Decoder[A] sabe ler um valor Json e convertê-lo para um tipo Scala A.

O Circe fornece decodificadores para tipos primitivos e coleções desde o início, além de poder criar automaticamente decodificadores para suas próprias classes de caso.

Suponha que sua API retorne registros de usuários. Modele essa estrutura com uma classe de caso cujos nomes de campos correspondam às chaves JSON.

Essa correspondência permite que o Circe derive um decodificador sem nenhuma ligação manual.

Importe io.circe.generic.auto._ para que o Circe derive implicitamente um Decoder[User], sob demanda, sempre que um for necessário.

Depois, basta chamar decode[User], sem código adicional desnecessário.

Para obter tempos de compilação melhores e controle explícito, use io.circe.generic.semiauto.deriveDecoder.

Você define o decodificador uma vez, geralmente no objeto acompanhante, e reutiliza essa única instância em todos os lugares.

Se um campo obrigatório estiver ausente ou tiver o tipo incorreto, a decodificação falhará com um DecodingFailure.

A falha contém um histórico das operações do cursor, indicando exatamente qual campo causou o problema.

Defina um campo como Option[A] quando a chave JSON puder estar ausente ou nula.

O Circe decodifica automaticamente uma chave ausente como None, portanto você não precisa de um decodificador personalizado apenas para lidar com a opcionalidade.

Os valores padrão de uma classe de caso podem preencher chaves JSON ausentes, mas somente quando você usa uma derivação configurada que habilite valores padrão.

O módulo circe-generic-extras fornece esse recurso por meio de Configuration.default.withDefaults.

A decodificação é composicional: se o Circe consegue decodificar o tipo de cada campo, ele consegue decodificar uma classe que aninha outras classes de caso.

A derivação é aplicada recursivamente de forma automática, portanto uma única importação trata estruturas profundamente aninhadas.

Quando as chaves JSON diferem dos nomes Scala (por exemplo, snake_case), use a derivação configurada com Configuration.default.withSnakeCaseMemberNames.

Isso mapeia created_at para um campo Scala createdAt sem um decodificador escrito manualmente.

Por padrão, a decodificação falha rapidamente no primeiro erro. Já decodeAccumulating reúne todas as falhas em um ValidatedNel.

Isso é útil para validar formulários quando você quer informar todos os problemas de uma só vez.

Use auto para protótipos rápidos e semiauto para código de produção em que você queira instâncias fixas e compilações mais rápidas.

Use generic-extras quando precisar de renomeação, valores padrão ou discriminadores.

Teste sua compreensão da decodificação para classes de caso.

Um Decoder[A] transforma JSON em valores tipados. Use generic.auto ou semiauto.deriveDecoder para classes de caso cujos nomes correspondam às chaves.

Chaves ausentes fazem com que campos Option sejam decodificados como None; generic-extras adiciona valores padrão e renomeação; decodeAccumulating reúne todos os erros.