Springboot解決跨域問題方案總結(包括Nginx，Gateway網關等)
更新時間：2024年03月24日 09:16:39 作者：牽著貓散步的鼠鼠
跨域問題是瀏覽器為了保護用戶的信息安全,實施了同源策略（Same-Origin?Policy）,即只允許頁面請求同源（相同協議、域名和端口）的資源,本文給大家總結了Springboot解決跨域問題方案包括Nginx,Gateway網關等),需要的朋友可以參考下
前言
跨域問題是瀏覽器為了保護用戶的信息安全，實施了同源策略（Same-Origin Policy），即只允許頁面請求同源（相同協議、域名和端口）的資源，當 JavaScript 發(fā)起的請求跨越了同源策略，即請求的目標與當前頁面的域名、端口、協議不一致時，瀏覽器會阻止請求的發(fā)送或接收。
解決跨域問題方案
跨域問題可以從以下方面解決：
- 應用層面解決：例如 Spring Boot 項目中解決跨域問題。
- 反向代理解決：例如 Nginx 中解決跨域問題。
- 網關中解決：例如 Spring Cloud Gateway 中解決跨域問題。
而這 3 類解決方案，總共包含了 8 種解決方案，我們一起來看。
1.Spring Boot 中解決跨域
在 Spring Boot 中跨域問題有以下 5 種解決方案：
- 使用 @CrossOrigin 注解實現跨域【局域類跨域】
- 通過配置文件實現跨域【全局跨域】
- 通過 CorsFilter 對象實現跨域【全局跨域】
- 通過 Response 對象實現跨域【局域方法跨域】
- 通過實現 ResponseBodyAdvice 實現跨域【全局跨域】
接下來詳細來看。
1.1 通過注解跨域
使用 @CrossOrigin 注解可以輕松的實現跨域，此注解既可以修飾類，也可以修飾方法。當修飾類時，表示此類中的所有接口都可以跨域；當修飾方法時，表示此方法可以跨域，它的實現如下：
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
@RestController
@CrossOrigin(origins = "*") //origins可以指定請求來源，*代表全部
public class TestController {
@RequestMapping("/test")
public HashMap<String, Object> test() {
return new HashMap<String, Object>() {{
put("state", 200);
put("data", "success");
put("msg", "");
}};
}
}以上代碼的執(zhí)行結果如下圖所示：
從上圖中可以看出，前端項目訪問另一個后端項目成功了，也就說明它解決了跨域問題。
優(yōu)缺點分析
此方式雖然雖然實現（跨域）比較簡單，但細心的朋友也能發(fā)現，使用此方式只能實現局部跨域，當一個項目中存在多個類的話，使用此方式就會比較麻煩（需要給所有類上都添加此注解）。
1.2 通過配置文件跨域
通過設置配置文件的方式就可以實現全局跨域了，它的實現步驟如下：
- 創(chuàng)建一個新配置文件。
- 添加 @Configuration 注解，實現 WebMvcConfigurer 接口。
- 重寫 addCorsMappings 方法，設置允許跨域的代碼。
具體實現代碼如下：
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("/**") // 所有接口
.allowCredentials(true) // 是否發(fā)送 Cookie
.allowedOriginPatterns("*") // 支持域
.allowedMethods(new String[]{"GET", "POST", "PUT", "DELETE"}) // 支持方法
.allowedHeaders("*")
.exposedHeaders("*");
}
}1.3 通過 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;
@Configuration // 一定不能忽略此注解
public class MyCorsFilter {
@Bean
public CorsFilter corsFilter() {
// 1.創(chuàng)建 CORS 配置對象
CorsConfiguration config = new CorsConfiguration();
// 支持域
config.addAllowedOriginPattern("*");
// 是否發(fā)送 Cookie
config.setAllowCredentials(true);
// 支持請求方式
config.addAllowedMethod("*");
// 允許的原始請求頭部信息
config.addAllowedHeader("*");
// 暴露的頭部信息
config.addExposedHeader("*");
// 2.添加地址映射
UrlBasedCorsConfigurationSource corsConfigurationSource = new UrlBasedCorsConfigurationSource();
corsConfigurationSource.registerCorsConfiguration("/**", config);
// 3.返回 CorsFilter 對象
return new CorsFilter(corsConfigurationSource);
}
}1.4 通過 Response 跨域
此方式是解決跨域問題最原始的方式，但它可以支持任意的 Spring Boot 版本（早期的 Spring Boot 版本也是支持的）。但此方式也是局部跨域，它應用的范圍最小，設置的是方法級別的跨域，它的具體實現代碼如下：
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.util.HashMap;
@RestController
public class TestController {
@RequestMapping("/test")
public HashMap<String, Object> test(HttpServletResponse response) {
// 設置跨域
response.setHeader("Access-Control-Allow-Origin", "*");
return new HashMap<String, Object>() {{
put("state", 200);
put("data", "success");
put("msg", "");
}};
}
}1.5 通過 ResponseBodyAdvice 跨域
通過重寫 ResponseBodyAdvice 接口中的 beforeBodyWrite（返回之前重寫）方法，我們可以對所有的接口進行跨域設置，此方法是基于AOP切面實現的，它的具體實現代碼如下：
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
/**
* 內容是否需要重寫（通過此方法可以選擇性部分控制器和方法進行重寫）
* 返回 true 表示重寫
*/
@Override
public boolean supports(MethodParameter returnType, Class converterType) {
return true;
}
/**
* 方法返回之前調用此方法
*/
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
Class selectedConverterType, ServerHttpRequest request,
ServerHttpResponse response) {
// 設置跨域
response.getHeaders().set("Access-Control-Allow-Origin", "*");
return body;
}
}此實現方式也是全局跨域，它對整個項目中的所有接口有效。
2.Nginx 中解決跨域
在 Nginx 服務器的配置文件中添加以下代碼：
server {
listen 80;
server_name your_domain.com;
location /api {
# 允許跨域請求的域名，* 表示允許所有域名訪問
add_header 'Access-Control-Allow-Origin' '*';
# 允許跨域請求的方法
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
# 允許跨域請求的自定義 Header
add_header 'Access-Control-Allow-Headers' 'Origin, X-Requested-With, Content-Type, Accept';
# 允許跨域請求的 Credential，如果需要傳遞Cookie就需要開啟此項
add_header 'Access-Control-Allow-Credentials' 'true';
# 預檢請求的存活時間，即 Options 請求的響應緩存時間
add_header 'Access-Control-Max-Age' 3600;
# 處理預檢請求
if ($request_method = 'OPTIONS') {
return 204;
}
}
# 其他配置...
}上述示例中，location /api 代表配置針對 /api 路徑的請求進行跨域設置?？梢愿鶕唧w需要修改 location 的值和其他相關參數。配置中的 add_header 指令用于設置響應頭部，常用的響應頭部包括以下這些：
- Access-Control-Allow-Origin：用于指定允許跨域的域名，可以設置為 * 表示允許所有域名訪問。
- Access-Control-Allow-Methods：用于指定允許的跨域請求的方法，例如 GET、POST、OPTIONS 等。
- Access-Control-Allow-Headers：用于指定允許的跨域請求的自定義 Header。
- Access-Control-Allow-Credentials：用于指定是否允許跨域請求發(fā)送和接收 Cookie。
- Access-Control-Max-Age：用于設置預檢請求（OPTIONS 請求）的響應緩存時間。
3.網關中解決跨域
Spring Cloud Gateway 中解決跨域問題可以通過以下兩種方式實現：
- 通過在配置文件中配置跨域實現。
- 通過在框架中添加 CorsWebFilter 來解決跨域問題。
3.1 配置文件中設置跨域
在 application.yml 或 application.properties 中添加以下配置：
spring:
cloud:
gateway:
globalcors:
corsConfigurations:
'[/**]': # 這里的'/**'表示對所有路由生效，可以根據需要調整為特定路徑
allowedOrigins: "*" # 允許所有的源地址，也可以指定具體的域名
allowedMethods: # 允許的 HTTP 方法類型
- GET
- POST
- PUT
- DELETE
- OPTIONS
allowedHeaders: "*" # 允許所有的請求頭，也可以指定具體的請求頭
allowCredentials: true # 是否允許攜帶憑證（cookies）
maxAge: 3600 # CORS預檢請求的有效期（秒）其中：
- allowedOrigins: 設置允許訪問的來源域名列表，"*" 表示允許任何源。
- allowedMethods: 指定哪些HTTP方法可以被用于跨域請求。
- allowedHeaders: 客戶端發(fā)送的請求頭列表，"*" 表示允許任何請求頭。
- allowCredentials: 當設為 true 時，允許瀏覽器在發(fā)起跨域請求時攜帶認證信息（例如 cookies）。
- maxAge: 預檢請求的結果可以在客戶端緩存的最大時間。
通過這樣的配置，Spring Cloud Gateway 網關將自動處理所有經過它的跨域請求，并添加相應的響應頭，從而允許前端應用執(zhí)行跨域請求。
3.2 添加 CorsWebFilter 來解決跨域問題
在 Spring-Framework 從 5.3 版本之前，使用以下代碼可以讓 Spring Cloud Gateway 網關允許跨域：
@Configuration
public class GlobalCorsConfig {
@Bean
public CorsWebFilter corsWebFilter() {
CorsConfiguration config = new CorsConfiguration();
// 這里僅為了說明問題，配置為放行所有域名，生產環(huán)境請對此進行修改
config.addAllowedOrigin("*");
// 放行的請求頭
config.addAllowedHeader("*");
// 放行的請求類型，有 GET, POST, PUT, DELETE, OPTIONS
config.addAllowedMethod("*");
// 暴露頭部信息
config.addExposedHeader("*");
// 是否允許發(fā)送 Cookie
config.setAllowCredentials(true);
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", config);
return new CorsWebFilter(source);
}
}而 Spring-Framework 5.3 版本之后，關于 CORS 跨域配置類 CorsConfiguration 中將 addAllowedOrigin 方法名修改為 addAllowedOriginPattern，因此配置了變成了以下這樣：
@Configuration
public class GlobalCorsConfig {
@Bean
public CorsWebFilter corsWebFilter() {
CorsConfiguration config = new CorsConfiguration();
// 這里僅為了說明問題，配置為放行所有域名，生產環(huán)境請對此進行修改
config.addAllowedOriginPattern("*");
// 放行的請求頭
config.addAllowedHeader("*");
// 放行的請求類型，有 GET, POST, PUT, DELETE, OPTIONS
config.addAllowedMethod("*");
// 暴露頭部信息
config.addExposedHeader("*");
// 是否允許發(fā)送 Cookie
config.setAllowCredentials(true);
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
source.registerCorsConfiguration("/**", config);
return new CorsWebFilter(source);
}
}小結
跨域問題可以在網關層、反向代理層或應用層來解決，而它們的使用優(yōu)先級是：網關層 > 代理層 > 應用層。因為越靠前覆蓋范圍就越大，解決跨域問題就越容易。當前，具體使用哪種方案是要根據項目的實際情況來判定的。
以上就是Springboot解決跨域問題方案總結(包括Nginx，Gateway網關等)的詳細內容，更多關于Springboot解決跨域問題的資料請關注腳本之家其它相關文章！
相關文章
依賴注入是由“依賴”和“注入”兩個詞匯組合而成，那么我們再一次順藤摸瓜，分別分析這兩個詞語，這篇文章主要介紹了Spring DI依賴注入詳解,需要的朋友可以參考下2023-04-04
本文詳細介紹了MyBatis-Plus單表操作,包括自定義SQL、邏輯刪除、樂觀鎖、全局攔截器和代碼生成器等,具有一定的參考價值,感興趣的可以了解一下2024-12-12
這篇文章主要為大家詳細介紹了java五子棋實現代碼，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-07-07
這篇文章主要介紹了SpringBoot集成Swagger2的方法,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-12-12
這篇文章主要介紹了Java多線程synchronized同步方法詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-03-03
Java實戰(zhàn)之網上書店管理系統(tǒng)的實現
本文將利用Java語言實現網上書店管理系統(tǒng)。其功能一般包括：圖書信息管理、用戶信息管理、圖書購買、圖書訂單查看、圖書添加、圖書維護等等，感興趣的可以了解一下2022-06-06
參數列表和字面意思差不多，主要是表示該參數數量不是固定的，可能會有一個參數，可能多個，不管多少個參數，都放到一個數組處理，這種參數叫可變參數?？勺冮L參數要放在最后一個參數位置處理，但是一個函數里面不能有倆種類型的可變參數2021-10-10
這篇文章主要為大家詳細介紹了java實現簡單汽車租賃系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-01-01
詳解Kotlin：forEach也能break和continue
這篇文章主要介紹了詳解Kotlin：forEach也能break和continue的相關資料,需要的朋友可以參考下2017-06-06
在Java中避免NullPointerException的解決方案
這篇文章主要介紹了在Java中避免NullPointerException的解決方案,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-04-04