Gateway网关
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0和Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API路由管理方式
为什么需要网关
Gateway网关就是我们服务的守门神,所有微服务的统一入口
网关的核心功能:
- 请求路由
- 权限控制
- 限流
网关架构图:
**权限控制:**网关作为微服务入口,需要校验用户是否有请求资格,如果没有则进行拦截。
**路由和负载均衡:**一切请求都必须先经过ateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
**限流:**当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。在SpringCloud中网关的实现包括两种:
- gateway
- zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。
Gateway基本实现
实现步骤:
- 创建SpringBoot项目,引入网关依赖
- 编写基础配置和路由规则
- 启动网关服务进行测试
-
创建gateway服务,引入依赖
创建服务,创建一个api-gateway的版块,导入相关依赖
<dependencies> <!--gateway网关--> <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> </dependencies>
-
编写基础配置和路由规则
编写api-gateway的application.yaml配置文件
基本版本:
server: port: 7000 spring: application: name: api-gateway cloud: nacos: discovery: server-addr: 127.0.0.1:8848 gateway: discovery: locator: enabled: true # 让gateway可以发现nacos中的微服务 routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务] - id: product_route # 当前路由的标识, 要求唯一 uri: http://localhost:8081/ # 请求要转发到的地址 order: 1 # 路由的优先级,数字越小级别越高 predicates: # 断言(就是路由转发要满足的条件) - Path=/product-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发 filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改 - StripPrefix=1 # 转发之前去掉1层路径
高级版本:
server: port: 7000 spring: application: name: api-gateway cloud: nacos: discovery: server-addr: 127.0.0.1:8848 gateway: discovery: locator: enabled: true # 让gateway可以发现nacos中的微服务 routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务] - id: product_route # 当前路由的标识, 要求唯一 uri: lb://service-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均 衡策略 order: 1 # 路由的优先级,数字越小级别越高 predicates: # 断言(就是路由转发要满足的条件) - Path=/product-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发 filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改 - StripPrefix=1 # 转发之前去掉1层路径
将符合Path规则的一切请求,都带力道uri参数指定的地址
-
启动网关服务进行测试
总结:
网关搭建步骤:
- 创建项目,引入nacos服务发现和gateway依赖
- 配置application.yaml,包括服务基本信息,nacos地址,路由
路由配置包括:
- 路由id:路由的唯一标识
- 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
- 路由断言(predicates):判断路由规则
- 路由过滤器(filters):对请求或响应做处理
断言工厂
在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactoyt
类来处理的,像这样的断言工厂在SpringCloudGateway还有十几个
名称 | 说明 | 示例 |
---|---|---|
After | 某个时间点后的请求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 某个时间点前的请求 | - Before=2037-01-20T17:42:47.789-07:00[America/Denver] |
Between | 某两个时间点之间的请求 | - Before=2037-01-20T17:42:47.789-07:00[America/Denver],2037-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 请求必须包含某些cookie | - Cookie=chocolate, ch.p |
Header | 请求必须包含某些header | - Header=X-Request-ld, d+ |
Host | 请求必须是访问某个host(域名) | - Host=.somehost.org,.anotherhost.org |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须复合指定规则 | - Path=/red/{segment;,/blue/** |
Query | 请求参数必须包含指定参数 | - Query=name,Jack或者 - Query=name |
RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 |
过滤器工厂
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的相应处理
路由过滤器的种类
Spring提供了31中不同的路由过滤工厂
名称 | 说明 |
---|---|
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除一个响应头 |
RequestRateLimiter | 限流请求的流量 |
请求头过滤器
以AddRequestHeader为例演示:
只需要修改gateway服务的application.yaml文件,添加路由过滤即可:
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enable: true # 让gateway可以发现nacos中的微服务
routes:
- id: product_route
uri: lb://service-product
order: 1
predicates:
- Path=/product-serv/**
filters:
- AddRequestHeader=msg,GGBond! #添加请求头
默认过滤器
如果要对所有的路由都生效,则可以将过滤工厂写道default下。格式如下:
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enable: true # 让gateway可以发现nacos中的微服务
routes:
- id: product_route
uri: lb://service-product
order: 1
predicates:
- Path=/product-serv/**
default-filters: #默认过滤器,会对所有的路由请求都生效
- AddRequestHeader=msg,GGBond! #添加请求头
全局过滤器
网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现
全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter接口
public interface GlobalFilter{
/*
处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
@param exchange 请求上下文,里面可以获取Request、Response等信息
@param chain 用来把请求委托给下一个过滤器
@return {@code Mono<Void>} 返回标示当前过滤器业务结束
*/
Mono<void> filter(ServerWebExchange exchange,GatewayFilterChain chain)
}
在filter中编写自定义逻辑,可以实现下列功能
- 登陆状态判断
- 权限校验
- 请求限流等
自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否authorization
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:在gateway中定义一个过滤器
@Order(-1)
@Component
public class AuthorizeFilter implements GlovalFilter{
@Override
public Mono<Void> filter(ServerWebExchange exchange,GatewayFilterChain chain){
// 1.获取请求参数
MultiValueMap<String,String> params = exchange.getRequest().getQueryParams();
String auth = params.getFirst("authorization");
// 2.校验
if("admin".equals(auth)){
return chain.filter(exchange);
}
// 拦截
// 禁止访问
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
// 结束处理
return exchange.getResponse().setComplete();
}
}
// 发送请求测试
// http://localhost:7000/product-serv/product/6?authorization=admin
过滤器执行顺序
请求进入网关会碰到三类过滤器: 当前路由的过滤器、DefaultFilter、GlobalFilter请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中排序后依次执行每个过滤器:
排序的规则:
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前(order值最小为-1)
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行
浏览器同源策略
1995年,同源政策由 Netscape 公司引入浏览器。目前,所有浏览器都实行这个政策
最初,它的含义是指,A网页设置的 Cookie,B网页不能打开,除非这两个网页"同源”。所谓"同源"指的是"三个相同”。
- 协议相同
- 域名相同
- 端口相同
举例:
http://www.example.com/dir/page.html网址
- 协议是http://
- 域名是www.example.com
- 端口是80(默认端口可以省略)
它的同源情况如下
http://www.example.com/dir2/other.html: 同源
http://example.com/dir/other.html: 不同源(域名不同)
http://v2.www.example.com/dir/other.html: 不同源(域名不同)
http://www.example.com:81/dir/other.html: 不同源(端口不同)
同源目的
同源政策的目的,是为了保证用户信息的安全,防止恶意的网站窃取数据。
设想这样一种情况:A网站是一家银行,用户登录以后,又去浏览其他网站。如果其他网站可以读取A网站的 Cookie,会发生什么?
很显然,如果 Cookie 包含隐私(比如存款总额) ,这些信息就会泄漏。更可怕的是,Cookie 往往用来保存用户的登录状态,如果用户没有退出登录,其他网站就可以冒充用户,为所欲为。因为浏览器同时还规定,提交表单不受同源政策的限制。
由此可见,"同源政策"是必需的,否则 Cookie 可以共享,互联网就毫无安全可言了
跨域问题解决方案
跨域:域名不一致就是跨域 ,主要包括:
- 域名不同:www.taobao.com和www.taobao.org和www.jd.com和shouji.jd.com
- 域名相同:端口不同:localhost:8080和localhost:8081
跨域问题:浏览器进制请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
CORS
CORS是跨源资源分享(Cross-Origin Resource Sharing)的缩写。它是W3C标准,是跨源AJAX请求的根本解决方法。相比JSONP只能发GET请求,CORS允许任何类型的请求
在gateway服务的application.yaml文件中,添加下面的配置
spring:
cloud:
gateway:
globalcors: #全局的跨域处理
add-to-simple-url-handler-mapping: true #解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: #语序哪些网站的跨域请求
- "http://localhost:8090"
allowedMethods: #语序的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowerHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检验的有效期