Java如何解決跨域問題

• 引言
  • 什么是跨域（CORS）
  • 什么情況會跨域
• 解決方案
  • 前端解決方案
  • 后端解決方案
• 具體方式
  • 一、使用Filter方式進行設置
  • 二、繼承 HandlerInterceptorAdapter
  • 三、實現 WebMvcConfigurer
  • 四、使用Nginx配置
  • 五、使用 @CrossOrgin 注解
• Spring Cloud Gateway 跨域配置

引言

我們在開發過程中經常會遇到前后端分離而導致的跨域問題，導致無法獲取返回結果。

什么是跨域（CORS）

跨域（CORS）是指不同域名之間相互訪問。

跨域，指的是瀏覽器不能執行其他網站的腳本，它是由瀏覽器的同源策略所造成的，是瀏覽器對於JavaScript所定義的安全限制策略。

什么情況會跨域

• 同一協議， 如http或https
• 同一IP地址, 如127.0.0.1
• 同一端口, 如8080

以上三個條件中有一個條件不同就會產生跨域問題。

解決方案

前端解決方案

1. 使用JSONP方式實現跨域調用；
2. 使用NodeJS服務器做為服務代理，前端發起請求到NodeJS服務器， NodeJS服務器代理轉發請求到后端服務器；

后端解決方案

• nginx反向代理解決跨域
• 服務端設置Response Header(響應頭部)的Access-Control-Allow-Origin
• 在需要跨域訪問的類和方法中設置允許跨域訪問（如Spring中使用@CrossOrigin注解）；
• 繼承使用Spring Web的CorsFilter（適用於Spring MVC、Spring Boot）
• 實現WebMvcConfigurer接口（適用於Spring Boot）

具體方式

一、使用Filter方式進行設置

使用Filter過濾器來過濾服務請求，向請求端設置Response Header(響應頭部)的Access-Control-Allow-Origin屬性聲明允許跨域訪問。

@WebFilter
public class CorsFilter implements Filter {  

    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {  
        HttpServletResponse response = (HttpServletResponse) res;  
        response.setHeader("Access-Control-Allow-Origin", "*");  
        response.setHeader("Access-Control-Allow-Methods", "*");  
        response.setHeader("Access-Control-Max-Age", "3600");  
        response.setHeader("Access-Control-Allow-Headers", "*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        chain.doFilter(req, res);  
    }  
}

二、繼承 HandlerInterceptorAdapter(攔截器方式)

@Component
public class CrossInterceptor extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS");
        response.setHeader("Access-Control-Max-Age", "3600");
        response.setHeader("Access-Control-Allow-Headers", "*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        return true;
    }
}

三、實現 WebMvcConfigurer

@Configuration
@SuppressWarnings("SpringJavaAutowiredFieldsWarningInspection")
public class AppConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")  // 攔截所有的請求
                .allowedOrigins("http://www.abc.com")  // 可跨域的域名，可以為 *
                .allowCredentials(true)
                .allowedMethods("*")   // 允許跨域的方法，可以單獨配置
                .allowedHeaders("*");  // 允許跨域的請求頭，可以單獨配置
    }
}

四、使用Nginx配置

location / {
 add_header Access-Control-Allow-Origin *; add_header Access-Control-Allow-Headers X-Requested-With; add_header Access-Control-Allow-Methods GET,POST,PUT,DELETE,OPTIONS; if ($request_method = 'OPTIONS') {
     return 204;
   }
}

五、使用 @CrossOrgin 注解

如果只是想部分接口跨域，且不想使用配置來管理的話，可以使用這種方式

在Controller使用

@CrossOrigin
@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/{id}")
    public User get(@PathVariable Long id) {
        
    }

    @DeleteMapping("/{id}")
    public void remove(@PathVariable Long id) {

    }
}

在具體接口上使用

@RestController
@RequestMapping("/user")
public class UserController {

    @CrossOrigin
    @GetMapping("/{id}")
    public User get(@PathVariable Long id) {
        
    }

    @DeleteMapping("/{id}")
    public void remove(@PathVariable Long id) {

    }
}

六.Spring Cloud Gateway 跨域配置

spring: 
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            # 允許跨域的源(網站域名/ip)，設置*為全部
            # 允許跨域請求里的head字段，設置*為全部
            # 允許跨域的method， 默認為GET和OPTIONS，設置*為全部
            allow-credentials: true allowed-origins: - "http://xb.abc.com"
              - "http://sf.xx.com" allowed-headers: "*" allowed-methods: - OPTIONS - GET - POST - DELETE - PUT - PATCH
            max-age: 3600

注意： 通過gateway 轉發的其他項目，不要進行配置跨域配置

 

參考：https://cloud.tencent.com/developer/article/1668879