一.概念
1.1 什么是Gateway网关?
- Gateway是在Spring生态系统之上构建的API网关服务,基于Spring 5,Spring Boot 2和Project Reactor等技术。
- Gateway旨在提供一 种简单而有效的方式来对API进行路由,以吸提供- 些强大的过滤器功能, 例如:熔断、限流、重试等
- SpringCloud Gateway的目标提供统一的路由方式且基 于Filter 链的方式提供了网关基本的功能,例如:安全,监控/指标, 和限流。
1.2 Spring Cloud Gateway特性
- 基于Spring Framework 5, Project Reactor和Spring Boot 2.0进行构建;
- 动态路由:能够匹配任何请求属性;
- 可以对路由指定Predicate (断言)和Filter (过滤器) ;
- 集成Hystrix的断路器功能;
- 集成Spring Cloud服务发现功能;
- 易于编写的Predicate (断言)和Filter (过滤器) ;
- 请求限流功能;
- 支持路径重写。
1.3 为什么选择GateWay?
1.4 Spring Cloud GateWay与Zuul的区别?
- zuul1.X是基于servlet阻塞式模型的,zuul2.X升级为使用netty和支持长连接
- GateWay主要是使用非阻塞异步的WebFlux框架,核心式基于Reactor的
与Spring5和SpringBoot整合好
1.5 什么是路由(Route)?
路由时构成网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为True则匹配该路由
1.6 什么是断言(Predicate)?
参考的是Java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由
1.7 什么是过滤(Filter)?
指的是Spring框架中GateWayFitle的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
1.8 GateWay工作流程
客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由,将其发送到GatewayWeb Handler。
Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post”)执行业务逻辑。
核心逻辑: 路由转发+执行过滤链
二.Gateway的使用步骤
2.1 导入依赖
<!--gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
2.2 Gateway配置文件
server:
port: 9527
eureka:
instance:
hostname: cloud-gateway-service
client: #服务提供者provider注册进eureka服务列表内
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能,利用微服务名进行路由
routes:
- id: payment_routh #payment_route #路由的ID,没有固定规则但要求唯一,建议配合服务名
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** # 断言,路径相匹配的进行路由
- id: payment_routh2 #payment_route #路由的ID,没有固定规则但要求唯一,建议配合服务名
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** # 断言,路径相匹配的进行路由
#- After=2020-02-21T15:51:37.485+08:00[Asia/Shanghai]
#- Cookie=username,zzyy
#- Header=X-Request-Id, \d+ # 请求头要有X-Request-Id属性并且值为整数的正则表达式
2.3 Gateway启动类
@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527
{
public static void main(String[] args) {
SpringApplication.run(GateWayMain9527.class, args);
}
}
2.4 效果
访问http://localhost:8001/payment/get/3 http://localhost:9527/payment/get/2
2.5 使用编码格式进行Gateway网关配置
- 添加配置类
@Configuration
public class GateWayConfig
{
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder)
{
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
// /guonei跳转到http://news.baidu.com/guonei
//path_routr01,为id
routes.route("path_route_atguigu",
r -> r.path("/guonei")
.uri("http://news.baidu.com/guonei")).build();
return routes.build();
}
}
- 启动测试,访问http://127.0.0.1:9527/guonei
三.动态路由
默认情况下Gateway会根据注册中心的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能
3.1 修改yml配置文件
- 开启discovery.locator.enabled 和修改uri为uri: lb://CLOUD-PAYMENT-SERVICE #使用服务名进行访问 并且开启负载均衡
server:
port: 9527
eureka:
instance:
hostname: cloud-gateway-service
client:
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
3.2 测试
四.Gateway 常用的 Predicate
请求要满足断言表达式判断为true才可访问,只要一个不符合就回访问不到服务
4.1 配置时间断言
在当前时间之后才可以访问
- appliction.yml添加时间断言
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- After=2021-02-03T11:38:08.300+08:00[Asia/Shanghai] #这个时间过后才可以访问
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2021-02-03T11:38:08.300+08:00[Asia/Shanghai] #这个时间过后才可以访问
- 在这个时间前访问会报404
4.2 配置Cookie断言
appliction.yml添加Cookie断言
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2021-02-03T11:38:08.300+08:00[Asia/Shanghai] #这个时间过后才可以访问
- Cookie=username,dessw
这里配置一个Cookie 通过命令框的CURL去访问,出现了负载均衡
-
在cmd输入curl http://127.0.0.1:9527/payment/lb直接访问报404
-
在cmd输入curl http://127.0.0.1:9527/payment/lb --cookie "username=dessw"添加cookie访问成功
4.3 配置Header断言
appliction.yml添加Cookie断言
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- After=2021-02-03T11:38:08.300+08:00[Asia/Shanghai] #这个时间过后才可以访问
- Cookie=username,dessw
- Header=X-Request-Id, \d+ #请求头中要有X-Request-Id这个属性,值是一个整数
启动测试
当是一个负数时
当是一个正数时
4.4 总结
- Predicate就是为了实现一组匹配规则,让请求过来找到对应的Route进行处理。
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
#uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
#- After=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]
#- Cookie=username,zhangshuai #并且Cookie是username=zhangshuai才能访问
#- Header=X-Request-Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式
#- Host=**.atguigu.com
#- Method=GET
#- Query=username, \d+ #要有参数名称并且是正整数才能路由
五.Gateway的filter
指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,路由过滤器只能指定路由进行使用。
Spring Cloud Gateway内置了多种路由过滤器,他们都由GatewayFilter的工厂类来产生
5.1 创建Gateway filter配置类
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter,Ordered
{
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain)
{
log.info("***********come in MyLogGateWayFilter: "+new Date());
String uname = exchange.getRequest().getQueryParams().getFirst("uname");
if(uname == null)
{
log.info("*******用户名为null,非法用户,o(╥﹏╥)o");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder()
{
return 0;
}
}
5.2 启动测试
- 不带参数
- 添加参数