Java 如何解決跨域問題

Posted on by

引言

我們在開發過程中經常會遇到前後端分離而導致的跨域問題，導致無法獲取返回結果。跨域就像分離前端和後端的一道鴻溝，君在這邊，她在那邊，兩兩不能往來.

什麼是跨域（CORS）

跨域（CORS）是指不同域名之間相互訪問。跨域，指的是瀏覽器不能執行其他網站的腳本，它是由瀏覽器的同源策略所造成的，是瀏覽器對於JavaScript所定義的安全限制策略。

什麼情況會跨域

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

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

解決方案

前端解決方案

  • 使用JSONP方式實現跨域調用；
  • 使用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 轉發的其他項目，不要進行配置跨域配置

有時即使配置瞭也不會起作用，這時你可以根據瀏覽器控制的錯誤輸出來查看問題，如果提示是 response 中 header 出現瞭重復的 Access-Control-* 請求頭，可以進行如下操作

import java.util.ArrayList;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.cloud.gateway.filter.NettyWriteResponseFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Component("corsResponseHeaderFilter")
public class CorsResponseHeaderFilter implements GlobalFilter, Ordered {

 @Override
 public int getOrder() {
  // 指定此過濾器位於NettyWriteResponseFilter之後
  // 即待處理完響應體後接著處理響應頭
  return NettyWriteResponseFilter.WRITE_RESPONSE_FILTER_ORDER + 1;
 }

 @Override
 public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  return chain.filter(exchange).then(Mono.defer(() -> {
   exchange.getResponse().getHeaders().entrySet().stream()
     .filter(kv -> (kv.getValue() != null && kv.getValue().size() > 1))
     .filter(kv -> (
       kv.getKey().equals(HttpHeaders.ACCESS_CONTROL_ALLOW_ORIGIN)
         || kv.getKey().equals(HttpHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS)
         || kv.getKey().equals(HttpHeaders.ACCESS_CONTROL_ALLOW_METHODS)
         || kv.getKey().equals(HttpHeaders.ACCESS_CONTROL_ALLOW_HEADERS)
         || kv.getKey().equals(HttpHeaders.ACCESS_CONTROL_MAX_AGE)))
     .forEach(kv -> {
      kv.setValue(new ArrayList<String>() {{
       add(kv.getValue().get(0));
      }});
     });
   return chain.filter(exchange);
  }));
 }
}

以上就是Java 如何解決跨域問題的詳細內容，更多關於Java 解決跨域問題的資料請關註WalkonNet其它相關文章！

推薦閱讀：