目录
一、什么是网关?为什么选择 Gateway?
二、Gateway 网关
2.1、搭建网关服务
1.创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖
2.编写nacos地址和路由配置
2.2、路由断言工厂PredicateFactory
2.3、路由过滤器 GatewayFilter
1.具体实现
2.过滤器的作用是什么
3.defaultFilters的作用是什么
2.4、全局过滤器 GlobalFilter
1.具体实现
2.全局过滤器的作用
2.5、过滤器执行顺序
执行规则
2.5、Gateway 跨域问题处理
一、什么是网关?为什么选择 Gateway?
网关功能如下:
- 身份认证和权限校验
- 服务路由、负载均衡
- 请求限流
在 Spring Cloud 中网关的实现包含两种:
- Gateway(推荐):是基于 Spring5 中提供的 WebFlux ,属于响应式编程的实现,具备更好的性能,因此作为比较推荐实现网关的方式。
- Zuul:是基于 Servlet 的实现,属于阻塞式编程
二、Gateway 网关
2.1、搭建网关服务
主要分为以下几个步骤:
1.创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现依赖
<!--网关依赖-->
<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.编写nacos地址和路由配置
server:
port: 10010 # 网关端口
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由 id,自定义,只要唯一即可
uri: lb://userservice # 路由的目标地址 lb 就是负载均衡,后面跟服务名
predicates: #路由断言
- Path=/user/** # 这个是按照路径匹配,只要以 /user/ 开头就符合要求
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
路由配置解释如下:
- 路由id:路由的唯一标示
- 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
- 路由断言(predicates):判断路由的规则,
- 路由过滤器(filters):对请求或响应做处理
工作原理:
2.2、路由断言工厂PredicateFactory
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件,例如Path=/user/**是按照路径匹配,这个规则是 org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的。
PredicateFactory就是用来读取用户定义的断言条件,对请求做出判断
Path=/user/**的含义就是路径是以/user开头的就认为是符合的
Spring提供了11种基本的Predicate工厂(并不需要都记下来,需要的时候去官网上 copy 即可)
名称 | 说明 | 示例 |
After | 是某个时间点后的请求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 是某个时间点之前的请求 | - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] |
Between | 是某两个时间点之前的请求 | - Between=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-Id, \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 | 权重处理 |
2.3、路由过滤器 GatewayFilter
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理
Spring提供了31种不同的路由过滤器工厂,这些需要什么都可以直接去官网上copy,不用刻意去记~
例如以下几个常用的:
- AddRequestHeader:给当前请求添加一个请求头
- RemoveRequestHeader:移除请求中的一个请求头
- AddResponseHeader:给响应结果中添加一个响应头
- RemoveResponseHeader:从响应结果中移除有一个响应头
案例:给所有进入 userservice 的请求添加一个请求头:Truth=cyk is freaking awesome!
1.具体实现
在gateway中修改application.yml文件,给userservice的路由添加过滤器
spring:
cloud:
gateway:
routes: # 网关路由配置
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
filters: # 过滤器
- AddRequestHeader=Truth, cyk is freaking awesome! # 添加请求头
如果要对所有的路由都生效,则可以将过滤器工厂写到default下,格式如下
server:
port: 10010 # 网关端口
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848 # nacos 地址
gateway:
routes: # 网关路由配置
- id: user-service # 路由 id,自定义,只要唯一即可
uri: lb://userservice # 路由的目标地址 lb 就是负载均衡,后面跟服务名
predicates: #路由断言
- Path=/user/** # 这个是按照路径匹配,只要以 /user/ 开头就符合要求
filters: # 过滤器
- AddRequestHeader=Truth, cyk is freaking awesome! # 添加请求头(还有很多种添加方式,都可以去官网上看)
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
default-filters: # 默认过滤器,会对所有的路由请求都生效
- AddRequestHeader=Truth, cyk is freaking awesome! # 添加请求头
2.过滤器的作用是什么
- 对路由的请求或响应做加工处理,比如添加请求头
- 配置在路由下的过滤器只对当前路由的请求生效
3.defaultFilters的作用是什么
- 对所有路由都生效的过滤器
2.4、全局过滤器 GlobalFilter
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样,区别在于GatewayFilter通过配置定义,处理逻辑是固定的,而GlobalFilter的逻辑需要自己写代码实现。
1.具体实现
- 实现 GlobalFilter 接口,重写 filter 方法
- 添加 @Order 注解或实现 Ordered 接口
- 编写处理逻辑
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Order(-1) //标明处理顺序,否则过滤顺序是未知的
@Component
public class AuthorizeFilter implements GlobalFilter {
/**
*处理当前请求,有必要的话通过 GatewayFilterChain 将请求交给下一个过滤器来处理
* @param exchange 请求上下文,可以获取到 Request、Response 等信息
* @param chain 用来把请求委托给下一个过滤器
* @return 表示当前过滤器业务结束
*/
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//1.获取请求参数
MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
//2.获取 authorization 参数
String auth = params.getFirst("authorization");
//3.校验(自定义业务逻辑进行校验,这里以校验参数是否一致为例)
if("cyk".equals(auth)) {
//放行,交给下一个过滤器
return chain.filter(exchange);
}
//4.拦截反馈(这里禁止访问FORBIDDEN为例,对应状态码 403)
exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
//结束处理
return exchange.getResponse().setComplete();
}
}
2.全局过滤器的作用
对所有路由都生效的过滤器,并且可以自定义处理逻辑
2.5、过滤器执行顺序
请求进入网关会碰到三类过滤器(当前路由的过滤器、DefaultFilter、GlobalFilter),然后合并到一个过滤器集合中,排序后一次执行每一个过滤器,那么他的一个执行顺序是怎样的呢?
执行规则
1.order值越小,优先级越高(GlobalFilter由我们自定义,路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增)
2.当order值一样时,顺序是defaultFilter > 路由过滤器 > 全局过滤器。
2.5、Gateway 跨域问题处理
跨域:域名不一致就是跨域,主要包括:
- 域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
- 域名相同,端口不同:localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
解决方案:CORS
网关处理跨域采用的同样是CORS方案,并且只需要简单配置即可实现(这些东西不用记住,需要的时候 CV 就可以)
spring:
cloud:
gateway:
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
- "http://www.cyk.com"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期(为例减少性能损耗,在有效时间内,浏览器将不在发起询问,直接放行通过)