Gateway网关(*)
什么是网关
# 1.说明
- 网关统一服务入口,可方便实现对平台众多服务接口进行管控。
- 网关 = 路由转发 + 过滤器
路由转发:接收一切外界请求,转发到后端的微服务上去
过滤器:在服务网关中可以完成一系列的横切功能,例如权限校验、限流及监控等等,这些都可以用过滤器来完成
# 网关作用
- 1.网关统一所有微服务入口
- 2.网关可以实现请求路由转发,以及负载均衡
- 3.访问服务的身份认证、防报文重发、防数据篡改、功能调用的业务鉴权、响应数据的脱敏、流量与并发控制,甚至基于API调用的计量或计费等
- 4.网关可以解决微服务中通用代码的冗余问题(如权限控制,流程监控,限流等)
- 网关组件在微服务中架构
服务网关组件
zuul
# 官网:https://github.com/Netflix/zuul/wiki
- zuul是从设备到网站到Netflix流媒体应用程序后端的所有请求的前门。作为一个边缘服务应用程序,zuul被构建为支持动态路由、监视、弹性和安全性
# zuul版本说明
- 目前zuul组件已经从1.0更新到2.0,但是springcloud官方不再推荐使用zuul2.0,依然支持zuul2.0
# springcloud 官方集成zuul文档
- https://cloud.spring.io/spring-cloud-netflix/2.2.x/reference/html/#netflix-zuul-starter
gateway(spring)
# 官网:http://spring.io/projects/spring-cloud-gateway
- 这个项目提供了一个在springmvc之上构建API网关的库。spring-cloud-gateway提供一种简单而有效的方法来路由到api,并为api提供横切关注点,比如:安全性、监控、度量和弹性
# 特性
- 基于springboot2.x 和 spring webFlux 和 Reactor 构建响应式异步非阻塞IO模型
- 动态路由
- 请求过滤
1.开发网关动态路由
- 添加依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 健康检查 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!-- consul 注册中心 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>
<!-- gateway 网关 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
</dependencies>
- 基于配置文件方式配置gateway(推荐)
server:
port: 8999
spring:
application:
name: GATEWAY
cloud:
consul:
host: localhost
port: 8500
gateway:
routes:
# 路由唯一标识
- id: user_router
# 指定路由服务的地址
uri: http://localhost:8888
# 断言,用来配置路由规则
predicates:
# 路径匹配,会路由转发到 http://localhost:8888/user/**
- Path=/user/**
- id: order_router
uri: http://localhost:9999
predicates:
- Path=/order/**
- 基于java代码方式配置gateway
/**
* 基于java代码实现路由配置
*
* @author coolw
* @Date 2022/1/17 23:51
* @since 1.0
*/
@Configuration
public class GatewayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
return builder.routes()
// 用户路由规则
.route("user_router", r -> r.path("/user/**").uri("http://localhost:8888"))
// 订单路由规则
.route("order_router", r -> r.path("/order/**").uri("http://localhost:9999"))
.build();
}
}
- gateway测试
- 当访问 http://localhost:8999/user,会路由转发到 http://localhost:8888/user
- 当访问 http://localhost:8999/order,会路由转发到 http://localhost:9999/order
路由转发路径直接写死为ip:port,不利于维护,且无法实现负载均衡,不推荐使用。
2.网关路由转发实现负载均衡,集成Ribbon(负载均衡客户端组件)
- 配置文件,路由服务地址固定写法 lb://服务名,lb:LoadBalanced 负载均衡
spring:
application:
name: GATEWAY
cloud:
consul:
host: localhost
port: 8500
gateway:
routes:
# 商品路由
- id: product_route
# 实现负载均衡。lb:LoadBalanced 负载均衡,PRODUCT:服务名
uri: lb://PRODUCT
predicates:
- Path=/product/**
3.网关-断言 Route Predicate Factories
# 断言:当请求到达网关时,网关前置处理,满足断言则放行请求,不满足则返回失败
# 官方文档:https://docs.spring.io/spring-cloud-gateway/docs/2.2.7.RELEASE/reference/html/#gateway-request-predicates-factories
# 网关断言种类
predicates:
# 满足指定的路径规则,允许访问
- Path=/user/**
# 在指定的时间后,允许访问
- After=2022-01-18T22:55:41.815+08:00[Asia/Shanghai]
# 在指定的时间前,允许访问
- Before=2022-01-18T22:55:41.815+08:00[Asia/Shanghai]
# 在指定时间范围内,允许访问
- Between=2022-01-18T22:55:41.815+08:00[Asia/Shanghai], 2022-01-18T23:55:41.815+08:00[Asia/Shanghai]
# 指定Cookie的key为name,value为zhangsan,允许访问
- Cookie=name, zhangsan
......其他断言种类见官方文档
- 断言接口类
RoutePredicateFactory
所实现的断言子类
4.网关-过滤器 GatewayFilter Factories
# 过滤器:当请求满足断言的条件后,会向后端服务进行路由转发,在向后端服务转发之前可以设置经过一些过滤器
# 官方文档:https://docs.spring.io/spring-cloud-gateway/docs/2.2.7.RELEASE/reference/html/#gatewayfilter-factories
# 过滤器种类
filters:
# 用来给路由对象的转发请求加入指定请求头信息(key,value)
- AddRequestHeader=X-Request-color, blue
# 用来给路由对象的转发请求加入指定请求参数(key,value)
- AddRequestParameter=color, blue
# 用来给路由对象的转发请求的响应加入指定请求头信息
- AddResponseHeader=X-Response-Red, Blue
# 在路由转发到后端服务时,添加前缀(例如,前端请求地址/user/list,指定PrefixPath为/mypath,则路由转发到后端地址为/mypath/user/list)
- PrefixPath=/mypath
# 在路由转发到后端服务时,去掉指定n个的前缀(例如,前端请求地址/api/user/list,指定StripPrefix为1,则路由转发到后端地址为/user/list)
- StripPrefix=1
......其他过滤器种类见官方文档
- 过滤器接口
GatewayFilterFactory
所实现的子类
5.自定义全局过滤器
# 官方文档:https://docs.spring.io/spring-cloud-gateway/docs/2.2.7.RELEASE/reference/html/#global-filters
- 代码示例
/**
* 自定义全局过滤器
*
* @author coolw
* @Date 2022/1/18 23:49
* @since 1.0
*/
@Component
@Slf4j
public class CustomerGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest request = exchange.getRequest();
ServerHttpResponse response = exchange.getResponse();
// TODO 执行过滤器前的业务逻辑
Mono<Void> filter = chain.filter(exchange);
// TODO 执行过滤器后的业务逻辑
return filter;
}
/**
* 如果有多个全局过滤器类,可以指定过滤器执行顺序,越小则越先执行,默认为0
* -1:最先执行。如果有多个全局过滤器的order值相同,则按自然顺序执行
*/
@Override
public int getOrder() {
return -1;
}
}
6.查看网关路由规则列表
- 网关服务的配置文件,暴露健康检查的端点
management:
endpoints:
web:
exposure:
# 暴露所有端点。也可以指定需要暴露的端点列表
include: "*"
-
访问网关地址 http://localhost:8999/actuator/gateway/routes
-
断言和过滤器配置示例
server:
port: 8999
spring:
application:
name: GATEWAY
cloud:
consul:
host: localhost
port: 8500
gateway:
routes:
# 用户路由唯一标识
- id: user_route
# 指定路由服务的地址
uri: http://localhost:8888
# 断言,用来配置路由规则
predicates:
- Path=/user/**
# 订单路由
- id: order_route
uri: http://localhost:9999
predicates:
- Path=/order/**
# 商品路由
- id: product_route
# 实现负载均衡。lb:LoadBalanced 负载均衡,PRODUCT:服务名
uri: lb://PRODUCT
predicates:
# 满足路径规则,放行
- Path=/api/gateway/product/**
# 在指定的时间后,放行
- After=2022-01-19T00:12:10.815+08:00[Asia/Shanghai]
filters:
# 去掉指定个数的前缀,例如/api/gateway/product/** -> 转发到后端服务的路径会去掉/api/gateway -> /product/**
- StripPrefix=2
# 添加前缀,例如/test/** -> 转发到后端服务的路径会添加/product -> /product/test/**
- PrefixPath=/product
management:
endpoints:
web:
exposure:
# 暴露所有端点。也可以指定需要暴露的端点列表
include: "*"