在前后端分离的开发模式下,前端访问不同域的后端接口时,会遇到跨域问题(CORS)。SpringBoot 提供了多种解决方案,本文介绍几种常见方法,并附详细代码示例。
方法一:使用 @CrossOrigin
注解
Spring 提供了 @CrossOrigin
注解,可以直接在控制器或具体方法上添加。
1. 作用于类级别
@RestController
@RequestMapping("/api")
@CrossOrigin(origins = "http://localhost:3000")
public class DemoController {
@GetMapping("/data")
public String getData() {
return "Hello, CORS!";
}
}
2. 作用于方法级别
@RestController
@RequestMapping("/api")
public class DemoController {
@CrossOrigin(origins = "http://localhost:3000")
@GetMapping("/data")
public String getData() {
return "Hello, CORS!";
}
}
方法二:使用 WebMvcConfigurer
全局配置 CORS
如果需要对整个应用进行跨域配置,可以使用 WebMvcConfigurer
。
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class CorsConfig implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("http://localhost:3000")
.allowedMethods("GET", "POST", "PUT", "DELETE")
.allowedHeaders("*")
.allowCredentials(true);
}
}
方法三:使用 CorsFilter
另一种方式是使用 CorsFilter
进行全局配置。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import java.util.Arrays;
@Configuration
public class CustomCorsFilter {
@Bean
public CorsFilter corsFilter() {
CorsConfiguration config = new CorsConfiguration();
config.setAllowedOrigins(Arrays.asList("http://localhost:3000"));
config.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "DELETE"));
config.setAllowedHeaders(Arrays.asList("*"));
config.setAllowCredentials(true);
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", config);
return new CorsFilter(source);
}
}
方法四:使用 Filter
方式手动设置响应头
如果需要更底层的跨域控制,可以使用 Filter
进行配置。
import jakarta.servlet.*;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import java.io.IOException;
@Component
public class CustomCorsFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletResponse res = (HttpServletResponse) response;
res.setHeader("Access-Control-Allow-Origin", "http://localhost:3000");
res.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE");
res.setHeader("Access-Control-Allow-Headers", "*");
res.setHeader("Access-Control-Allow-Credentials", "true");
chain.doFilter(request, response);
}
}
结论
SpringBoot 提供了多种方式来解决跨域问题,包括 @CrossOrigin
注解、WebMvcConfigurer
配置、CorsFilter
以及 Filter
方式。不同方法适用于不同场景,可根据项目需求选择最合适的方案。
希望本文对你有所帮助!