SpringCloud-服务网关之Spring Cloud Gateway
目录
一，Gateway--服务网关
网关简介
Gateway简介
Gateway快速入门
基础版
Gateway增强版
简化版
跨域请求
二，Gateway核心架构
基本概念
执行流程
三，断言
内置路由断言工厂
基于Datetime类型的断言工厂
基于远程地址的断言工厂
基于Cookie的断言工厂
基于Header的断言工厂
基于Host的断言工厂
基于Method请求方法的断言工厂
基于Path请求路径的断言工厂
基于Query请求参数的断言工厂
基于路由权重的断言工厂
如何使用内置路由断言工厂
自定义路由断言工厂
第1步：在配置文件中,添加一个Age的断言配置
第2步：自定义一个断言工厂, 实现断言方法
pom.xml相关配置
一，Gateway--服务网关
网关简介
大家都知道在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用 这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。
这样的架构，会存在着诸多的问题：
客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
认证复杂，每个服务都需要独立认证。
存在跨域请求，在一定场景下处理相对复杂。
上面的这些问题可以借助API网关来解决。 所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证鉴权、监控、路由转发等等。 添加上API网关之后，系统的架构图变成了如下所示：
我们也可以观察下，我们现在的整体架构图：
在业界比较流行的网关，有下面这些：
Ngnix+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用 lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本
Kong
基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题： 只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。
Zuul Netflix
开源的网关，功能丰富，使用JAVA开发，易于二次开发 问题：缺乏管控，无法动态配 置；依赖组件较多；处理Http请求依赖的是Web容器，性能不如Nginx
Spring Cloud Gateway
Spring公司为了替换Zuul而开发的网关服务，将在下面具体介绍。
注意：SpringCloud alibaba技术栈中并没有提供自己的网关，我们可以采用Spring Cloud Gateway 来做网关
Gateway简介
Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术 开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安 全，监控和限流。
优点：
性能强劲：是第一代网关Zuul的1.6倍
功能强大：内置了很多实用的功能，例如转发、监控、限流等
设计优雅，容易扩展
缺点：
其实现依赖Netty与WebFlux，不是传统的Servlet编程模型，学习成本高
不能将其部署在Tomcat、Jetty等Servlet容器里，只能打成jar包执行
需要Spring Boot 2.0及以上的版本，才支持
Gateway快速入门
要求: 通过浏览器访问api网关,然后通过网关将请求转发到商品微服务
基础版
为了证明网关可以保护内部微服务的调用关系
http://localhost:8080/product/get/1 商品微服务的接口地址暴露 对于系统来说是不安全的
目标：访问网址 http://localhost:7000/xxx/product/get/1 也能访问到上一行中的地址，而且在此之前可以做一层过滤 比如身份验证
第1步：创建一个api-gateway的模块,导入相关依赖
(只需要这一个)
org.springframework.cloud spring-cloud-starter-gateway
第2步: 添加配置文件(application.yml)
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
gateway:
routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
- id: product_route # 当前路由的标识, 要求唯一
uri: https://csdn.net # 请求要转发到的地址
order: 1 # 路由的优先级,数字越小级别越高
predicates: # 断言(就是路由转发要满足的条件)
- Path=/csdn/** # 当请求路径满足Path指定的规则时,才进行路由转发
filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
- StripPrefix=1 # 转发之前去掉1层路径
先测试商品微服务的可用 访问成功
修改配置：
访问成功
Gateway增强版
现在在配置文件中写死了转发路径的地址, 前面我们已经分析过地址写死带来的问题, 接下来我们从 注册中心获取此地址。
第1步：加入nacos依赖
com.alibaba.cloud
spring-cloud-starter-alibaba-nacos-discovery
第2步：在主类上添加注解
@SpringBootApplication
@EnableDiscoveryClient
public class ApiGatewayApplication {
public static void main(String[] args) {
SpringApplication.run(ApiGatewayApplication.class);
}
}
第三步：修改配置文件
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
routes:
- id: product_route
uri: lb://shop-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略 loadbalance
predicates:
- Path=/product-serv/**
filters:
- StripPrefix=1
第4步：测试是否可用
测试结果：
发现通过http://localhost:7000/product-serv/product/get/1可以随机访问商品微服务中的某个实例了
简化版
第一步：去掉关于路由的配置
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true # 让gateway可以发现nacos中的微服务
注意： spring cloud alibaba 2021.1需要额外导入
org.springframework.cloud spring-cloud-starter-loadbalancer
第2步: 启动项目，并通过网关去访问微服务
从控制台查看所访问的端口
这时候，就发现只要按照网关地址/微服务/接口的格式去访问，就可以得到成功响应。
跨域请求
Spring Cloud Gateway还针对跨域访问做了设计，可以使用以下配置解决跨域访问问题：
spring:
cloud:
gateway:
# 跨域
globalcors:
corsConfigurations:
'[/**]':
allowedHeaders: "*"
allowedOrigins: "*"
allowedMethods: "*"
allowedHeaders: 头部允许字段
allowedOrigins:允许地址
allowedMethods:允许请求方法
二，Gateway核心架构
基本概念
路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个 信息:
id，路由标识符，区别于其他 Route。
uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。
order，用于多个 Route 之间的排序，数值越小排序越靠前，匹配优先级越高。
predicate，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。
filter，过滤器用于修改请求和响应信息。
执行流程
执行流程大体如下：
Gateway Client向Gateway Server发送请求
请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文
然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给 RoutePredicateHandlerMapping
RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用
如果该断言成功，由FilteringWebHandler创建过滤器链并调用
请求会依次经过PreFilter--微服务--PostFilter的方法，最终返回响应
三，断言
Predicate(断言, 谓词) 用于进行条件判断，只有断言都返回真，才会真正的执行路由。 断言就是说: 在 什么条件下 才能进行路由转发
内置路由断言工厂
SpringCloud Gateway包括许多内置的断言工厂，所有这些断言都与HTTP请求的不同属性匹配。具体 如下：
spring官网
例举如下
基于Datetime类型的断言工厂
此类型的断言根据时间做判断，主要有三个： AfterRoutePredicateFactory： 接收一个日期参数，判断请求日期是否晚于指定日期 BeforeRoutePredicateFactory： 接收一个日期参数，判断请求日期是否早于指定日期 BetweenRoutePredicateFactory： 接收两个日期参数，判断请求日期是否在指定时间段内
-After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]
基于远程地址的断言工厂
RemoteAddrRoutePredicateFactory：
接收一个IP地址段，判断请求主 机地址是否在地址段中
-RemoteAddr=192.168.1.1/24
基于Cookie的断言工厂
CookieRoutePredicateFactory：
接收两个参数，cookie 名字和一个正则表达式。 判断请求 cookie是否具有给定名称且值与正则表达式匹配。
-Cookie=chocolate, ch.
基于Header的断言工厂
HeaderRoutePredicateFactory：
接收两个参数，标题名称和正则表达式。 判断请求Header是否 具有给定名称且值与正则表达式匹配。
-Header=X-Request-Id, \d+
基于Host的断言工厂
HostRoutePredicateFactory：
接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。
-Host=.testhost.org
基于Method请求方法的断言工厂
MethodRoutePredicateFactory：
接收一个参数，判断请求类型是否跟指定的类型匹配。
-Method=GET
基于Path请求路径的断言工厂
PathRoutePredicateFactory：
接收一个参数，判断请求的URI部分是否满足路径规则。
-Path=/foo/{segment}
基于Query请求参数的断言工厂
QueryRoutePredicateFactory ：
接收两个参数，请求param和正则表达式， 判断请求参数是否具 有给定名称且值与正则表达式匹配。
-Query=baz, ba.
基于路由权重的断言工厂
WeightRoutePredicateFactory：
接收一个[组名,权重], 然后对于同一个组内的路由按照权重转发
routes:
-id: weight_route1 uri: host1 predicates:
-Path=/product/
-Weight=group3, 1
-id: weight_route2 uri: host2 predicates:
-Path=/product/**
-Weight= group3, 9
如何使用内置路由断言工厂
接下来我们验证几个内置断言的使用:
修改配置文件
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true # 让gateway可以发现nacos中的微服务
routes:
- id: product_route
uri: lb://shop-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略
predicates: #添加了处罚路由跳转的条件
- Path=/product-serv/**
- Query=name,lj.
- Method=POST #限制请求方式为POST
filters:
- StripPrefix=1
第一种访问路径成功
第二种访问路径失败
原因：设置了路由成功的条件
将第二种路径放入测试格局中调整
自定义路由断言工厂
我们来设定一个场景: 假设我们的应用仅仅让age在(min,max)之间的人来访问。
第1步：在配置文件中,添加一个Age的断言配置
第2步：自定义一个断言工厂, 实现断言方法
package com.ljj.apigateway.predicates; import lombok.Data; import lombok.NoArgsConstructor; import org.apache.commons.lang3.StringUtils; import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory; import org.springframework.stereotype.Component; import org.springframework.web.server.ServerWebExchange; import java.util.Arrays; import java.util.List; import java.util.function.Predicate; //这是一个自定义的路由断言工厂类,要求有两个 //1 名字必须是 配置+RoutePredicateFactory //2 必须继承AbstractRoutePredicateFactory<配置类> @Component public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory{ public AgeRoutePredicateFactory() { super(AgeRoutePredicateFactory.Config.class); } //用于从配置文件中获取参数值赋值到配置类中的属性上 @Override public List shortcutFieldOrder() { //这里的顺序要跟配置文件中的参数顺序一致 return Arrays.asList("minAge", "maxAge"); } //断言 @Override public Predicate apply(AgeRoutePredicateFactory.Config config) { return new Predicate () { @Override public boolean test(ServerWebExchange serverWebExchange) { //从serverWebExchange获取传入的参数 String ageStr = serverWebExchange.getRequest().getQueryParams().getFirst("age"); if (StringUtils.isNotEmpty(ageStr)) { int age = Integer.parseInt(ageStr); return age > config.getMinAge() && age < config.getMaxAge(); }esle{ return false; } }; } //配置类,用于接收配置文件中的对应参数 @Data @NoArgsConstructor public static class Config { private int minAge;//18 private int maxAge;//60 } }
pom.xml相关配置
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
Spcloud
com.ljj
1.0-SNAPSHOT
4.0.0
api-gateway
org.apache.maven.plugins
maven-compiler-plugin
8
8
org.springframework.cloud
spring-cloud-starter-gateway
com.alibaba.cloud
spring-cloud-starter-alibaba-nacos-discovery
org.projectlombok
lombok
org.apache.commons
commons-lang3
3.7
在父工程中添加进去
测试：如果age在18与60之间才能路由成功
不传参会失败
参数等于18也会失败
参数在18到60之间即可
等于60也不通过
