DEV Community: Jean Carlos Corrêa Couto

Configurando CORS Global para API Springboot

Jean Carlos Corrêa Couto — Thu, 26 Oct 2023 20:29:34 +0000

Quando temos a necessidade de consumir (ou enviar) dados de uma API para apresentar no frontend construímos diversos endpoints nela para nos auxiliar nesta tarefa e com isso sempre barramos no famigerado CORS (Cross-Origin Resource Sharing) e ele sempre apresenta o mesmo erro no console:

Então a primeira ação que temos é ir na nossa API, procurar a Controller e adicionar acima no endpoint a anotação do Springframework...

@CrossOrigin ou @CrossOrigin(origins = "*")

...nos livrar do problema e seguir o desenvolvimento da tarefa.
Então nossa API vai crescendo e todo o endpoint exposto para o front vai receber essa mesma anotação do @CrossOrigin.

Chega um momento que você se pergunta se ainda é realmente necessário ter essa anotação ali, ou a validação do Sonar está avisando que esse CORS é uma vulnerabilidade no seu código.

Há uma maneira, até simples, de fazer essa configuração de CORS porém num escopo Global, sem precisar adicionar em todos os endpoints. Para isso, basta criar a seguinte classe na sua estrutura:

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
@EnableWebMvc
class CORSConfiguration implements WebMvcConfigurer {

    @Value("${config.cors.allowed-origins}")
    String[] origins;

    @Value("${config.cors.allowed-headers}")
    String[] headers;

    @Value("${config.cors.allowed-methods}")
    String[] methods;

    @Value("${config.cors.max-age}")
    long maxAge;

    @Value("${config.cors.exposed-headers}")
    String[] exposed;

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowCredentials(true).maxAge(maxAge)
                .allowedOriginPatterns(origins).allowedHeaders(headers)
                .allowedMethods(methods).exposedHeaders(exposed);
    }
}

e também alterar o seu arquivo properties.yml adicionado a seguinte estrutura:

# CORS config
config:
  cors:
    allowed-origins: http://localhost:4200, https://www.url-do-front.com.br
    allowed-methods: GET, POST, PATCH, PUT, DELETE, OPTIONS, HEAD
    max-age: 3600
    allowed-headers: "*"
    exposed-headers: "*"

Explicando aqui:
A classe de configuração implementa a interface nativa do Spring MVC chamada WebMvcConfigurer e com isso você precisa sobrescrever o método: void addCorsMappings(CorsRegistry registry).
Esse método, adiciona em tempo de configuração, as configurações de CORS informadas do arquivo .yml que são recuperadas de lá pela anotação @Value, também do Spring.

Nota: No método addCorsMapping, para a classe CorsRegistry, precisa adicionar o método allowCredentials(true), com ele o Swagger não ficará solicitando credenciais de acesso para carregar a página inicial.

Então quando você der o start no projeto, as configurações serão carregadas e adicionadas ao contexto do CORS, com isso não precisa mais da anotação @CrossOrigin em cada endpoint.

Mas claro, lembrando que cada um tem sua necessidade de implementação do CORS, que isso varia de acordo com cada projeto.

Para minha necessidade atual, funcionou perfeitamente. 😊

Até qualquer dia... 😉

Integrando 'Windows Terminal' e 'Cmder': o melhor das duas ferramentas.

Jean Carlos Corrêa Couto — Tue, 19 Jul 2022 12:47:04 +0000

Sempre preferi utilizar o terminal (ou cmd) para fazer os commits do Git, subir os projetos Springboot ou subir o projeto Angular local, externamente à IDE, até que descobri um terminal bem interessante para utilizar no Windows, o Cmder, nele podemos utilizar tanto os comandos do Windows quanto do Linux.

O "problema" é que parece que os desenvolvedores do Cmder pararam de evoluí-lo, se dedicando mais ao ConEmu.

Então recente decidi instalar o Windows Terminal e ver o quanto ele havia evoluído, foi quando encontrei um tutorial bem bacana de como integrar as duas ferramentas.

No Medium do Wolfgang Dielingen ele explica o passo a passo para fazer esta integração, vou deixar o link aqui: Windows Terminal + Cmder = ❤️.

Muito simples e rápida a configuração. 👏 👏 👏

Já estou utilizando e ficou bom demais! 😁

Configurando Visual Studio Code para desenvolvimento Java.

Jean Carlos Corrêa Couto — Wed, 08 Jun 2022 20:49:38 +0000

Partindo do ponto que já há Java (JDK) e Maven configurados na sua máquina de desenvolvimento, estas são as extensões que precisam ser adicionadas no VS Code:

Caso queira, podes reiniciar o VS Code (para descargo de consciência).

Assim que abrir o diretório da sua API pelo VS Code, no menu lateral irá aparecer uma Seção do Spring, entrando nela você vai notar o tópico Spring boot dashboard, ali estará o “Run” e o “Debug”.

Após o primeiro start da API, será criado o diretório “.vscode” na estrutura do projeto, dentro dele estará o arquivo “launch.json”, este arquivo podemos utilizar para informar as VM Arguments.

Caso sua aplicação utilize Vm Args para definir o profile quando subir, você terá que editar o arquivo “launch.json”, alterando a propriedade “args” (que estará vazia) e colocando nela a string do profile:

“args”: “--spring.profiles.active=local”

Fazendo isso, o VS Code estará pronto para utilizar nas APIs Spring Boot. ;)

Bônus:
As vezes precisamos sobrescrever os métodos Equals e HashCode (entre outros) para atender nossas necessidades, aqui está a extensão para gerá-los.

https://marketplace.visualstudio.com/items?itemName=sohibe.java-generate-setters-getters