{"componentChunkName":"component---src-templates-blog-post-js","path":"/spring-validacao/","result":{"data":{"markdownRemark":{"html":"

Erros ocorrem e sempre irão ocorrer, seja por mal requisito de negócio, seja por mal desenvolvimento ou qualquer outra razão. O fato é que erros acontecem e precisamos saber lidar com eles.

\n

Mas como vamos apresentar o erro para o usuário ou cliente que chamam as nossas APIs?

\n

O Spring já fornece todo um mecanismo para tratativa de erros que é muito válido e auxilia, e muito, o desenvolvimento mas aqui eu irei apresentar uma outra forma de realizar essa tratativa através de uma lib que descobri recentemente que facilita ainda mais o trabalho e padronização de erros e mensagens na resposta.

\n

Projeto

\n

Seguindo com os conteúdos dos artigos anteriores vamos reaproveitar o projeto que já foi usado pra Criar um endpoint com Spring Security e token JWT e vamos adicionar nele a validação.

\n

Este projeto também está sendo usado nos artigos sobre o Kafka aqui do blog e nessa aplicação temos como premissa que seja enviado os dados de um contribuinte como nome, documento e email.

\n

No nosso projeto hoje não há validação alguma se os dados enviados estão corretos, para esse exemplo queremos que o número do documento (CPF), seja um número válido e caso não seja deve retornar uma mensagem indicando isso.

\n

Para isso iremos usar uma lib muito interessante que ajuda muito no desenvolvimento com Spring Boot, a Errors Spring Boot Starter é um projeto que visa facilitar ainda mais a manipulação de erros e validação de dados de entrada.

\n

Adicionado ao Maven

\n

O projeto register é um projeto Java que utiliza o Maven então basta adicionar a dependência no pom.xml:

\n
<dependency>\n    <groupId>me.alidg</groupId>\n    <artifactId>errors-spring-boot-starter</artifactId>\n    <version>1.4.0</version>\n</dependency>
\n

E para auxiliar nas validações também incluir a dependência do spring-boot-starter-validation:

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

Criando annotation para validação

\n

O nosso objeto de entrada no POST contém um campo documento que será onde usuário irá enviar o CPF:

\n
{\n    \"name\": \"User\",\n    \"document\": \"XXX.XXX.XXX-XX\",\n    \"email\": \"email@fake.com\"\n}
\n

E a ideia seria que no momento do POST fosse realizada a validação e caso não seja um CPF válido retorna um erro informando isso.

\n

Para isso será criado uma Annotation @Cpf que nos auxiliará:

\n
@Documented\n@Constraint(validatedBy = CpfValidator.class)\n@Target( { ElementType.METHOD, ElementType.FIELD })\n@Retention(RetentionPolicy.RUNTIME)\npublic @interface Cpf {\n\t\n    String message() default \"Documento Inválido\";\n    Class<?>[] groups() default {};\n    Class<? extends Payload>[] payload() default {};\n\n}
\n

Na annotation @Cpf é definida a mensagem que será devolvida para o usuário e também adicionamos @Constraint(validatedBy = CpfValidator.class) que é classe que contém a lógica para executar a validação.

\n

É necessário criar a classe CpfValidator que contém a regra de validação:

\n
public class CpfValidator implements ConstraintValidator<Cpf, String>{\n\t\n\tprivate final int[] PESO_CPF = { 11, 10, 9, 8, 7, 6, 5, 4, 3, 2 };\n\n\t@Override\n\tpublic boolean isValid(String cpf, ConstraintValidatorContext context) {\n\t\t\n\t\tString cpfSomenteDigitos = cpf.replaceAll(\"\\\\D\", \"\");\n\t\t\n\t\tif ((cpfSomenteDigitos == null) || (cpfSomenteDigitos.length() != 11) || cpfSomenteDigitos.equals(\"00000000000\")\n\t\t\t\t|| cpfSomenteDigitos.equals(\"11111111111\") || cpfSomenteDigitos.equals(\"22222222222\")\n\t\t\t\t|| cpfSomenteDigitos.equals(\"33333333333\") || cpfSomenteDigitos.equals(\"44444444444\")\n\t\t\t\t|| cpfSomenteDigitos.equals(\"55555555555\") || cpfSomenteDigitos.equals(\"66666666666\")\n\t\t\t\t|| cpfSomenteDigitos.equals(\"77777777777\") || cpfSomenteDigitos.equals(\"88888888888\")\n\t\t\t\t|| cpfSomenteDigitos.equals(\"99999999999\")) {\n\t\t\treturn false;\n\t\t}\n\t\t\n\t\tInteger digito1 = calcularDigito(cpfSomenteDigitos.substring(0, 9), PESO_CPF);\n\t\tInteger digito2 = calcularDigito(cpfSomenteDigitos.substring(0, 9) + digito1, PESO_CPF);\n\n\t\treturn cpfSomenteDigitos.equals(cpfSomenteDigitos.substring(0, 9) + digito1.toString() + digito2.toString());\n\t}\n\t\n\tprivate int calcularDigito(String str, int[] peso) {\n\t\tint soma = 0;\n\t\tfor (int indice = str.length() - 1, digito; indice >= 0; indice--) {\n\t\t\tdigito = Integer.parseInt(str.substring(indice, indice + 1));\n\t\t\tsoma += digito * peso[peso.length - str.length() + indice];\n\t\t}\n\t\tsoma = 11 - soma % 11;\n\t\treturn soma > 9 ? 0 : soma;\n\t}\n\n}
\n

A primeira coisa a se notar nessa classe é que ela implementa a interface do javax.validation ConstraintValidator<A extends Annotation, T> que recebe uma Annotation como parâmetro.

\n

E aqui executamos o algoritmo para validarmos se um CPF é válido ou não.

\n

Para que a validação tenha efeito é necessário adicionar no Controller que recebe o nosso objeto a anotação @Valid para que surja efeito.

\n
public ResponseEntity<TaxpayerDTO> postTaxpayer(@Valid @RequestBody TaxpayerDTO taxpayer)
\n

Com isso nós podemos adicionar essa Annotation ao atributo document no DTO TaxpayerDTO.

\n
@Cpf\nprivate String document;
\n

Se tentarmos agora fazer um POST com um número que não seja um CPF válido será lançado o erro com status 400.

\n
{\n    \"errors\": [\n        {\n            \"code\": \"Documento invalido\",\n            \"message\": null\n        }\n    ]\n}
\n

Já retorna uma mensagem de erro mais padronizada porém um tanto quanto estranha já que a message está com valor null e no campo code está com a mensagem que definimos na Annotation CPF.

\n

Isso ocorre pois a nossa dependência de validação usa o mecanismo do Spring MessageSource para buscar as mensagens que serão exibidas, então precisamos criar o nosso arquivo messages.properties na pasta Resources do projeto e lá adicionamos as mensagens.

\n
invalid.document=Documento invalido
\n

E alteramos também na annotation com chave da mensagem.

\n
String message() default \"invalid.document\";
\n

Fazendo isso a tentando novamente com um CPF que é inválido o retorno será esse:

\n
{\n    \"errors\": [\n        {\n            \"code\": \"invalid.document\",\n            \"message\": \"Documento invalido\"\n        }\n    ]\n}
\n

Criando um Exception customizada

\n

Outra feature interessante dessa biblioteca é a capacidade de poder fazer a tratativa dos erros nas Exceptions que criamos na aplicação.

\n

Vamos criar uma Exception para simular um cenário e poder ficar mais claro, imaginemos que há uma regra na nossa aplicação onde não seja aceito pessoas com o nome Guilherme e vamos verificar isso na nossa classe que executa as regras de negócio:

\n
\t@Override\n\tpublic void send(CommonDTO taxpayerDTO) {\n\t\t\n\n\t\tTaxPayer taxPayer = TaxPayer.newBuilder().setName(((TaxpayerDTO) taxpayerDTO).getName())\n\t\t\t\t.setDocument(((TaxpayerDTO) taxpayerDTO).getDocument()).setSituation(false).setEmail(((TaxpayerDTO) taxpayerDTO).getEmail()).build();\n\t\t\n\t\t\n        // Aqui está o lançamento da Exception\n\t\tif(taxPayer.getName().contains(\"Guilherme\")) {\n\t\t\tthrow new BadTaxpayerUser(taxPayer.getName());\n\t\t}\n\t\t\n\t\t\n\t\tproducer.send(this.createProducerRecord(taxPayer), (rm, ex) -> {\n\t\t\tif (ex == null) {\n\t\t\t\tlog.info(\"Data sent with success!!!\");\n\t\t\t} else {\n\t\t\t\tlog.error(\"Fail to send message\", ex);\n\t\t\t}\n\t\t});\n\n\t\tproducer.flush();\n\n\t}
\n

No trecho de código acima temos uma Exception que recebe o nome do taxpayer, e será nessa classe de Exception que será feita a manipulação do erro para o retorno da API:

\n
@Getter\n@ExceptionMapping(statusCode = HttpStatus.I_AM_A_TEAPOT, errorCode = \"bad.user.message\")\npublic class BadTaxpayerUser extends RuntimeException {\n\t\n    @ExposeAsArg(value = 0, name = \"user\")\n    private final String key;\n\n    public BadTaxpayerUser(String key) {\n        super(key);\n        this.key = key;\n    }\n\n}
\n

Na BadTaxpayerUser bastou adicionarmos uma anotação @ExceptionMapping e nela passamos no campo statusCode o código HTTP que deve ser retornado e no campo errorCode é passado a chave da mensagem, que está em resources, que deve ser exibida.

\n

Antes de vermos a anotação @ExposeAsArg iremos adicionar ao arquivo message.properties a mensagem que deve ser exibida e vamos customizá-la dessa forma:

\n
bad.user.message=O user {user} nao pode!!!
\n

Com isso quando adicionarmos a anotação @ExposeAsArg no atributo key da Exception temos que informar que o primeiro argumento que está entre chaves, {user}, deve ser interpolado pelo valor a ser recebido na exceção.

\n

Agora fazendo o teste e enviando um POST com essas informações, que foram geradas pelo Gerador de pessoas da 4Devs:

\n
{\n    \"name\": \"Guilherme Paulo Carlos Eduardo Dias\",\n    \"document\": \"893.475.166-51\",\n    \"email\": \"guilhermepaulocarloseduardodias-89@3dmaker.com.br\"\n}
\n

Teremos como retorno o erro com status 418 I’m a teapot com o corpo da mensagem:

\n
{\n    \"errors\": [\n        {\n            \"code\": \"bad.user.message\",\n            \"message\": \"O user Guilherme Paulo Carlos Eduardo Dias nao pode!!!\"\n        }\n    ]\n}
\n

Conclusão

\n

Bom espero nesse artigo ter apresentando um pouco mais sobre a biblioteca Errors Spring Boot Starter e suas facilidades. Lembrando que essa é apenas uma outra maneira para lidar com validações.

\n

O código desse projeto pode ser encontrado no GitHub

","fields":{"slug":"/spring-validacao/"},"frontmatter":{"date":"26 de janeiro de 2021","description":"Aprendendo como criar validações customizadas de forma produtiva para sua API","title":"Validando requisições com Spring Boot","tags":["Spring Boot","Validation","Java"],"author":"Guilherme Alves","image":{"id":"f35c4a96-7443-5f7d-83cf-92062165e30c","publicURL":"/static/c54e92f76d845f2963fe6b021614370c/spring-erro.png","childImageSharp":{"fluid":{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAALCAYAAAB/Ca1DAAAACXBIWXMAAA7EAAAOxAGVKw4bAAABx0lEQVQoz41T3StDYRw++QsUya2Sj6SUG00+L6QoRShXyw0jXPiWSJILtRKJ4saF8r1lbT63WBOy2tY2ojSaKB/baLOvcx7be3aObYfy1tPvnPf5/Z7z/N73dyiEFsMwBOwzjSAd4PGzH4nBAGi/n0VAyFMxySGx3xbP00I+ei+cR3HJdETsxf2I3ZtlAs3dOrwBD8vTQRKf9nZgGR8gsMvXYkSJYHzL06ed6FKUY/K4GS2yAsit87yDj9sryFIScCjKgqYsD1uJFN4vzyJHwX6QOKQZ9kVrk2FM3YRtyxwU10tYNUkxfFCHe8c14XUNFdDVV8DQ0wp9hxjn4lqcVBUKW+YEFy4GIdW1Y/FyBN2qSmyaZ9G/Ww21bQPwAjvpiTD0SqCtKYG2ugjGvjYoM5PhsT/wrVPR52dzXBGhFeMUcTd/MYDRo0Z8eT8Jb50cxpEoG+axPlgnhqApzYNpsINvmXcY7XLTPAOJvJC0LpGLoH9UswUhBD1uqItzocxIgionFfv5afC9vcRcDCWYs5Db58972F23ePM88xxX4Hc54bKY4LQY4Xt//fuWo2P8DP5nDrk8SvinMORMw2AIhB2ERTjE138DY6wUY1LzT6MAAAAASUVORK5CYII=","aspectRatio":1.7777777777777777,"src":"/static/c54e92f76d845f2963fe6b021614370c/0823f/spring-erro.png","srcSet":"/static/c54e92f76d845f2963fe6b021614370c/c67b7/spring-erro.png 320w,\n/static/c54e92f76d845f2963fe6b021614370c/d3930/spring-erro.png 640w,\n/static/c54e92f76d845f2963fe6b021614370c/0823f/spring-erro.png 1280w,\n/static/c54e92f76d845f2963fe6b021614370c/c730b/spring-erro.png 1920w,\n/static/c54e92f76d845f2963fe6b021614370c/55bfe/spring-erro.png 2240w","sizes":"(max-width: 1280px) 100vw, 1280px"}}}},"timeToRead":7}},"pageContext":{"slug":"/spring-validacao/","previous":{"fields":{"slug":"/kafka-consumer/"},"frontmatter":{"title":"Consumindo mensagens do Kafka sem dor de cabeça","date":"18 jan, 2021"}},"next":{"fields":{"slug":"/kafka-streams/"},"frontmatter":{"title":"Kafka Streams com Java","date":"02 fev, 2021"}}}},"staticQueryHashes":["63159454"]}