CORS (Cross-origin resource sharing) allows a webpage to request additional resources into browser from other domains e.g. fonts, CSS or static images from CDN. CORS helps in serving web content from multiple domains into browsers who usually have the same-origin security policy.
In this example, we will learn to enable Spring CORS support in Spring MVC application at method level and global level.
Read More: Java CORS Filter Example
Table of Contents 1. Spring CORS - Method level with @CrossOrigin 2. Spring CORS - Global CORS configuration
1. Spring CORS – Method level with @CrossOrigin
Spring MVC provides @CrossOrigin annotation. This annotation marks the annotated method or type as permitting cross origin requests.
1.1. Spring CORS allow all
By default, @CrossOrigin allows all origins, all headers, the HTTP methods specified in the @RequestMapping annotation and a maxAge of 30 minutes.
You can override default CORS settings by giving value to annotation attributes :
| Attribute | Description |
|---|---|
origins | List of allowed origins. It’s value is placed in the Access-Control-Allow-Origin header of both the pre-flight response and the actual response.
|
allowedHeaders | List of request headers that can be used during the actual request. Value is used in preflight’s response header Access-Control-Allow-Headers.
|
methods | List of supported HTTP request methods. If undefined, methods defined by RequestMapping annotation are used. |
exposedHeaders | List of response headers that the browser will allow the client to access. Value is set in actual response header Access-Control-Expose-Headers.
|
allowCredentials | It determine whether browser should include any cookies associated with the request.
|
maxAge | Maximum age (in seconds) of the cache duration for pre-flight responses. Value is set in header Access-Control-Max-Age.
|
1.2. @CrossOrigin at Class/Controller Level
@CrossOrigin(origins = "*", allowedHeaders = "*")
@Controller
public class HomeController
{
@GetMapping(path="/")
public String homeInit(Model model) {
return "home";
}
}
Read More – Spring 5 MVC Example
1.3. @CrossOrigin at Method Level
@Controller
public class HomeController
{
@CrossOrigin(origins = "*", allowedHeaders = "*")
@GetMapping(path="/")
public String homeInit(Model model) {
return "home";
}
}
1.4. @CrossOrigin Overridden at Method Level
homeInit() method will be accessible only from domain http://example.com. Rest other methods in HomeController will be accessible from all domains.
@Controller
@CrossOrigin(origins = "*", allowedHeaders = "*")
public class HomeController
{
@CrossOrigin(origins = "http://example.com")
@GetMapping(path="/")
public String homeInit(Model model) {
return "home";
}
}
2. Spring CORS – Global CORS configuration
2.1. Implement WebMvcConfigurer
To enable CORS for the whole application, use WebMvcConfigurer to add CorsRegistry.
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
public class CorsConfiguration implements WebMvcConfigurer
{
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedMethods("GET", "POST");
}
}
2.2. WebMvcConfigurer Bean
In spring boot application, it is recommended to just declare a WebMvcConfigurer bean.
@Configuration
public class CorsConfiguration
{
@Bean
public WebMvcConfigurer corsConfigurer()
{
return new WebMvcConfigurer() {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**").allowedOrigins("http://localhost:8080");
}
};
}
}
2.3. CORS with Spring Security
To enable CORS support through Spring security, configure CorsConfigurationSource bean and use HttpSecurity.cors() configuration.
@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
http.cors().and()
//other config
}
@Bean
CorsConfigurationSource corsConfigurationSource()
{
CorsConfiguration configuration = new CorsConfiguration();
configuration.setAllowedOrigins(Arrays.asList("https://example.com"));
configuration.setAllowedMethods(Arrays.asList("GET","POST"));
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", configuration);
return source;
}
}
Drop me your questions in comments section.
Happy Learning !!
Rioh Rowe
This is really great. Exactly what I was looking for. Unfortunately, It did not work for what I am working on. I am attempting to implement SOAP using Spring Boot, and when I try and grab the WSDL from my angular project, I get A CORS Policy violation. The WSDL is generated automatically by Spring Boot and made available as an endpoint by a
MessageDispatcherServlet:package com.rioh.endpoints.configuration; import org.springframework.boot.web.servlet.ServletRegistrationBean; import org.springframework.context.ApplicationContext; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.io.ClassPathResource; import org.springframework.web.bind.annotation.CrossOrigin; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import org.springframework.ws.config.annotation.EnableWs; import org.springframework.ws.transport.http.MessageDispatcherServlet; import org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition; import org.springframework.xml.xsd.SimpleXsdSchema; import org.springframework.xml.xsd.XsdSchema; @Configuration @EnableWs public class RoutesEndpointConfig { @Bean public ServletRegistrationBean messageDispatcherServlet(ApplicationContext context) { MessageDispatcherServlet servlet = new MessageDispatcherServlet(); servlet.setApplicationContext(context); servlet.setTransformWsdlLocations(true); return new ServletRegistrationBean(servlet, "/ws/*"); } @Bean(name = "Routes") public DefaultWsdl11Definition defaultWsdl11DefinitionAddRoute(XsdSchema schema) { DefaultWsdl11Definition defaultWsdl11Definition = new DefaultWsdl11Definition(); defaultWsdl11Definition.setPortTypeName("Routes"); defaultWsdl11Definition.setLocationUri("/ws"); defaultWsdl11Definition.setTargetNamespace("http://www.rioh.Route.webservice"); defaultWsdl11Definition.setSchema(schema); return defaultWsdl11Definition; } @Bean public XsdSchema schema() { return new SimpleXsdSchema(new ClassPathResource("RouteSoapMeta.xsd")); } }Even when using the global CORS configuration, I still get the “Blocked by cors policy” error in my browser when I try and access it from my angular project.
abhijit
cors is not working for POST method. almost tried all the methods
Rao
“WebSecurityConfigurerAdapter”
Have you tested this code.
WebSecurityConfigurerAdapter is deprecated with Spring 5 and Spring Boot 2.0.
Adifferent appraoch has to be used.
Mach
which one ? , please explain if you know working solution.
surya
Somehow every code base on Spring Boot 2 Security including the examples on “Spring.io” work only on localhost.
Looks like there is some undocumented code base related to CORS. Because the document approach fails in staging hence cannot be enhanced and promoted to production.
None work in Production or staging environment.
I have tested this code base and various others on code bases on AWS, Azure, Google and other cloud vendors.
Somehow all sample code-bases work excellently on local host.
On staging it is failure.
I have tried two scenarios the application front-end on a different physical instance on Apache httpd and java Rest Services on a different physical instance with Tomcat.
Vikram
Sorry for asking such a basic question, but to what does “/**” refer in addMapping()? Allowed origins? Allowed headers?
Lokesh Gupta
This is a path pattern that used in Apache ant which spring team uses in whole framework.
Ref : SO Thread
Jayapriya
Hi,
I’m trying you integrate angular js with spring boot. I’m getting cross origin error at angular js side after the call returns from rest service. Will this snippet add header to the response? It seems it’s not working in my code.
thanks,
jayapriya
Hamid
I have this problem too. I have no idead how to fix it
Satish
In HttpSecurity cors() method does not present To enable CORS support through Spring security?
Lucifer
I got error at http.cors() cors() not defined. Please help.
Gustavo S
Hi, greate example and it works perfect, but I have updated my code base to spring 5 and spring boot 2 and that code is shown as deprecated. I have modified the implementation and all works fine but i have a problem when a the originating request is coming from a domain bound to a port like localhost:3001 (example
Balaji
Hi thanks for your valuable example, i have enables cors for spring security in XML, but i am getting 401 unauthorised problem of preflight request with OPTIONS method. I am using spring security and wildfly server.