1.简介
1.1 了解
官方: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/
Gateway是在Spring生态系统之上构建的API网关服务,基于Spring 5,Spring Boot 2和Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对API进行路由,以及提供一些强大的过滤器功能例如:熔断、限流、重试等。简单来说就是进行路由跳转,断言判断请求是否匹配,且对请求前后进行过滤(路由转发+执行过滤器链)
作用:反向代理、鉴权、流量控制、熔断、日志监控。。。
Spring Cloud Gateway使用的Webflux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架。
1.2 zuul与Gateway区别
由于1.0版本进入维护期,且2.0版本SpringCloud没有整合(原因是没有完成品)。就自己SpringCloud团队开发了Gateway
zuul1.x:基于Servlet 2.5使用阻塞架构且不支持任何长连接 ,Zuul的设计模式和Nginx较像,每次I/О操作都是从工作线程中选择一个执行,请求线程被阻塞到工作线程完成,但是差别是Nginx用C++实现,Zuul用Java 实现,而JVM本身会有第一次加载较慢的情况,使得Zuul的性能相对较差。
zuul2.x:基于Netty非阻塞且支持长连接,但SpringCloud目前还没有整合。
在性能方面,根据官方提供的基准测试,Spring Cloud Gateway的RPS(每秒请求数)是Zuul的1.6倍。
Gateway:Spring Cloud Gateway建立在Spring Framework 5、Project Reactor(响应式)和Spring Boot 2之上,使用非阻塞API且支持长连接。Spring Cloud Gateway还支持 WebSocket,并且与Spring紧密集成拥有更好的开发体验
1.3 三大核心理念
Route(路由):路由是构建网关的基本模块,它由ID,目标URl,一系列的断言和过滤器组成,如果断言为true则匹配该路由
Predicate(断言):参考的是java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路
Filter(过滤):指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
2.测试(实现隐藏8001端口号)
当我们的http://localhost:8001/Payment/get/1查看数据时,想要隐藏8001端口,则时需要网关来过滤隐藏掉,而是用网关服务的端口查看8001
2.1 方法一,通过yml实现
2.1.1 新建项目cloud-gateway-gateway9999
2.1.2 Pom.xml
<dependencies>
<!--新增gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.example</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>
2.1.3 application.yml
server:
port: 9999
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
2.1.4 GateWayMain9999.java
package com.node;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9999 {
public static void main(String[] args) {
SpringApplication.run( GateWayMain9999.class,args);
}
}
2.1.5 运行
2.2 方法二,通过Config配置类
2.2.1 GateWayConfig.java
package com.node.Config;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class GateWayConfig {
/*
* spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/Payment/get/** #断言,路径相匹配的进行路由
* */
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("https://www.bilibili.com",
r -> r.path("/v/popular/**").uri("https://www.bilibili.com")).build();
return routes.build();
}
/*
* 配置多个网关则多*/
}
2.2.2 运行
3.通过微服务名实现动态路由
默认情况下Gateway会根据注册中心的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能
3.1 修改Yml
server:
port: 9999
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
3.2 测试
启动Eureka7001+payment8001+payment8002+gateway9999
4.Predicate(断言)的使用
Spring Cloud Gateway将路由匹配作为Spring WebFlux HandlerMapping基础架构的一部分。
Spring Cloud Gateway包括许多内置的Route Predicate工厂。所有这些Predicate都与HTTP请求的不同属性匹配。多个RoutePredicate工厂可以进行组合
Spring Cloud Gateway创建Route对象时,使用RoutePredicateFactory 创建 Predicate对象,Predicate对象可以赋值给Route。Spring Cloud Gateway包含许多内置的Route Predicate Factories。
4.1断言类型(Curl测试Ip地址)
4.1.1 After Route Predicate
- After=2021-08-10T16:42:52.195+08:00[Asia/Shanghai] #在当前时间之后开启微服务,否则404
首先获取时间
4.1.2 Before Route Predicate
- Before=2021-08-10T16:42:52.195+08:00[Asia/Shanghai] #在当前时间之前开启微服务,否则404
4.1.3 Between Route Predicate
#在当前时间之间开启微服务,否则404
- Between=2021-08-10T16:42:52.195+08:00[Asia/Shanghai],2021-08-10T19:42:52.195+08:00[Asia/Shanghai]
4.1.4 Cookie Route Predicate
#- Cookie=name,zyj #带Cookie才能访问 curl http://localhost:9999/Payment/get/1 --cookie “name=zyj”
4.1.5 Header Route Predicate
- Header=Id, \d+ #请求头中要有X-Request-Id属性并且值为整数的正则表达式,http://localhost:9999/Payment/get/1 -H "Id:123"
4.1.6 Host Route Predicate
- Host=**.zyj.com #使用的是host的列表作为参数
4.1.7 Method Route Predicate Factory
- Method=GET #get请求才能访问,否则404
4.1.8 Path Route Predicate Factory
- Path=/Payment/get/** #断言,路径相匹配的进行路由
4.1.9 Query Route Predicate Factory
- Query=username, \d+ #要有参数名称并且是正整数才能路由
5.Filter过滤器
路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,路由过滤器只能指定路由进行使用。
Spring Cloud Gateway内置了多种路由过滤器,他们都由GatewayFilter的工厂类来产生
5.1 通过Yml
filter:
- AddRequestParameter=username,zyj #在进入页面首先过滤http://localhost:9999/Payment/get/1?username=zyj
5.2 通过代码
5.2.1 Filter层
MyLogGateWayFilter.java
package com.node.filter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.Date;
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
@Override
//ServerWebExchange:封装过一层的servlet,chain:过滤器清理链
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("*********come in MyLogGateWayFilter: "+new Date());
String user = exchange.getRequest().getQueryParams().getFirst("user");
if(StringUtils.isEmpty(user)){
log.info("*****用户名为Null");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
5.2.2 测试