gateway源码,gateway策略
gateway源码,gateway策略
API 是微服务架构重要组件之一,是服务入口。API 封装内部系统架构,横向抽离通用功能,如:身份验证、监控、限流、熔断、负载均衡等。核心要点是,所有的客户端和消费端都通过统一的接入微服务,在层处理所有的非业务功能。
在 web 1.0,2.0 时代,主要由web网站形式呈现。大多数都采用前置反向代理,主要作用是反向路由和负载均衡。典型的产品有 Nginx 和 HAproxy。一般采用静态配置方式,由运维团队配置。
如今来到了 web 3.0 微服务的时代,出现了大量提供 API 的服务。这些服务升级频率很高,要求对安全和动态配置的能力很高,架构慢慢衍生出。反向代理有的功能都具备。以 Netflix Zuul 为代表。
主要给微服务/API用,偏向开发人员,反向代理主要面向传统静态 web 应用,偏向运维。未来趋势(云原生时代)是DevOps+和反向代理再次融。
应当具备以下功能:
支持公司实现语言亮点不足Nginx (2004)Nginx IncC/Lua高性能,成熟稳定门槛高,偏运维,可编程弱Kong (2014)Kong IncOpenResty/Lua高性能,可编程API门槛较高Zuul1 (2012)Netflix/PivotalJava成熟,简单门槛低性能一般,可编程一般Spring Cloud Gateway (2016)PivotalJava异步,配置灵活早期产品(现已经比较成熟)Envoy (2016)LyftC++高性能,可编程API/ ServiceMesh 集成门槛较高Traefik (2015)ContainousGolang云原生,可编程API/对接各种服务发现生产案例不多
暂时选择 Spring Cloud Gateway,原因如下:
Spring Cloud Gateway 为 SpringBoot 应用提供了API支持,具有强大的智能路由与过滤器功能。Gateway 是在 Spring 生态系统之上构建的 API 服务,基于 Spring 5,Spring Boot 2和 Project Reactor等技术。
Spring Cloud Gateway 具有如下特性:
很像 SpringMVC 的请求处理过程,客户端向 Spring Cloud Gateway 发出请求。如果 Gateway Handler Mapping确定请求与路由匹配,则将其发送给 Gateway Web Handler。这个 Handler 运行通过特定于请求的过滤器链发送请求。过滤器可以在发送代理请求之前或之后执行逻辑。执行所有的“pre”过滤逻辑,然后发出代理请求,执行“post”过滤逻辑。
创建 api-gateway 模块,在 pom.xml 中添加相关依赖:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId></dependency>两种不同的配置路由方式
Gateway 提供了两种不同的方式用于配置路由,一种是通过 yml 文件来配置,另一种是通过 Java Bean 来配置。
在 application.yml 中进行配置:
注意:Predicate 中提到的配置都在 application-predicate.yml 文件中进行修改,并用该配置启动api-gateway 服务。
在指定时间之后的请求会匹配该路由。
spring: cloud: gateway: routes: - id: before_route uri: ${service-url.user-service} predicates: - Before=2020-02-14T20:30:00+08:00[Asia/Shanghai]Before Route Predicate
在指定时间之前的请求会匹配该路由。
spring: cloud: gateway: routes: - id: cookie_route uri: ${service-url.user-service} predicates: - Cookie=username,leoBetween Route Predicate
在指定时间区间内的请求会匹配该路由。
spring: cloud: gateway: routes: - id: cookie_route uri: ${service-url.user-service} predicates: - Cookie=username,leoCookie Route Predicate
带有指定Cookie的请求会匹配该路由。
spring: cloud: gateway: routes: - id: cookie_route uri: ${service-url.user-service} predicates: - Cookie=username,leo
curl http://localhost:9201/user/1 --cookie "username=leo"
带有指定请求头的请求会匹配该路由。
spring: cloud: gateway: routes: - id: header_route uri: ${service-url.user-service} predicates: - Header=X-Request-Id, \\d+
curl http://localhost:9201/user/1 -H "X-Request-Id:111"
带有指定Host的请求会匹配该路由。
发送指定方法的请求会匹配该路由。
spring: cloud: gateway: routes: - id: method_route uri: ${service-url.user-service} predicates: - Method=GETPath Route Predicate
发送指定路径的请求会匹配该路由。
spring: cloud: gateway: routes: - id: query_route uri: ${service-url.user-service}/user/getByUsername predicates: - Query=usernameRemoteAddr Route Predicate
从指定远程地址发起的请求可以匹配该路由。
spring: cloud: gateway: routes: - id: remoteaddr_route uri: ${service-url.user-service} predicates: - RemoteAddr=192.168.1.1/24Weight Route Predicate
使用权重来路由相应请求,以下表示有80%的请求会被路由到 localhost:8201,20% 会被路由到 localhost:8202。
curl http://localhost:9201/user/getByUsername# 相当于发起该请求:curl http://localhost:8201/user/getByUsername?username=leo自定义 Route Predicate 工厂
curl http://localhost:9201/user/getByUsername# 相当于发起该请求:curl http://localhost:8201/user/getByUsername?username=leoRoute Filter 的使用
路由过滤器可用于修改进入的 HTTP 请求和返回的 HTTP 响应,路由过滤器只能指定路由进行使用。Spring Cloud Gateway 内置了多种路由过滤器,他们都由 GatewayFilter 的工厂类来产生。
给请求添加参数的过滤器。
curl http://localhost:9201/user/getByUsername# 相当于发起该请求:curl http://localhost:8201/user/getByUsername?username=leo
curl http://localhost:9201/user/getByUsername# 相当于发起该请求:curl http://localhost:8201/user/getByUsername?username=leoAddRequestHeader GatewayFilter
给请求添加一个请求头 X-Request-Foo:Bar
spring: cloud: gateway: routes: - id: add_response_head_route uri: http://localhost:8201 filters: - AddResponseHeader=X-Response-Foo, BarAddResponseHeader GatewayFilter
给请求添加一个响应头 X-Response-Foo:Bar
curl http://localhost:9201/user-service/a/user/1# 相当于发起该请求:curl http://localhost:8201/user/1StripPrefix GatewayFilter
对指定数量的路径前缀进行去除的过滤器。
spring: cloud: gateway: routes: - id: hystrix_route uri: http://localhost:8201 predicates: - Method=GET filters: - Hystrix=myCommandName
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis-reactive</artifactId></dependency>PrefixPath GatewayFilter
与 StripPrefix 过滤器恰好相反,会对原有路径进行增加操作的过滤器。
spring: cloud: gateway: routes: - id: prefix_path_route uri: http://localhost:8201 predicates: - Method=GET filters: - PrefixPath=/userHystrix GatewayFilter
Hystrix 过滤器允许你将断路器功能添加到路由中,使你的服务免受级联故障的影响,并提供服务降级处理。
要开启断路器功能,我们需要在 pom.xml 中添加 Hystrix 的相关依赖:
在pom.xml中添加相关依赖:
spring: cloud: gateway: routes: - id: retry_route uri: http://localhost:8201 predicates: - Method=GET filters: - name: Retry args: retries: 1 #需要进行重试的次数 statuses: BAD_GATEWAY #返回哪个状态码需要进行重试,返回状态码为5 进行重试 backoff: firstBackoff: 10ms maxBackoff: 50ms factor: 2 basedOnPreviousValue: falseDefault Filters
如果你想要添加一个过滤器并且把它应用于所有路由的话,你可以用 spring.cloud.gateway.default-filters。这个属性接受一个过滤器列表。