使用Spring Boot解決跨域問題示例

跨域問題指的是在Web開發中，瀏覽器限制了JavaScript跨域訪問其他網站的資源，而解決跨域問題是大部分Web開發工程師必須面對的問題之一。在使用Spring Boot進行開發的過程中，Spring框架對解決跨域問題也提供了一些支持。本文將從以下幾個方面詳細闡述使用Spring Boot解決跨域問題的步驟及示例代碼。

一、設置CORS配置

在使用Spring Boot解決跨域問題時，我們可以通過設置CORS（Cross Origin Resource Sharing）配置來允許或禁止特定域名的訪問。下面是一個允許所有域名訪問的CORS配置示例：

“`java
@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer {

@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping(“/**”)
.allowedOrigins(“*”)
.allowedMethods(“*”)
.allowedHeaders(“*”)
.allowCredentials(true)
.maxAge(3600);
}
}
“`

上述代碼中，我們使用了@WebMvcConfigurer介面提供的addCorsMappings方法將所有請求映射到「/**」，並設置了允許的域名、請求方法、請求頭部、允許附帶身份驗證信息以及緩存響應的有效時間。

二、使用WebMvcConfigurerAdapter配置

除了使用@WebMvcConfigurer介面外，我們還可以使用WebMvcConfigurerAdapter配置。下面是一個使用WebMvcConfigurerAdapter配置的示例：

“`java
@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping(“/**”)
.allowedOrigins(“*”)
.allowedMethods(“GET”, “POST”, “PUT”, “DELETE”, “OPTIONS”)
.allowedHeaders(“x-requested-with”)
.allowCredentials(true)
.maxAge(3600);
}
}
“`

上述代碼中，我們首先定義了一個WebMvcConfig類，並將其標註為@Configuration。然後，我們重寫了WebMvcConfigurerAdapter提供的addCorsMappings方法，將所有請求映射到「/**」，並設置允許的域名、請求方法、請求頭部、允許附帶身份驗證信息以及緩存響應的有效時間。

三、使用@CrossOrigin註解

除了使用CORS配置以外，我們還可以使用@CrossOrigin註解標記響應方法，以指定允許訪問的域名、請求方法、請求頭部等信息。下面是一個使用@CrossOrigin註解的示例：

“`java
@RestController
@RequestMapping(“/api”)
public class UserController {
@CrossOrigin(origins = “*”, maxAge = 3600, allowCredentials = “true”, methods = {RequestMethod.GET, RequestMethod.POST, RequestMethod.PUT, RequestMethod.DELETE})
@GetMapping(“/users”)
public List getAllUsers() {
return userService.findAllUsers();
}
}
“`

上述代碼中，我們使用@RestController註解定義了一個UserController類，並在方法級別使用@CrossOrigin註解標記了getAllUsers方法，指定了允許的域名、請求方法、請求頭部以及緩存響應的有效時間。

四、使用Filter實現CORS配置

除了使用上述方法外，我們還可以使用Filter實現CORS配置。下面是一個使用Filter實現CORS配置的示例：

“`java
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class CORSFilter implements Filter {

@Override
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
HttpServletResponse response = (HttpServletResponse) res;
HttpServletRequest request = (HttpServletRequest) req;
response.setHeader(“Access-Control-Allow-Origin”, “*”);
response.setHeader(“Access-Control-Allow-Methods”, “POST, GET, OPTIONS, DELETE, PUT”);
response.setHeader(“Access-Control-Max-Age”, “3600”);
response.setHeader(“Access-Control-Allow-Headers”, “x-requested-with, authorization, Content-Type, Authorization, credential, X-XSRF-TOKEN, Cache-Control”);
if (“OPTIONS”.equalsIgnoreCase(request.getMethod())) {
response.setStatus(HttpServletResponse.SC_OK);
} else {
chain.doFilter(req, res);
}
}
}
“`

上述代碼中，我們定義了一個CORSFilter過濾器，並使用@Component註解標記其為一個Spring Bean。在過濾器中，我們在響應頭部設置了允許的域名、請求方法、請求頭部以及緩存響應的有效時間，並處理了OPTIONS請求。

五、小結

本文從CORS配置、WebMvcConfigurerAdapter配置、@CrossOrigin註解、Filter四個方面詳細闡述了使用Spring Boot解決跨域問題的步驟及示例代碼。在實際開發中，我們可以選擇適合自己的方法來解決跨域問題，提高Web應用程序的可靠性和安全性。