七、Gateway新一代网关
程序员文章站
2022-06-13 13:49:44
...
前言
一、概述
1、是什么
SpringCloud GateWay 是 SpringCloud 的一个全新项目，基于 Spring5.0 + SpringBoot2.0 和 Project Reactor 等技术开发的网关，旨在为微服务架构提供一种简单有效的统一的API路由的管理方式。
SpringCloud GateWay 作为SpringCloud 生态系统中的网关，目的是替代Zuul，在 SpringCloud 2.0 以上版本中，没有对新版本的Zuul 2.0 以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x 非 Reactor 模式的老版本。而为了提升网关的性能，SpringCloud GateWay 是基于 WebFlux 框架实现的，而 WebFlux 框架底层则使用了高性能的 Reactor 模式通信框架 Netty。
SpringCloud GateWay 的目标提供统一的路由方式且基于 Filter 链的方式提供了网关基本的功能，例如：安全、监控/指标、和限流等。
2、作用
3、网关在微服务架构中的位置
4、为什么用GateWay
一方面因为Zuul1.0已经进入了维护阶段。
GateWay是基于异步非阻塞模型上进行开发的，性能方面不需要担心，虽然Netflix早就发布了最新的Zuul2.x，但Netflix相关组件都宣布进入维护期。
5、GateWay特点
6、三大核心概念
Route（路由）：路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配该路由。
Predicate（断言）：参考的是java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由。
Filter（过滤）：指的是Spring框架中GatewayFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改。
工作流程图：
说明：
1、客户端向 SpringCloud GateWay 发出请求。然后在GateWay Handler Mapping 中找到与请求相匹配的路由，将其发送到GateWay Web Handler。
2、Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前（“pre”）或之后（“post”）执行业务逻辑。
3、Filter 在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改、日志的输出、流量监控等有着非常重要的作用。
二、环境搭建
1、新建一个Module
项目名：cloud-gateway-gateway9527
1、pom配置
<!--注意：是不需要web包和actuator包依赖的，否则就会报错-->
<dependencies>
<!--新增gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--hystrix相关-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</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>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
</dependency>
<dependency>
<groupId>com.itan</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>1.0-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
</dependencies>
2、配置yml
server:
port: 9527
spring:
application:
name: gateWay
eureka:
# 设置服务名称信息（自定义）并设置访问路径可以显示 IP 地址
instance:
instance-id: gateWay9527
prefer-ip-address: true
client:
# 表示是否将自己注册进EurekaServer默认为true
register-with-eureka: true
# 是否从EurekaServer抓取已有的注册信息，默认为true。单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
# 客户端注册进 eureka 服务列表内
service-url:
defaultZone: http://eureka7001.com:7001/eureka
3、主启动类
@SpringBootApplication
@EnableEurekaClient
public class GateWay9527 {
public static void main(String[] args) {
SpringApplication.run(GateWay9527.class,args);
}
}
2、网关做路由映射
对cloud-provider-payment8001进行映射，让访问8001服务不用暴露8001服务的端口
修改yml，添加对8001服务的映射
server:
port: 9527
spring:
application:
name: gateWay
cloud:
gateway:
routes:
# - id可以配置多个
- id: payment_routh1 #路由的ID，没有固定规则，但要求唯一，建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/getOne/** #断言，路径相匹配的进行路由
- id: payment_routh2 #路由的ID，没有固定规则，但要求唯一，建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/timeout/** #断言，路径相匹配的进行路由
eureka:
# 设置服务名称信息（自定义）并设置访问路径可以显示 IP 地址
instance:
instance-id: gateWay9527
prefer-ip-address: true
client:
# 表示是否将自己注册进EurekaServer默认为true
register-with-eureka: true
# 是否从EurekaServer抓取已有的注册信息，默认为true。单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
# 客户端注册进 eureka 服务列表内
service-url:
defaultZone: http://eureka7001.com:7001/eureka
3、测试
1、启动注册中心7001
2、启动cloud-provider-payment8001服务生产者
3、启动网关GateWay9527服务
4、没有添加网关之前：http://localhost:8001/payment/getOne
5、添加网关之后：http://localhost:9527/payment/getOne
4、网关路由两种配置方式
方式一：
方式二：
5、代码中配置
新建一个配置类：GateWayConfig
@Configuration
public class GateWayConfig {
/**
* 自定义路由
* @param routeLocatorBuilder
* @return
*/
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
/**
* route有两个参数，第一个表示路由id（自定义，不能重复），第二个是函数式接口
* r.path("匹配到的地址").uri("相匹配后要转到的地址")
*/
routes.route("route1",
r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();
return routes.build();
}
}
1、测试
1、重启9527服务
2、在浏览器输入网址http://localhost:9527/guonei，成功转换到国内百度地址
三、动态路由
1、说明
默认情况下Gateway会根据注册中心的服务列表，以注册中心上微服务名为路径创建动态路由进行转发，从而实现动态路由的功能
2、实现
1、修改GateWay9527的yml配置文件
注：uri的协议为
lb，表示启用Gateway的负载均衡功能。lb://serviceName是spring cloud gateway在微服务中自动为我们创建的负载均衡uri
# 将uri地址由http://localhost:8001改为lb://CLOUD-PAYMENT-SERVICE
server:
port: 9527
spring:
application:
name: gateWay-service
cloud:
gateway:
discovery:
locator:
enabled: true # 开启从注册中心动态创建路由功能，利用微服务名进行路由
routes:
# - id可以配置多个
- id: payment_routh1 #路由的ID，没有固定规则，但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/getOne/** #断言，路径相匹配的进行路由
- id: payment_routh2 #路由的ID，没有固定规则，但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/timeout/** #断言，路径相匹配的进行路由
eureka:
# 设置服务名称信息（自定义）并设置访问路径可以显示 IP 地址
instance:
instance-id: gateWay9527
prefer-ip-address: true
client:
# 表示是否将自己注册进EurekaServer默认为true
register-with-eureka: true
# 是否从EurekaServer抓取已有的注册信息，默认为true。单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
# 客户端注册进 eureka 服务列表内
service-url:
defaultZone: http://eureka7001.com:7001/eureka
1、启动注册中心7001
2、启动cloud-provider-payment8001服务生产者
3、启动cloud-provider-payment8002服务生产者
4、启动网关GateWay9527服务
5、访问http://localhost:9527/payment/getOne，会发现端口会不停的切换
四、Predicate
1、是什么
启动9527服务后，会发现如下一些信息
2、Route Predicate Factories说明
Spring Cloud GateWay 将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
它包括许多内置的Route Predicate工厂，所有这些Predicate都与HTTP请求的不同属性匹配。多个Route Predicate工厂可以进行组合。
它在创建Route对象时，使用RoutePredicateFactory创建Predicate对象，Predicate可以赋值给Route。它包含许多内置的Route Predicate Factories。
3、常用的Route Predicate
1、After Route Predicate
在设定的时间之后才能访问到，在之前无法访问
时间获取的方法：
public static void main(String[] args) {
//获取时区
ZonedDateTime zonedDateTime = ZonedDateTime.now();
System.out.println(zonedDateTime);
//2020-11-04T22:49:28.962+08:00[Asia/Shanghai]
}
yml中配置：
发现在23.06时访问这个接口报错不存在，原因是设置了访问时间，只允许在23:07:42之后才能访问到
2、Before Route Predicate
在设定的时间之前才能访问到，在之后无法访问，配置同上
3、Between Route Predicate
在设定的时间段之间才能访问，其他时间无法访问，两个时间之间用逗号隔开
4、Cookie Route Predicate
Cookie Route Predicate需要设置两个参数，一个是Cookie Name，一个是正则表达式。路由规则会通过获取对应的Cookie Name值和正则表达式去匹配，如果匹配上就会执行路由，如果没有匹配上就不执行。
5、Header Route Predicate
Header Route Predicate需要设置两个参数一个是属性名（请求头参数），一个是正则表达式，属性值和正则匹配就执行路由
6、Host Route Predicate
地址匹配就执行路由
7、Method Route Predicate
设置请你方式（GET/POST）
8、Path Route Predicate
9、Query Route Predicate
一个是参数名，一个是正则表达式
五、Filter
1、是什么
路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用，Spring Cloud GateWay内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生。
2、生命周期
3、种类
常用的GatewayFilter：AddRequestParameter
4、自定义过滤器
自定义全局GlobalFilter需要实现两个接口
GlobalFilter，Ordered作用：
@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("username");
if(StringUtils.isEmpty(uname)){
log.info("*****用户名为Null 非法用户,(┬＿┬)");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//给人家一个回应
return exchange.getResponse().setComplete();
}
//放行
return chain.filter(exchange);
}
@Override
public int getOrder() {
//设置优先级
return 0;
}
}
启动服务测试即可
推荐阅读
-
详解spring cloud构建微服务架构的网关(API GateWay)
-
Spring Cloud Gateway网关XSS过滤Filter
-
详解spring cloud构建微服务架构的网关(API GateWay)
-
Spring Cloud Gateway 服务网关快速实现解析
-
Spring Cloud Gateway网关XSS过滤Filter
-
Springcloud GateWay网关配置过程图解
-
Spring Cloud Gateway 服务网关快速实现解析
-
荐 SpringCloud（5）--服务网关（GateWay）
-
Gateway网关
-
包容网关 Inclusive Gateway