1.基本概念
1.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高性能通信框架,性能都挺不错。
1.2.Spring Cloud Gataway的特点
在Spring Cloud官方定义了SpringCloud Gateway 的如下特点:
-
基于 Spring 5,Project Reactor , Spring Boot 2.0
-
默认集成 Hystrix 断路器
-
默认集成 Spring Cloud DiscoveryClient (EurekaClient)
-
Predicates 和 Filters 作用于特定路由,易于编写的 Predicates 和 Filters
-
支持动态路由、限流、路径重写
1.3.Spring Cloud Gataway的核心概念
-
Filter(过滤器):
-
Spring Cloud
Gateway的Filter和Zuul的过滤器类似
,可以在请求发出前后进行一些业务上的处理 ,这里分为两种类型的Filter,分别是Gateway Filter网关filter和Global Filter全局Filter,
他们的区别在后续会讲到。 -
Route(路由):
-
网关配置的基本组成模块,和Zuul的路由配置模块类似。一个Route模块由一个 ID,一个目标 URI,一组断言和一组过滤器定义。如果断言为真,则路由匹配,目标URI会被访问。说白了就是把url请求路由到对应的资源(服务),或者说是一个请求过来Gateway应该怎么把这个请求转发给下游的微服务,转发给谁。
-
Predicate(断言/url判断):
-
这是一个 Java 8 的 Predicate,可以使用它来
匹配来自 HTTP 请求的任何内容
,例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。简单理解就是处理HTTP请求的匹配规则,在什么样的请情况下才能命中资源继续访问。
1.4Gateway工作方式
Spring Cloud Gateway 的工作原理跟 Zuul 的差不多,最大的区别就是 Gateway 的 Filter 只有 pre 和 post 两种。官方执行流程图如下:
客户端向Spring Cloud Gateway发出请求。如果网关处理程序映射确定请求与路由匹配,则将其发送到网关Web处理程序。该处理程序通过特定于请求的过滤器链来运行请求。筛选器由虚线分隔的原因是,筛选器可以在发送代理请求之前和之后运行逻辑。所有“前置”过滤器逻辑均被执行。然后发出代理请求。发出代理请求后,将运行“后”过滤器逻辑。
2. Spring Cloud Gataway代码实操
2.1导入依赖
<!--服务注册与发现-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!-- !!不能导入web包,没有用springmvc,用的webflix -->
2.2启动类
/**
* Getaway的启动类
*/
@SpringBootApplication
@EnableDiscoveryClient
public class GetawayApplication1060 {
public static void main(String[] args) {
SpringApplication.run(GetawayApplication1060.class);
}
}
2.3 yml配置
#注册到EurekaServer
eureka:
client:
serviceUrl:
defaultZone: http://localhost:1010/eureka/
instance:
instance-id: gateway-server-1060
spring:
application:
name: gateway-server
cloud:
globalcors: #跨域配置
cors-configurations:
'[/**]':
allowedOrigins: "*" #允许的站点
allowedMethods:
- GET
- POST
- DELETE
- PUT
- HEAD
- CONNECT
- TRACE
- OPTIONS
allowHeaders:
- Content-Type
gateway:
httpclient:
connect-timeout: 1000
response-timeout: 5s
discovery:
locator:
enabled: false #开放服务名访问方式
lower-case-service-id: true #服务名小写
routes:
- id: user-server #指定服务名
uri: lb://user-server #去注册中心找这个服务名
predicates: #断言,匹配访问的路径
- Path=/servers/user/** #服务访问路径
filters:
- StripPrefix=2 #请求转发的时候会去掉 /user访问路径
server:
port: 1060
3.Spring Cloud Gateway 的 Filter 过滤器
3.1.Gateway filter
针对单个路由的Filter, 它允许以某种方式修改HTTP请求或HTTP响应。过滤器可以作用在某些特定的请求路径上。Gateway内置了很多的GatewayFilter工厂。如果要使用这些Filter只需要在配置文件配置GatewayFilter Factory的名称。
3.2自定义 filter
3.2.1gateway的filter
编写类,实现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(() -> {
//代码到这执行结束了 - 结束时间
Long endTime = new Date().getTime();
//消耗时间
Long time = endTime - startTime;
System.out.println("当前请求" + exchange.getRequest().getURI() + "耗时:"+time);
})
);
}
@Override
public int getOrder() {
//排序,越小越先
return 0;
}
}
配置GatewayFilter
@Configuration
public class FilterConfig {
//配置Filter作用于那个访问规则上
@Bean
public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
return builder.routes().route(r -> r.path("/servers/user/**")
//去掉2个前缀
.filters(f -> f.stripPrefix(2)
.filter(new RequestTimeFilter())
.addResponseHeader("X-Response-test", "test"))
.uri("lb://user-server")
.order(0)
.id("test-RequestTimeFilter")
).build();
}
}
3.2.2global的filter
编写类,实现GlobalFilter , Ordered,登录检查
/**
* 全局过滤器
*/
@Component
public class CheckGlobleFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//获取 request
ServerHttpRequest request = exchange.getRequest();
//获取 response
ServerHttpResponse response = exchange.getResponse();
List<String> tokens = request.getHeaders().get("token");
//判断是否有token
if (null == tokens || tokens.size() == 0) {
DataBuffer buffer = null;
try {
byte[] bytes = "请登录".getBytes("utf-8");
buffer = response.bufferFactory().wrap(bytes);
//设置完成相应,不会继续执行后面的filter
//response.setComplete();
response.setStatusCode(HttpStatus.UNAUTHORIZED);
response.getHeaders().add("Content-Type","application/json;charset=UTF-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
//把结果写给客户端
return response.writeWith(Mono.just(buffer));
}
//通过了才执行
return chain.filter(exchange);
}
@Override
public int getOrder() {
//排序,越小越先
return 0;
}
}
注意:注解:@Component,交给Spring