GateWay网关
Spring Cloud 1.x版本中使用的是 Zuul 网关。但是在 2.x 中，Spring Cloud自己研发了一个网关替代Zuul。
GateWay 是原来的Zuul1.x版本的替代。
Gateway 是Spring生态系统之上构建的API网关服务，基于Spring 5、SpringBoot 2、Project Reactor等技术。
Gateway旨在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤器功能，例如：熔断、限流、重试等。
Spring Cloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本功能，例如：安全、监控/指标、限流。
Spring Cloud Gateway是基于WebFlux框架实现的，而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。异步非阻塞模型。
特点：
- 基于Spring 5、Project Reactor、Spring Boot2进行构建
- 动态路由：能够匹配任何请求属性
- 可以对路由指定Predicate（断言）和Filter（过滤器）
- 集成Hystrix的断路器功能
- 集成Spring Cloud服务发现功能
- 易于编写的Predicate（断言）和Filter（过滤器）
- 请求限流功能
- 支持路径重写
Gateway和Zuul的区别：
在SpringCloud F版正式版之前，Spring CLoud推荐的网关时Netflix提供的Zuul
- Zuul 1.x是一个一基于阻塞IO的API Gateway
- Zuul 1.x基于Servlet2.5使用阻塞架构，它不支持任何长连接（如WebSocket），Zuul的设计模式和Nginx比较像，每次IO操作都是从工作线程中选择一个执行，请求线程被阻塞到工作线程完成。但是差别是Nginx用C++实现，Zuul用Java实现，而JVM本身会有第一次加载较慢的情况，使得Zuul的性能相对较差
- Zuul 2.x理念更先进，想基于Netty非阻塞和支持长连接，但是Spring Cloud目前还没有进行整合。Zuul 2.x性能较Zuul 1.x有较大提升。在性能方面，根据官方提供的基准测试，Spring Cloud Gateway的RPS（每秒请求数）是Zuul的1.6倍
- Spring Cloud Gateway建立在Spring Framework 5、Project Reactor、Spring Boot2之上，使用非阻塞API
- Spring Cloud Gateway还支持WebSocket，并且与Spring紧密集成拥有更好的开发体验
路由Route：路由是构建网关的基本模块，它由ID、目标URI、一系列的断言和过滤器组成，如果断言为true则匹配该路由。
断言Predicate：开发人员可以匹配Http请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由
过滤Filter：指的是Spring框架中GatewayFilter的实例，使用过滤器可以在请求被路由前或者之后对请求进行修改
客户端向Spring Cloud Gateway发出请求，然后在Gateway Handler Mapping中找到与请求相匹配的路由，将其发送到Gateway Web Handler。
Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。
Filter在“Pre”类型的过滤器（发送代理请求之前）可以做参数校验、权限校验、流量监控、日志输出、协议转换等。
在“Post“类型的过滤器（发送代理请求之后）可以做响应内容、响应头的修改、日志的输出、流量监控等有着非常重要的作用。
环境搭建
创建maven工程
添加pom依赖
<dependencies><!-- 加入gateway的依赖、eureka客户端依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-eureka-client</artifactId></dependency><!-- gateway模块中不能引入 spring-boot-starter-web，否则会和gateway的webflux冲突而报错 --><!-- 移除spring-boot-starter-web、spring-boot-starter-actuator依赖 --><dependency><groupId>com.study</groupId><artifactId>cloud-api-commons</artifactId><version>1.0-SNAPSHOT</version></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></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId></dependency></dependencies>
- 编写配置文件 ```yaml server: port: 9527
spring: application: name: cloud-gateway cloud:
配置网关映射
gateway:
routes:
- id: payment_route # 路由的ID，没有固定规则，但要求唯一，建议配合服务名
uri: http://localhost:8001 # 匹配后提供服务的路由地址，将请求转发到8001支付服务
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_route2
uri: http://localhost:8001
predicates:
- Path=/payment/lb/**
eureka: instance: hostname: cloud-gateway-service client: register-with-eureka: true fetch-registry: true service-url: defaultZone: http://localhost:7001/eureka
4.
编写主启动类
```java
@SpringBootApplication
public class GatewayMain9527 {
public static void main(String[] args) {
SpringApplication.run(GatewayMain9527.class, args);
}
}
路由Route
路由配置
路由有两种配置方式：在yaml中配置、使用代码注入RouteLocator的Bean。
使用编码方式配置路由：
向Spring 容器中注入 RouteLocator的Bean，可以注入多个。也可以在一个Bean中做多个转发。
@Configuration
public class GateWayConfig {
@Bean
public RouteLocator customerRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes
// http://localhost:9527/guonei 转发到（地址栏不变） http://news.baidu.com/guonei
.route("path_route_study",
r -> r.path("/guonei").uri("http://news.baidu.com/guonei"))
// http://localhost:9527/guoji 转发到（地址栏不变） http://news.baidu.com/guoji
.route("path_route_study2",
r -> r.path("/guoji").uri("http://news.baidu.com/guoji"));
return routes.build();
}
@Bean
public RouteLocator customerRouteLocator2(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes
// http://localhost:9527/mil 转发到（地址栏不变） http://news.baidu.com/mil
.route("path_route_study",
r -> r.path("/mil").uri("http://news.baidu.com/mil"))
// http://localhost:9527/game 转发到（地址栏不变） http://news.baidu.com/game
.route("path_route_study2",
r -> r.path("/game").uri("http://news.baidu.com/game"));
return routes.build();
}
}
动态路由
默认情况下，Gateway会根据注册中心注册的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能。
如果指定的服务名下有多个服务器，还能进行负载均衡。
配置方式：
使用
spring.cloud.gateway.discovery.locator.enable=true开启从注册中心动态创建路由的功能将
spring,cloud.gateway.routes中的uri配置为lb://服务名，即可进行负载均衡
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名进行路由
routes:
- id: payment_route # 路由的ID，没有固定规则，但要求唯一，建议配合服务名
# uri: http://localhost:8001 # 匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE # 匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_route2
# uri: http://localhost:8001
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/lb/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://localhost:7001/eureka
断言Predicate
Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。Spring Cloud Gateway包括许多内置的Route Predicate工厂，所有这些Predicate都与Http请求的不同属性匹配，多个Route Predicate工厂可以进行组合（使用的 “与” 逻辑）。
断言处理工厂接口：RoutePredicateFactory，所有的断言处理工厂都实现了该接口，例如：PathRoutPredicateFactory、AfterRoutePredicateFactory、BeforeRoutePredicateFactory等等。
After断言配置示例：
After路由断言参数：java的ZonedDateTime类型的时间。在该时间之后才生效。
spring:
cloud:
gateway:
routes:
- id: payment_route2
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/lb/**
# 配置After路由，路由参数为ZonedDateTime时间
- After=2021-03-24T11:06:19.282+08:00[Asia/Shanghai]
获取ZonedDateTime时间：
ZonedDateTime time = ZonedDateTime.now();
System.out.println(time);
Before断言配置：
predicates:
- Before=2021-03-24T11:06:19.282+08:00[Asia/Shanghai]
Between断言配置：
参数为两个ZonedDateTime时间，以逗号分隔
predicates:
- Before=2021-03-24T10:06:19.282+08:00[Asia/Shanghai],2021-03-24T11:06:19.282+08:00[Asia/Shanghai]
Cookie断言配置：
第一个参数：Cookie名称
第二个参数：Cookie值的正则表达式
predicates:
- Cookie=chocolate, ch.p
使用curl命令发送带有cookie的请求：
curl http://localhost:9527/payment/lb --cookie chocolate=chap
Header断言配置：
第一个参数：Header名称
第二个参数：header值的正则表达式
predicates:
- Header=X-Request-Id, \d+
使用curl命令发送带有header的请求：
curl http://localhost:9527/payment/lb -H "X-Request-Id:111"
Host断言配置：
参数：hostname表达式列表，列表中每个元素以逗号分隔。表达式为 Ant-Style 匹配规则。
predicates:
- Host=**.somehost.org,**.anotherhost.org
Ant-Style匹配规则：
| 路径通配符 | 描述 |
|---|---|
| ? | 匹配任何单字符 |
| * | 匹配0或任意数量的字符 |
| ** | 匹配0或者更多的目录 |
Method断言配置：
参数：Http请求方式列表
predicates:
- Method=GET,POST
其他还有：Path断言、Query断言。
过滤器Filter
路由过滤器可用于修改进入的Http请求和返回的Http响应，路由过滤器只能指定路由进行使用。
Spring Cloud Gateway内置了多种过滤器，他们都由GatewayFilter的工厂类产生。
过滤器生命周期：
- pre：业务逻辑之前
- post：业务逻辑之后
过滤器种类：
- GatewayFilter：单一
- GlobalFilter：全局
过滤器配置：
spring:
cloud:
gateway:
routes:
- id: add_request_header_route
uri: https://example.org
predicates:-
Path=/red/{segment}
filters:
- AddRequestHeader=X-Request-Red, Blue-{segment} # 会在匹配的请求头上面加一个请求头X-Request-Red，值为Blue-{segment}
自定义全局过滤器：
自定义类，实现GlobalFilter、Order接口，并实现其对应的抽象方法。
在filter方法中，使用
chain.filter进行放行。将该类加入Spring容器。
@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 username = exchange.getRequest().getQueryParams().getFirst("username");
if(username == null) {
log.info("username为null，用户非法");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange); // 合法用户放行
}
@Override
public int getOrder() {
return 0; // 加载优先级顺序，数字越小优先级越高
}
}
若有收获，就点个赞吧
0 人点赞
