SpringBoot实现跨域的5种方式

为什么会出现跨域问题

出于浏览器的同源策略限制。同源策略(Sameoriginpolicy)是一种约定,它是浏览器核心也基本的安全功能,如果缺少了同源策略,则浏览器的正常功能可能都会受到影响。可以说Web是构建在同源策略基础之上的,浏览器只是针对同源策略的一种实现。

同源策略会阻止一个域的javascript脚本和另外一个域的内容进行交互。所谓同源(即指在同一个域)就是两个页面具有相同的协议(protocol),主机(host)和端口号(port)。

什么是跨域

当一个请求url的协议、域名、端口三者之间任意一个与当前页面url不同即为跨域

img

非同源限制

  1. 无法读取非同源网页的 Cookie、LocalStorage 和 IndexedDB
  2. 无法接触非同源网页的 DOM
  3. 无法向非同源地址发送 AJAX 请求

Java后端实现CORS跨域请求的方式

对于 CORS 的跨域请求,主要有以下几种方式可供选择:

  • 返回新的CorsFilter

  • 重写 WebMvcConfigurer

  • 使用注解 @CrossOrigin

  • 手动设置响应头 (HttpServletResponse)

  • 自定 web filter 实现跨域

注意:

  • CorFilter / WebMvConfigurer / @CrossOrigin 需要 SpringMVC 4.2以上版本才支持,对应springBoot 1.3版本以上
  • 上面前两种方式属于全局 CORS 配置,后两种属于局部 CORS 配置。局部跨域是会覆盖全局跨域规则,所以可以通过 @CrossOrigin 注解来进行细粒度更高的跨域资源控制。
  • 其实无论哪种方案,终目的都是修改响应头,向响应头中添加浏览器所要求的数据,进而实现跨域。

返回新的CorsFilter(全局跨域)

在任意配置类,返回一个 新的 CorsFIlter Bean ,并添加映射路径和具体的CORS配置路径。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@Configuration
public class GlobalCorsConfig {
@Bean
public CorsFilter corsFilter() {
//1. 添加 CORS配置信息
CorsConfiguration config = new CorsConfiguration();
//放行哪些原始域
config.addAllowedOrigin("*");
//是否发送 Cookie
config.setAllowCredentials(true);
//放行哪些请求方式
config.addAllowedMethod("*");
//放行哪些原始请求头部信息
config.addAllowedHeader("*");
//暴露哪些头部信息
config.addExposedHeader("*");
//2. 添加映射路径
UrlBasedCorsConfigurationSource corsConfigurationSource = new UrlBasedCorsConfigurationSource();
corsConfigurationSource.registerCorsConfiguration("/**",config);
//3. 返回新的CorsFilter
return new CorsFilter(corsConfigurationSource);
}
}

重写WebMvcConfigurer(全局跨域)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Configuration
public class CorsConfig implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
//是否发送Cookie
.allowCredentials(true)
//放行哪些原始域
.allowedOrigins("*")
.allowedMethods(new String[]{"GET", "POST", "PUT", "DELETE"})
.allowedHeaders("*")
.exposedHeaders("*");
}
}

使用注解(局部跨域)

在控制器(类上)上使用注解 @CrossOrigin:,表示该类的所有方法允许跨域。

1
2
3
4
5
6
7
8
@RestController
@CrossOrigin(origins = "*")
public class HelloController {
@RequestMapping("/hello")
public String hello() {
return "hello world";
}
}

在方法上使用注解 @CrossOrigin:

1
2
3
4
5
6
@RequestMapping("/hello")
@CrossOrigin(origins = "*")
//@CrossOrigin(value = "http://localhost:8081") //指定具体ip允许跨域
public String hello() {
return "hello world";
}

手动设置响应头(局部跨域)

使用 HttpServletResponse 对象添加响应头(Access-Control-Allow-Origin)来授权原始域,这里 Origin的值也可以设置为 “*”,表示全部放行。

1
2
3
4
5
@RequestMapping("/index")
public String index(HttpServletResponse response) {
response.addHeader("Access-Allow-Control-Origin","*");
return "index";
}

使用自定义Filter实现跨域

首先编写一个过滤器,可以起名字为CorsFilter.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Component;

import lombok.extern.slf4j.Slf4j;

/**
* 自定义跨域过滤器
*/
@Component
@Order(1)
@Slf4j
public class CorsFilter implements Filter {
/**
* 初始化
*
* @param filterConfig data
*/
@Override
public void init(FilterConfig filterConfig) {
// 执行初始化操作
log.debug(">>>>>>>> CorsFilter init");
}

/**
* 执行过滤
*
* @param request data
* @param response data
* @param chain data
* @throws IOException data
* @throws ServletException data
*/
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest req = null;
HttpServletResponse res = null;
if (request instanceof HttpServletRequest) {
req = (HttpServletRequest) request;
}
// 此方法是 Java 语言instanceof运算符的动态等效项。
if (HttpServletResponse.class.isInstance(response)) {
res = (HttpServletResponse) response;
}

if (req == null || res == null) {
return;
}

String originResponse = "*";
String origin = req.getHeader(HttpHeaders.ORIGIN);
String referer = req.getHeader(HttpHeaders.REFERER);
String str = ObjectUtils.firstNonNull(origin, referer);
if (!StringUtils.isBlank(str)) {
originResponse = str.substring(0, referer.indexOf('/', 8));
}

// https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers
// 解决跨域问题
res.setHeader(HttpHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, originResponse);
res.setHeader(HttpHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS, "true");
res.setHeader(HttpHeaders.ACCESS_CONTROL_ALLOW_HEADERS, "*");
res.setHeader(HttpHeaders.ACCESS_CONTROL_ALLOW_METHODS, "*");
res.setHeader(HttpHeaders.ACCESS_CONTROL_EXPOSE_HEADERS, "");
res.setHeader(HttpHeaders.ACCESS_CONTROL_MAX_AGE, "3600");

chain.doFilter(req, res);
}

/**
* 销毁
*/
@Override
public void destroy() {
// 执行销毁操作
log.debug(">>>>>>>> CorsFilter destroy");
}
}