网关gateway的基本使用详解
一、网关的基本概念
`SpringCloudGateway`
网关是所有微服务的统一入口。
1.1 他的主要作用是
反向代理(请求的转发)
路由和负载均衡
身份认证和权限控制
对请求限流
1.2 相比于Zuul的优势:
`SpringCloudGateway`
基于`Spring5`
中提供的`WebFlux`
,是一种响应式编程的实现,性能更加优越。
`Zuul`
的实现方式比较老式,基于`Servlet`
的实现,它是一种阻塞式编程,在高并发下性能性能不佳。
拓展:
其实`Nginx`也可以作为网关,但是要使用`Nginx`自主实现网关的相关功能,还需要借助lua脚本语言
学习成本是比较高的,现在一般也不会使用它来做网关,但是只按性能来讲`Nginx`,性能是最高的。
1.3 SpringCloudGateway架构图:
微服务只接收来自网关的请求,而其它直接访问微服务本身的请求拒绝。
这样可以极大保护微服务免受不法侵害。
同时在请求压力激增时,可以实施服务限流,保护微服务集群。
二、SpringBoot中配置GateWay
2.1 引入GateWay的Maven依赖
<!--网关 起步依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现 起步依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
2.2 配置application.yml文件
server:
port: 10086 # 网关端口
spring:
application:
name: gateway # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由id,自定义,只要唯一即可
# uri: http://127.0.0.1:8081 # 路由的目标地址 (直接写死地址的方式,不推荐)
uri: lb://userservice # 路由的目标地址 lb是负载均衡,后面跟服务名称(推荐)
predicates: # 路由断言,判断请求是否符合路由规则的条件
- Path=/user/** # 按照路径匹配,以/user/开头的请求就符合要求
filters:
# 在这里我们可以根据前端与后端的接口路径进行一个重定向
# 这里例如/api/user --> /user
- RewritePath=/api/(?<segment>.*), /$\{segment}
- id: card-service
uri: lb://cardservice
predicates:
- Path=/card/**
gateway配置中的注意点:
`routes` 后面的路由可以配置多个,相当于配置个数组,一个`-`开头的配置就是其中的一个数组元素。
`uri`为什么选择以服务名+负载均衡的方式?
主要是写死地址的话,今后如果`userservice`的地址变了,那么又要去修改`yml`配置文件。
而`lb://userservice`可以让程序员一眼认出这是哪个微服务,以后地址变了也无需修改`yml`配置文件。
上述配置详解:
将` /user/**`开头的请求,代理到`lb://userservice`。
将 `/card/**`开头的请求,代理到`lb://cardservice`。
`lb`是负载均衡,根据服务名拉取服务列表,实现负载均衡。
将前端传入的`/api/user/**`下的接口转变为`/user/**`的接口访问后台。
1. `http://127.0.0.1:10086/user/99 `就算是`/user/**`开头的请求,不要把协议、ip和端口计算在内。
2. 有多少个需要配置的路由,都按上面的格式配置即可。
三、网关的跨域问题
3.1 跨域的概念和原理
跨域:请求位置和被请求位置不同源就会发生跨域。
这里的不同源包括两个点:
- 域名不同:`
www.baidu.com`
和`www.taobao.com`
。(`IP`
不同也是相同道理)- 端口不同:`
127.0.0.1:8080`
和`127.0.0.1:8081`
。
而浏览器又会禁止请求的发起者与服务端发生跨域AJAX
请求。
如果发生了跨域请求,服务器端是能够正常响应的,但是响应的结果会被浏览器拦截。
3.2 跨域常见解决方案
使用`CORS`
方式。
`CORS`
是一个`W3C`
标准,全称是"跨域资源共享"(`Cross-origin resource sharing`
)。
它允许浏览器向跨源服务器,发出`XMLHttpRequest`
请求,从而克服了`AJAX`
只能同源使用的限制。
3.3 gateway中如何解决跨域问题
方式一:配置application.yml文件:
spring:
cloud:
gateway:
globalcors: # 全局的跨域配置
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
# options请求 就是一种询问服务器是否浏览器可以跨域的请求
# 如果每次跨域都有询问服务器是否浏览器可以跨域对性能也是损耗
# 可以配置本次跨域检测的有效期maxAge
# 在maxAge设置的时间范围内,不去询问,统统允许跨域
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 允许在请求中携带cookie
maxAge: 360000 # 本次跨域检测的有效期(单位毫秒)
# 有效期内,跨域请求不会一直发option请求去增大服务器压力
方式二:使用编码方式定义配置类:
@Configuration
public class CorsConfig {
private static final String MAX_AGE = "18000L";
@Bean
public WebFilter corsFilter() {
return (ServerWebExchange ctx, WebFilterChain chain) -> {
ServerHttpRequest request = ctx.getRequest();
// 使用SpringMvc自带的跨域检测工具类判断当前请求是否跨域
if (!CorsUtils.isCorsRequest(request)) {
return chain.filter(ctx);
}
// 获取请求头
HttpHeaders requestHeaders = request.getHeaders();
// 获取响应对象
ServerHttpResponse response = ctx.getResponse();
// 获取请求方式对象
HttpMethod requestMethod = requestHeaders.getAccessControlRequestMethod();
// 获取响应头
HttpHeaders headers = response.getHeaders();
// 把请求头中的请求源(协议+ip+端口)添加到响应头中(相当于yml中的allowedOrigins)
headers.add(HttpHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, requestHeaders.getOrigin());
headers.addAll(HttpHeaders.ACCESS_CONTROL_ALLOW_HEADERS, requestHeaders.getAccessControlRequestHeaders());
if (requestMethod != null) {
// 允许被响应的方法(GET/POST等,相当于yml中的allowedMethods)
headers.add(HttpHeaders.ACCESS_CONTROL_ALLOW_METHODS, requestMethod.name());
}
// 允许在请求中携带cookie(相当于yml中的allowCredentials)
headers.add(HttpHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS, "true");
// 允许在请求中携带的头信息(相当于yml中的allowedHeaders)
headers.add(HttpHeaders.ACCESS_CONTROL_EXPOSE_HEADERS, "*");
// 本次跨域检测的有效期(单位毫秒,相当于yml中的maxAge)
headers.add(HttpHeaders.ACCESS_CONTROL_MAX_AGE, MAX_AGE);
// 直接给option请求反回结果
if (request.getMethod() == HttpMethod.OPTIONS) {
response.setStatusCode(HttpStatus.OK);
return Mono.empty();
}
// 不是option请求则放行
return chain.filter(ctx);
};
}
}