zuul由于内部分歧,已经不再维护了。
Gateway新一代网关
概念简述
是什么
Cloud全家桶中有个很重要的组件就是网关,在1.X版本中都是采用zuul网关,在2.X版本中,zuul的升级一直跳票,SpringCloud最后自己研发了一个网关替带zuul——SpringCloud Gateway 。换言之,gateway就是原zuul1.X版 的替代。
Gateway是什么?
Gateway是在spring生态系统上构建的api网关服务,基于Spring5,SpringBoot2和Project Reactor等技术。Gateway旨在提供一种简单而有效的方式来对api进行路由,以提供一些强大的过滤功能,例如熔断、限流、重试等。
为了提升网关性能,SpringCloud Gateway是基于WebFlux框架实现的,而WebFlux框架底层使用了高性能的Reactor通信框架Netty。SpringCloud Gateway的目标提供统一的路由方式,且基于Filter链的方式提供了网关基本的功能,例如安全、监控/指标、限流。
SpringCloud Gateway的特性
基于Spring FremeWork5,Project Reactor和Spring Boot2.0进行构建;
动态路由:能够匹配任何请求属性;
可以对路由指定Predictate(断言)和Filter(过滤器);
集成Hystrix的断路器功能;
集成SpringCloud的服务发现功能;
易于比爱那些的Predictate(断言)和Filter(过滤器);
请求限流功能;
支持路径重写。
SpringCloud Gateway与Zuul的区别
在SpringCloud Finchley 正式版之前,Spring Cloud推荐的网关是 Netflix提供的Zuul:
1、Zuul 1.x,是一个基于阻塞I/O的API Gateway;
2、Zuul 1.x基于Servlet 2.5使用阻塞架构,它不支持任何长连接(如WebSocket)。Zuul的设计模式和Nginx较像,每次I/О操作都是从工作线程中选择一个执行,请求线程被阻塞到工作线程完成,但是差别是Nginx用C++实现,Zuul用Java实现,而JVM本身会有第—次加载较慢的情况,使得Zuul的性能相对较差。
3、Zuul 2.x理念更先进,想基于Netty非阻塞和支持长连接,但SpringCloud目前还没有整合。Zuul 2.x的性能较Zuul 1.x有较大提升。在性能方面,根据官方提供的基准测试,Spring Cloud Gateway的RPS(每秒请求数)是Zuul的1.6倍。
4、Spring Cloud Gateway建立在Spring Framework 5、ProjectReactor和Spring Boot2之上,使用非阻塞API。
5、Spring Cloud Gateway还支持WebSocket,并且与Spring紧密集成拥有更好的开发体验
WebFlux是什么
传统的Web框架,比如说: struts2,springmvc等都是基于Servlet API与Servlet容器基础之上运行的。但是在Servlet3.1之后有了异步非阻塞的支持。而WebFlux是一个典型非阻塞异步的框架,它的核心是基于Reactor的相关API实现的。相对于传统的web框架来说,它可以运行在诸如Netty,Undertow及支持Servlet3.1的容器上。非阻塞式+函数式编程(Spring5必须让你使用java8)
Spring WebFlux是Spring 5.0引入的新的响应式框架,区别于Spring MVC,它不需要依赖Servlet API,它是完全异步非阻塞的,并且基于Reactor来实现响应式流规范。
三大核心概念
Route(路由)
路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true,则匹配该路由。
Predicate(断言)
参考的是Java8的java.util.function.Predictate,开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与路由相匹配则进行路由。
Filter(过滤)
指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由之前或之后对请求进行修改。
web请求,通过一些匹配条件,定位到真正的服务节点,并在这个转发过程的前后,进行一些精细化控制。Predicate就是我们的匹配条件,而filter,就可以理解为一个无所不能的拦截器。有了这两个元素,再加上目标uri,就可以实现一个具体的路由。
Gatewey工作流程
客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping中找到与请求相匹配的路由,将其发送到Gateway Web Handler。
Handler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post”)执行业务逻辑的加强或其他处理。
Filter 在 “pre” 类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等;在 “post” 类型的过滤器中可以做响应内容、响应头的修改,日志的输出,流量监控等,有着非常重要的作用
Gatewey的核心逻辑就是**路由转发+执行过滤链
入门配置
1、建moudle
创建名为cloud-gatewey-gatewey9527的pom
2、改pom
<dependencies>
<!--gatewey-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--Eureka依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--引入公共模块坐标-->
<dependency>
<groupId>cn.yz.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</version>
</dependency>
<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>
<!--热部署插件-->
<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>
3、写yml
server:
port: 9527
spring:
application:
name: cloud-gateway
eureka:
instance:
hostname: cloud-gateway-service
client: #服务提供则provider注册进eureka服务列表中
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
4、主启动
@SpringBootApplication
@EnableEurekaClient
public class GatewayMain9527 {
public static void main(String[] args) {
SpringApplication.run(GatewayMain9527.class,args);
}
}
5、9527网关做路由映射
不暴露8001端口,在8001外面套一层9527,在8001中,有两个访问路径
/payment/getPaymentById/{id}
和
/payment/lb
,因此在9527的application.yml中为8001的两个路径配置路由映射。
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/getPaymentById/** #断言,路径相匹配的进行路由
- id: payment_routh2 #路由的ID,没有固定规则但要求唯一,建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client: #服务提供则provider注册进eureka服务列表中
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
遇到的坑:我的9527在启动过程中报出了下面的错误:
Parameter 0 of method modifyResponseBodyGatewayFilterFactory in org.springframework.cloud.gateway.config.GatewayAutoConfiguration required a bean of type 'org.springframework.http.codec.ServerCodecConfigurer' that could not be found.
这个错误是因为spring-cloud-starter-gateway与spring-boot-starter-web和spring-boot-starter-webflux发生了依赖冲突,配置网关其实是不需要web依赖的,因此只需要将spring-boot-starter-web和spring-boot-starter-webflux依赖注释掉就可以了
6、启动、测试
启动7001、8001、9527,8001自测http://localhost:8001/payment/getPaymentById/1通过,不暴露8001端口,直接用9527进行访问,http://localhost:9527/payment/getPaymentById/1也可以访问成功。
Gateway网关路由有两种配置方式
以上是在配置文件yml中配置,另一种方式是代码中注入RouteLocator的Bean
@Configuration
public class GatewayConfig {
public RouteLocator customerRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
//相当于yml中
// cloud:
// gateway:
// routes:
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
//相当于yml中配置的
// - id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
// uri: http://localhost:8001 #匹配后提供服务的路由地址
//意味着访问localhost:9527/guonei这个网址,将会转发到https://news.baidu.com/guonei
routes.route("path_route_cnyz",r -> r.path("/guonei").uri("https://news.baidu.com/guonei"));
return routes.build();
}
}
通过微服务名实现动态路由
默认情况下Gateway会根据中心注册的服务列表,以注册中心上的微服务名为路径创建动态路由进行转发,从而实现动态路由的功能。
在yml配置中,要将原本写死的路由地址改为
lb://XXX
的格式,其中“XXX”为注册在eureka中的服务名称。这样在有多个服务时,可以实现动态路由。
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创价路由的功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定规则但要求唯一,建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service #匹配后提供服务的路由地址
predicates:
- Path=/payment/getPaymentById/** #断言,路径相匹配的进行路由
- id: payment_routh2 #路由的ID,没有固定规则但要求唯一,建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://cloud-payment-service #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** #断言,路径相匹配的进行路由
在访问地址http://localhost:9527/payment/lb时,由8001和8002交替提供服务(负载均衡默认为轮询)
Predicate的使用
在前面的实验中,我们是使用
- Path
来完成的路由映射,常用的路由映射共有以下九种:
- After Route Predicate (在某时刻之后,适用于秒杀任务)
- Before Route Predicate (在某时刻之前)
- Between Route Predicate (在某两个时刻之间)
-
Cookie Route Predicate
Cookie Route Predicate需要两个参数,一个是Cookie name,一个是正则表达式。路由规则会通过获取对应的Cookie name值和正则表达式去匹配,如果匹配上就会执行路由,匹配不上则不执行。
使用curl模拟访问9527/payment/lb(带上cookie)- Cookie=username, maize
-
Header Route Predicate
两个参数:一个是属性名称,另一个是正则表达式。这个属性值和正则表达式匹配则执行,否则不执行。
- Host Route Predicate
-
Method Route Predicate
发送的是什么请求
- Method=Get/Post/。。
- Path Route Predicate
-
Query Route Predicate
两个参数:属性名称和正则表达式,Query是路径的问号后所带的参数
- Query=username, \d+ #要有参数名username并且值还要是整数才能路由
Filter的使用
是什么
路由过滤器可用于修改进入的HTTP请求和返回的HTTP响应,路由过滤器只能指定路由进行使用。
SpringCloud Gateway内置了多种路由过滤器,他们都由GatewayFilter的工厂来产生
自定义过滤器
配置类MyGatewayFilter.java(需实现GlobalFilter, Ordered这两个接口)
@Component
@Slf4j
public class MyGatewayFilter 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("uname");
if(uname == null){
log.info("******用户名为null,非法用户,/(ㄒoㄒ)/~~");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
//合法用户,去下一个过滤链
return chain.filter(exchange);
}
//加载过滤器的顺序,一般数字越小,优先级越高
@Override
public int getOrder() {
return 0;
}
}
log.info("******用户名为null,非法用户,/(ㄒoㄒ)/~~");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
//合法用户,去下一个过滤链
return chain.filter(exchange);
}
//加载过滤器的顺序,一般数字越小,优先级越高
@Override
public int getOrder() {
return 0;
}
}