<h1> JAVA | Java 解决跨域问题 </h1>

Table of Contents

• 引言

  • 什么是跨域（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 转发的其余我的项目，不要进行配置跨域配置

有时即便配置了也不会起作用，这时你能够依据浏览器管制的谬误输入来查看问题，如果提醒是 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);
    }));
  }
}