Tópico 16 - Validação de Dados

Validação de Dados

A validação de dados é o processo de verificação dos dados que atendem aos requisitos, comparando-os com um conjunto de regras que já foram configuradas ou definidas.

Importância da Validação

• Qualidade de dados (acurácia e confiabilidade)
• Prevenção de erros
• Consistência nos dados entre registros
• Compliance (razões legais)
• Velocidade de processamento
• Abstração de dados

Objetivos da Validação

Validar:

• campos obrigatórios;
• campos não permitidos;
• tipo de dados;
• range dos dados;
• formato dos dados;
• unicidade dos dados;

Contras da Validação

• Complexidade;
• Manutenção de código;
• Erros de validação;
• Mudança de necessidades;

Jakarta Validation API

• Especificação JSR 380
• Provê um conjunto de anotações para validação automática de beans
• Excessões disparadas automaticamente quando um conjunto não é validado

Uma validação pode ser realizada adicionando uma @Anotação sobre qualquer um dos atributos de um bean/classe.

Hibernate Validation

O Hibernate Validation é a implementação de referência do JSR 380 e implementa a validação de dados.

Podemos incluí-la no projeto usando o Spring Initializr ou adicionando essa dependência no arquivo maven:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

Exemplo de validação

public class Usuario {
    @NotNull(message = "O nome não pode ser nulo")
    private String name;

    @Size(min = 10, max = 200, message 
      = "Descrição precisa ser entre 10 e 20 caracteres")
    private String aboutMe;

    @Min(value = 18, message = "Idade precisa ser maior que 18 anos")
    @Max(value = 150, message = "Idade precisa ser menor que 150 anos")
    private int age;

    @Email(message = "Email precisa ser válido")
    private String email;
}

A maioria das anotações podem receber como parâmetro um atributo message, que corresponde à mensagem a ser retornada quando o atributo não é validado corretamente.

Outros atributos podem ser específicos para cada anotação, como o caso do value disponível para as anotações @Min e @Max.

Todas as anotações

Validando DTOs

Para validar DTOs, usamos a mesma estrutura utilizada em qualquer tipo de bean.

Podemos usar o controller que recebe um DTO para validar automaticamente os atributos do corpo da requisicao. Para isso, usamos a anotação @Valid.

@RestController
public class TransacaoController {
    @PostMapping("/noticia")
    public String postNoticia(@RequestBody @Valid NoticiaDto noticiaDto) {
      // Caso aconteça algum erro ne validação,
      // o controlador dispara uma exception
    }

Anotações frequentes

Validando com Expressões Regulares

Por fim, também temos a anotação @Pattern que permite definir uma expressão regular, geralmente utilizada para especificar um padrão de texto.

Aqui temos um exemplo do uso do @Pattern para especificar um CEP:

@Pattern(regexp="\\d{5}-\\d{3})
private String cep;

O termo regexp significa Regular Expression Pattern. Os termos \d{5} e \d{3} significam, respectivamente, "Cinco dígitos" e "Três digitos". Isso faz com que qualquer String que contenha não contenha esse padrão seja rejeitada.

Mais informações sobre expressões regulares no Aurélio.net.

Repassando exceções para o cliente

Para repassar personalizar as mensagens de erro para o cliente da API, podemos utilizar criar um método anotado com @ExceptionHandler no mesmo controller das rotas:

@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
public String erroValidacao() {
    return "Ocorreu um erro de validação";
}

Onde validar?

Contexto	Recomendação	Motivo
DTOs (Requisição)	Valide	Representa a entrada externa (clientes, usuários, APIs)
Entidades	Opcional	Entidades repreentam o estado interno e geralmente são construídos de dados confiáveis (DTOs previsamente validados ou Banco de Dados).
DTOs (Resposta)	Usualmente não	Você controla o que vai ser retornado nas respostas. Prefira validação por testes unitários.

Considerações Gerais

• A validação pertence às System Boundaries (limites externos ao sistema);
• Os DTOs são o ponto de entrada para validação;

O que aprendemos hoje

• Identificar a necessidade de validação de dados;
• Usar a especificação Jakarta Validation API para validar um bean;
• Usar expressões regulares para validar padrões em strings;
• Criar um controlador de exceções globais para as validações.