一:基本概念
1.Zuul和Gateway区别
Zuul是Netflix的开源项目,Spring Cloud将其收纳成为自己的一个子组件。zuul用的是多线程阻塞模型,它本质上就是一个同步 Servlet,这样的模型比较简单,他都问题是多线程之间上下文切换是有开销的,线程越多开销就越大。线程池数量固定意味着能力接受的请求数固定,当后台请求变慢,面对大量的请求,线程池中的线程容易被耗尽,后续的请求会被拒绝。
在Zuul 2.0中它采用了 Netty 实现异步非阻塞编程模型,异步非阻塞模式对线程的消耗比较少,对线程上线文切换的消耗也比较小,并且可以接受更多的请求。它的问题就是线程模型比较复杂,要求深究底层原理需要花一些功夫。
Spring Cloud Gateway是Spring Cloud自己的产物,基于Spring 5 和Spring Boot 2.0 开发,Spring Cloud Gateway的出现是为了代替zuul,在Spring Cloud 高版本中没有对zuul 2.0进行集成,SpringCloud Gateway使用了高性能的Reactor模式通信框架Netty。
Spring Cloud Gateway 的目标,不仅提供统一的路由
方式,并且基于 Filter 链的方式提供了网关基本的功能
,例如:安全,监控/指标,和限流
。
所以说其实Gateway和zuul 2.0差别不是特别大,都是采用Netty高性能通信框架,性能都挺不错。
2.SpringCloudGateway的特点
1.基于 Spring 5,Project Reactor , Spring Boot 2.0
2.默认集成 Hystrix 断路器
3.默认集成 Spring Cloud DiscoveryClient
4.Predicates 和 Filters 作用于特定路由,易于编写的 Predicates 和 Filters
5.支持动态路由、限流、路径重写
3.SpringCloudGateway的核心概念
1.过滤器filter
Spring Cloud Gateway的Filter和Zuul的过滤器类似
,可以在请求发出前后进行一些业务上的处理 ,这里分为两种类型的Filter,分别是Gateway Filter网关filter和Global Filter全局Filter
2.路由route
网关配置的基本组成模块,和Zuul的路由配置模块类似。一个Route模块由一个 ID,一个目标 URI,一组断言和一组过滤器定义。如果断言为真,则路由匹配,目标URI会被访问。说白了就是把url请求路由到对应的资源(服务),或者说是一个请求过来Gateway应该怎么把这个请求转发给下游的微服务,转发给谁。
3.断言predicate
这是一个 Java 8 的 Predicate,可以使用它来匹配来自 HTTP 请求的任何内容
,例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。简单理解就是处理HTTP请求的匹配规则,在什么样的请情况下才能命中资源继续访问。
4.SpringCloudGateway的工作流程
Spring Cloud Gateway 的工作原理跟 Zuul 的差不多,最大的区别就是 Gateway 的 Filter 只有 pre 和 post 两种,下面是官方的执行流程图:
客户端向Spring Cloud Gateway发出请求。如果网关处理程序映射确定请求与路由匹配,则将其发送到网关Web处理程序。该处理程序通过特定于请求的过滤器链来运行请求。筛选器由虚线分隔的原因是,筛选器可以在发送代理请求之前和之后运行逻辑。所有“前置”过滤器逻辑均被执行。然后发出代理请求。发出代理请求后,将运行“后”过滤器逻辑。
二:SpringCloudGateway基本使用
1.创建工程导入依赖
<dependencies>
<!--服务注册与发现-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--gateway网关依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
</dependencies>
2.配置启动类
@SpringBootApplication
@EnableDiscoveryClient // 可以省略
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class);
}
}
3.配置application.yml
eureka:
client:
serviceUrl:
defaultZone: http://localhost:10010/eureka/
instance:
prefer-ip-address: true #使用ip注册到Eureka
instance-id: server-gateway #指定客户端实例的ID
spring:
application:
name: server-gateway
cloud:
gateway:
discovery:
locator:
enabled: false #开放服务名访问方式
lower-case-service-id: true #服务名小写
routes:
- id : server-user #指定服务名
uri: lb://server-user #去注册中心找这个服务名
predicates: #断言,匹配访问的路径
- Path=/user/** #服务访问路径
filters:
- StripPrefix=1 #请求转发的时候会去掉 /user访问路径
server:
port: 10060
解释:
1.spring.cloud.gateway.discovery.locator.enabled=false
: 不开放服务名访问方式
2.spring.cloud.gateway.discovery.locator.lower-case-service-id: true
忽略服务名大小写,大写小写都可以匹配
3.spring.cloud.gateway.routes.id
: 指定了路由的服务名,可以自己定义
4.spring.cloud.gateway.routes.uri=lb://server-user
: 去注册中心找服务,采用负载均衡的方式请求。其实就是找要调用的服务。
5.spring.cloud.gateway.routes.predicates
: 断言,这里使用的Path=/user/**,即匹配访问的路径如果匹配/user/就可以将请求路由(分发)到user-server这个服务上。
6.spring.cloud.gateway.routes.filters
:这里使用StripPrefix=1主要是处理前缀 /user ,访问目标服务的时候会去掉前缀访问。这个需要根据url情况来定义。
4.测试
启动注册中心,启动用户服务,启动网关访问:http://localhost:10060/user/user/1
,请求将会打到用户服务上,并返回用户数据。
三:Predicate断言工厂
断言工厂就是用来判断http请求的匹配方式。比如我们再上面案例中配置的:“Path=/user/**
” ,就是使用的是 “Path Route Predicate Factory
” 路径匹配工厂,意思是http请求的资源地址必须是 /user 才会被匹配到对应的路由,然后继续执行对应的服务获取资源。
在Spring Cloud Gateway中,针对不同的场景内置的路由断言工厂,比如
1.Query Route Predicate Factory
:根据查询参数来做路由匹配
2.RemoteAddr Route Predicate Factory
:根据ip来做路由匹配
3.Header Route Predicate Factory
:根据请求头中的参数来路由匹配
4.Host Route Predicate Factory
:根据主机名来进行路由匹配
5.Method Route Predicate Factory
:根据方法来路由匹配
6.Cookie Route Predicate Factory
:根据cookie中的属性值来匹配
7.Before Route Predicate Factory
:指定时间之间才能匹配
8.After Route Predicate Factory
: 指定时间之前才能匹配
9.Weight Route Predicate Factory
: 根据权重把流量分发到不同的主机
四:Gateway的Filter过滤器
Gateway的Filter的zuul的Filter有相似之处,与zuul不同的是,Gateway的filter从生命周期上可以为“pre”和“post”类型。根据作用范围可分为针对于单个路由的gateway filter,和针对于所有路由的Global Filer
。
1.内置的Gateway Filter
针对单个路由的Filter
, 它允许以某种方式修改HTTP请求或HTTP响应。过滤器可以作用在某些特定的请求路径上。Gateway内置了很多的GatewayFilter工厂。如果要使用这些Filter只需要在配置文件配置GatewayFilter Factory的名称。下面拿一个内置的Gateway Filter举例:
AddRequestHeader GatewayFilter Factory 该Filter是Gateway内置的,它的作用是在请求头加上指定的属性。配置如下:
spring:
cloud:
gateway:
routes:
- id: add_request_header_route
uri: https://example.org
filters:
- AddRequestHeader=X-Request-red, blue
在spring.cloud.gateway.routes.filters
配置项配置了一个AddRequestHeader
,他是“AddRequestHeader GatewayFilter Factory
”的名称,意思是在请求头中添加一个“X-Request-red
”的属性,值为blue
。
其他的Filter可以去看 AbstractGatewayFilterFactory 的实现类。
2.自定义Gateway Filter
在Spring Cloud Gateway自定义过滤器,过滤器需要实现GatewayFilter和Ordered这两个接口。我们下面来演示自定义filter计算请求的耗时。
@Component
//GatewayFilter, Ordered实现这两个接口
public class RequestTimeFilter implements GatewayFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
Long startTime = new Date().getTime(); // 获取开始时间
return chain.filter(exchange).then(
Mono.fromRunnable(()->{ // Mono.fromRunnable获取Mono对象
Long endTime = new Date().getTime();// 获取结束时间
long diff = endTime - startTime; // 将两个时间想减
System.out.println("当前请求:"+exchange.getRequest().getURI().getPath()+",耗费时间"+diff);
})
);
}
@Override
public int getOrder() {
return 0;
}
}
提示: getOrder返回filter的优先级,越大的值优先级越低 , 在filterI方法中计算了请求的开始时间和结束时间
最后我们还需要把该Filter配置在对应的路由上,配置如下:
@Configuration
public class FilterConfig {
//配置Filter作用于那个访问规则上
@Bean
public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
return builder.routes().route(r -> r.path("/server/user/**")
//去掉2个前缀
.filters(f -> f.stripPrefix(2)
.filter(new RequestTimeFilter())
.addResponseHeader("X-Response-test", "test"))
.uri("lb://server-user")
.order(0)
.id("test-RequestTimeFilter")
).build();
}
}
提示:这里将 RequestTimeFilter 添加到 “/user/**”这里路由上,当请求包含/user就会触发Filter的执行。
3.自定义全局过滤器Global Filter
GlobalFilter:全局过滤器,不需要在配置文件中配置,作用在所有的路由上,最终通过GatewayFilterAdapter包装成GatewayFilterChain可识别的过滤器,它为请求业务以及路由的URI转换为真实业务服务的请求地址的核心过滤器,不需要配置,系统初始化时加载,并作用在每个路由上。 这里我模拟了一个登陆检查的Filter.
@Component
public class CheckLoginGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取请求对象
ServerHttpRequest request = exchange.getRequest();
// 获取响应对象
ServerHttpResponse response = exchange.getResponse();
// 2.获取请求头token
List<String> token = request.getHeaders().get("token");
// 3.判断token是否为空 为空抛异常
if(null == token || token.isEmpty()){
DataBuffer buffer = null;
try {
byte[] bytes = "需要登录哦".getBytes();
buffer = response.bufferFactory().wrap(bytes);
// 完成之后不会再执行后面的filter
// 设置状态吗 401
response.setStatusCode(HttpStatus.UNAUTHORIZED);
response.getHeaders().add("Content-type","application/json;charset=UTF-8");
} catch (Exception e) {
e.printStackTrace();
}
// 把结果写到客户端
return response.writeWith(Mono.just(buffer));
}
// 4.token不为空就放行
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
如果请求头中没有 token ,就返回没有权限的状态码。可以使用postman测试
使用 buffer = response.bufferFactory().wrap(bytes)
构建响应内容,通过response.writeWith(Mono.just(buffer));
把内容写给客户端。
4.Gateway的跨域配置
所谓的跨域是因为浏览器的同源(同一个域)策略限制,其实就是同源策略会阻止一个域的javascript脚本和另外一个域的内容进行交互 ,在前后端分离的项目架构中就会出现跨域问题,因为Gateway 网关是微服务的访问入口,所以我们只需要在Gateway配置跨域即可
spring:
cloud:
globalcors: #跨域配置
cors-configurations:
'[/**]':
allowedOrigins: "https://docs.spring.io" #允许的站点
allowedMethods: #允许的请求方式
- GET
- POST
- DELETE
- PUT
- HEAD
- CONNECT
- TRACE
- OPTIONS
allowHeaders: #允许的请求头
- Content-Type
5.Gateway的超时配置
全局配置:
spring:
cloud:
gateway:
httpclient:
connect-timeout: 1000
response-timeout: 5s
那么Gateway就暂时先告一段落啦