一、为什么要使用网关?
1、如果有上百个微服务,没有使用微服务网关,客户端要使用上百个接口地址。(使用网关,对外只暴露一个域名)
2、如果某个微服务拆分成多个服务,客户端要集成新的拆分服务的Url。(使用网关,对外只暴露一个域名,不用管微服务如何拆分,客户端重构成本降低。)
3、如果有上百个微服务,每个服务都要做身份验证。(登录验证)
二、Spring Cloud Gateway是什么?
是Spring Cloud的网关(第二代), 未来会取代Zuul(第一代)
基于Netty、Reactor以及WebFlux构建
三、Spring Cloud Gateway优缺点
优点
1、性能强劲
是第一代网关Zuul 1.x的1.6倍
2、功能强大
内置了很多使用功能,比如转发、监控、限流等
3、设计优雅,易扩展
缺点
1、依赖Netty与Webflux,不是Servlet编程模型,有一定的适应成本
2、不能在Servlet容器下工作(如Tomcat),也不能构建WAR包,支持JAR包。
3、不支持Spring Boot 1.x
三、创建Gateway工程
工程结构
1、创建Gateway工程
选择依赖Gateway
增加依赖管理spring-cloud-alibaba
<dependencyManagement> <dependencies> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-alibaba-dependencies</artifactId> <version>${spring-cloud-alibaba.version}</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement>
增加依赖
<!--nacos客户端--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
版本信息
<properties> <java.version>1.8</java.version> <spring-cloud.version>Greenwich.RELEASE</spring-cloud.version> <spring-cloud-alibaba.version>2.1.0.RELEASE</spring-cloud-alibaba.version> </properties>
2、配置gateway
application.yml
server: port: 8040 spring: application: name: gateway cloud: nacos: discovery: server-addr: 118.xx.xx.101:8848 gateway: discovery: locator: # 让gateway通过服务发现组件找到其他的微服务 enabled: true management: endpoints: web: exposure: include: '*' endpoint: health: show-details: always
3、启动gateway工程
Started GatewayApplication in 6.723 seconds (JVM running for 7.831)
可以发现启动只需要6.7秒
4、网关服务访问
分别启动gateway和order服务
nacos查看
调用order服务的 queryOrderList接口
http://localhost:8071/order/queryOrderList
通过网关调用 访问方式: ${GATEWAY_URL}/{微服务X}/** 会转发到微服务X的/**路径
http://localhost:8040/service-order/order/queryOrderList
四、Gateway核心概念
1、Route(路由)
Spring Cloud Gateway的基础元素,可简单理解成一条转发的规则。
包含: ID、目标URL、Predicate集合以及Filter集合。
2、Pridicate(谓词)
即java.util.function.Predicate, Spring Cloud Gateway使用Predicate实现路由的匹配条件。
3、Filter(过滤器)
修改请求以及响应
五、Spring Cloud Gateway 架构图
六、路由谓词工厂 RoutePredicateFactories
七、自定义谓词工厂
限制09:00- 17:00 才能访问
1、修改配置。 locator enable为false
gateway: discovery: locator: enabled: false routes: - id: study uri: lb://service-order predicates: - TimeBetween=上午6:00,下午1:00
完整配置如下:
server: port: 8040 spring: application: name: gateway cloud: nacos: discovery: server-addr: 118.xx.xx.101:8848 gateway: discovery: locator: enabled: false routes: - id: study uri: lb://service-order predicates: - TimeBetween=上午6:00,下午1:00 management: endpoints: web: exposure: include: '*' endpoint: health: show-details: always
2、增加配置TimeBetweenConfig 类
@Data public class TimeBetweenConfig { private LocalTime start; private LocalTime end; }
增加配置类TimeBetweenRoutePredicateFactory ,这个类名必须以RoutePredicateFactory , TimeBetween对应 “- TimeBetween=上午6:00,下午1:00”的TimeBetween
@Component public class TimeBetweenRoutePredicateFactory extends AbstractRoutePredicateFactory<TimeBetweenConfig> { public TimeBetweenRoutePredicateFactory() { super(TimeBetweenConfig.class); } @Override public Predicate<ServerWebExchange> apply(TimeBetweenConfig config) { LocalTime start = config.getStart(); LocalTime end = config.getEnd(); return exchange -> { LocalTime now = LocalTime.now(); return now.isAfter(start) && now.isBefore(end); }; } @Override public List<String> shortcutFieldOrder() { return Arrays.asList("start","end"); } public static void main(String[] args) { DateTimeFormatter formatter = DateTimeFormatter.ofLocalizedTime(FormatStyle.SHORT); System.out.println(formatter.format(LocalTime.now())); } }
现在已经是下午2点,访问http://localhost:8040/order/queryOrderList, 返回404
将时间改成TimeBetween=上午6:00,下午5:00 就能访问了
参考:
https://www.cnblogs.com/fx-blog/p/11751594.html
http://www.imooc.com/article/290804
七、内置过滤器工厂
GatewayFilter Factories
1、增加配置
filters: - AddRequestHeader=X-Request-KEY11,Value11
如下图
在NettyRoutingFilter类的filter打上断点
可以看到,已经有值了。
八、自定义过滤器工厂
1、过滤器生命周期
2、自定义过滤器工厂的方式
3、核心API
4、编写过滤器工厂
1、过滤器生命周期
pre: Gateway转发请求之前
post: Gateway转发请求之后
2、自定义过滤器工厂的方式
1) 方式一 继承AbstractGatewayFilterFactory
2) 方式二 继承AbstractNameValueGatewayFilterFactory
3、核心API
exchange.getRequest().mutate().xxx //修改request
exchange.mutate().xxx //修改exchange
chain.filter(exchange) //传递给下一个过滤器处理
exchange.getResponse() //拿到响应,修改响应
4、编写过滤器工厂
功能: 记录日志
1) 增加配置
– PreLog=key2,value2
增加类 PreLogGatewayFilterFactory,列名必须以GatewayFilterFactory结尾,PreLog和配置里的PreLog保持一致。
访问接口: http://localhost:8040/order/queryOrderList
可以看到打印如下信息:
八、全局过滤器
全局过滤器作用于所有的路由。
Spring Cloud Gateway内置的过滤器,包括
九、监控SpringCloudGateway
http://localhost:8040/actuator/gateway/globalfilters
展示路由的详细信息
http://localhost:8040/actuator/gateway/routes
还能使用接口,动态增减,修改,删除路由。