1.概述
Gateway是在spring生态系统之上构建的API网关服务,基于spring 5,springboot2和Project Reactor等技术。gateway提供一种简单而有效的方式来对API进行路由,以及提供一些强大的过滤器功能。
gateway特性
动态路由:能够匹配任何请求属性
可以对路由指定Predicate和Filter过滤器
集成Hstrix的断路器功能
集成springcloud的服务发现功能
易于编写的Predicate和Filter
请求限流功能
支持路径重写
zuul1.x和gateway区别
zuul 1.x是一个基于阻塞I/O的api gateway
zuul 1.x基于servlet 2.5使用阻塞架构,它不支持任何长连接(如webSocket)
gateway建立在spring framework 5,project reactor和spring boot2上,使用非阻塞spi
gateway支持websocket
2.三大核心组件
路由(Route):路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由
断言(Predicate):参考的是java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由
过滤(Filter):指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
3.用法
新建cloud-gateway-gateway9527
<dependencies>
<!--新增gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>com.atguigu.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
yml
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径相匹配的进行路由
- id: payment_routh2
uri: http://localhost:8001
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client:
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
此时,通过网关对服务端访问成功http://localhost:9527/payment/get/1
相当于利用网关隐藏了服务端口,除了自己服务的路由转发,可以转发其他的网页(例如百度)
新建配置类,这样就可以通过访问/guonei访问百度了
@Configuration
public class GateWayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("path_rote_atguigu", r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();
return routes.build();
}
}
通过微服务名实现路由转发
开启路由转发
server:
port: 9527
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/** #断言,路径相匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client:
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
然后就可以通过服务名进行路由转发
常用的Route Predicate
- Path=/payment/lb/** #断言,路径相匹配的进行路由
- After=2022-08-17T11:29:40.179+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+ #要有参数名称并且是正整数才能路由
过滤器的使用
过滤器用于修改 进入的http请求和返回响应的http,路由过滤器只能指定路由使用
springcloud dateway的过滤器:
在业务逻辑之前
在业务逻辑之后
单一过滤器
全局过滤器
例如过滤器工厂会在匹配的请求头加上一对请求头,名为X-Request-Id的值为1024
filters:
-AddRequestParameter=X-Request-Id,1024
自定义过滤器,创建一个类实现GlobalFilter接口,对请求路径必须添加一个uname属性,否则拦截。
@Component
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("come in MyloggatewayFilter"+new Date());
String uname=exchange.getRequest().getQueryParams().getFirst("uname");
if (uname==null){
System.out.println("error");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}