SpringCloud--Gateway网关
目录
1.网关简介
2.Gateway简介
3.Gateway入门案例
3.1基础版
1.创建一个shop-gateway的工程并加入依赖
2.创建启动类
3.修改配置文件
4.启动项目, 并通过网关去访问微服务
3.2增强版
第1步：加入nacos依赖
第二步：修改配置文件
3.3简写版 也就是配置自动路由
第1步: 去掉关于路由的配置
第2步: 启动项目，并通过网关去访问微服务
4.Gateway核心架构
4.1基本概念
4.2 执行流程
5. 断言
5.1内置路由断言工厂
5.1.1 测试
5.2 自定义路由断言工厂
第1步：在配置文件中,添加一个Age的断言配置
第2步：自定义一个断言工厂, 实现断言方法
第3步：启动测试
6.过滤器
6.1局部过滤器
6.2全局过滤器
6.2.1 内置全局过滤器
6.2.2自定义全局过滤器
1.网关简介
大家都都知道在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端（pc androud ios 平板）要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。 axios.get(ip:port/url) axios.get(ip:port/url)
这样的架构，会存在着诸多的问题：
- 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
- 认证复杂，每个服务都需要独立认证。
- 存在跨域请求，在一定场景下处理相对复杂。
- （跨域: 浏览器的ajax从一个地址访问另一个地址： 协议://ip:port 如果三则有一个不同，则会出现跨域问题。 http://192.168.10.11:8080 ----->https://192.168.10.11:8080
http://127.0.0.1:8080--->http://localhost:8080 跨域）
上面的这些问题可以借助API网关来解决。
所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服 务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控（黑白名单）、路由转发等等。 添加上API网关之后，系统的架构图变成了如下所示：
在业界比较流行的网关，有下面这些：
- Ngnix+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用
lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本
- Kong
基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题：
只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。
- Zuul 1.0（慢 servlet 2.0 ） zuul2.0 没出来。
Netflix开源的网关，功能丰富，使用JAVA开发，易于二次开发 问题：缺乏管控，无法动态配
置；依赖组件较多；处理Http请求依赖的是Web容器，性能不如Nginx
- Spring Cloud Gateway
Spring公司为了替换Zuul而开发的网关服务，将在下面具体介绍。
注意：SpringCloud alibaba技术栈中并没有提供自己的网关，我们可以采用Spring Cloud Gateway来做网关
2.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包执行 web.Jar
- 需要Spring Boot 2.0及以上的版本，才支持
gateway内置了服务器 netty服务器。所以不需要引入web依赖
3.Gateway入门案例
3.1基础版
1.创建一个shop-gateway的工程并加入依赖
org.springframework.cloud
spring-cloud-starter-gateway
2.创建启动类
package com.lzl;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @create 2022-08-21
*/
@SpringBootApplication
public class GatewayApp {
public static void main(String[] args) {
SpringApplication.run(GatewayApp.class,args);
}
}
3.修改配置文件
server:
port: 7000
spring:
application:
name: shop-gateway
#路由转发
cloud:
gateway:
routes:
- id: shop-product
uri: localhost:8081
predicates:
- Path=/product/**
# - Method=GET
# - RemoteAddr=192.168.31.182
- id: shop-order
uri: localhost:8091
predicates:
- Method=GET
- Path=/order/**
filters:
- SetStatus=250
nacos:
discovery:
server-addr: localhost:8848
4.启动项目, 并通过网关去访问微服务
3.2增强版
现在在配置文件中写死了转发路径的地址, 前面我们已经分析过地址写死带来的问题, 接下来我们从注册中心获取此地址。
第1步：加入nacos依赖
dependency>
com.alibaba.cloud
spring-cloud-alibaba-nacos-discovery
第二步：修改配置文件
3.3简写版 也就是配置自动路由
第1步: 去掉关于路由的配置
server:
port: 7000
spring:
application:
name: shop-gateway
# 配置api
cloud:
nacos:
discovery:
server-addr: localhost:8848
#是否开启定位发现
gateway:
discovery:
locator:
enabled: true 第2步: 启动项目，并通过网关去访问微服务
这时候，就发现只要按照网关地址/微服务/接口的格式去访问，就可以得到成功响应
4.Gateway核心架构
4.1基本概念
路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:
- id，路由标识符，区别于其他 Route。默认生成一个
- uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。
- order，用于多个 Route 之间的排序，数值越小排序越靠前，匹配优先级越高。
- predicate，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。
- filter，过滤器用于修改请求和响应信息。
4.2 执行流程
执行流程大体如下：
1. Gateway Client向Gateway Server发送请求
2. 请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文
3. 然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给 RoutePredicateHandlerMapping
4. RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用
5. 如果过断言成功，由FilteringWebHandler创建过滤器链并调用
6. 请求会一次经过PreFilter--微服务--PostFilter的方法，最终返回响应
5. 断言
Predicate(断言, 谓词) 用于进行条件判断，只有断言都返回真，才会真正的执行路由。
断言就是说: 在 什么条件下 才能进行路由转发
5.1内置路由断言工厂
SpringCloud Gateway包括许多内置的断言工厂，所有这些断言都与HTTP请求的不同属性匹配体如下：
- 基于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是否
具有给定名称且值与正则表达式匹配。 key value
-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
5.1.1 测试
server:
port: 7000
spring:
application:
name: shop-gateway
#路由转发
cloud:
gateway:
routes:
- id: shop-product
uri: lb://shop-product
predicates:
- Path=/product/**
# - Method=GET
# - RemoteAddr=192.168.31.182 //只有该IP 才能访问
- id: shop-order
uri: lb://shop-order
predicates:
- Method=GET # 请求方式必须为GET
- Path=/order/** #请求是 /order/** 才会转发
filters:
- SetStatus=250
nacos:
discovery:
server-addr: localhost:8848
# 是否开启定位发现
# gateway:
# discovery:
# locator:
# enabled: true
5.2 自定义路由断言工厂
我们来设定一个场景: 假设我们的应用仅仅让age在(min,max)之间的人来访问。
第1步：在配置文件中,添加一个Age的断言配置
routes:
- id: shop-product # 路由的唯一标识，只要不重复都可以，如果不写默认会通过UUID产生，一般写成被路由的服务名称
uri: lb://shop-product # 被路由的地址
order: 1 #表示优先级 数字越小优先级越高
predicates: #断言: 执行路由的判断条件
- Path=/product_serv/**
- Age=18,60第2步：自定义一个断言工厂, 实现断言方法
@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory {
public AgeRoutePredicateFactory() {
super(AgeRoutePredicateFactory.Config.class);
}
//读取配置文件中的内容并配置给配置类中的属性
public List shortcutFieldOrder() {
return Arrays.asList("minAge","maxAge");
}
public Predicate apply(AgeRoutePredicateFactory.Config config) {
return (exchange) -> {
String age = exchange.getRequest().getQueryParams().getFirst("age");
if(StringUtils.isNotEmpty(age)){
int a = Integer.parseInt(age);
return a>=config.minAge && a<=config.maxAge;
}
return true;
};
}
@Data
@NoArgsConstructor
public static class Config{
private Integer minAge;
private Integer maxAge;
}
} 第3步：启动测试
#测试发现当age在(18,60)可以访问,其它范围不能访问
http://localhost:7000/product-serv/product/1?age=30
http://localhost:7000/product-serv/product/1?age=10
6.过滤器
三个知识点:
1 作用: 过滤器就是在请求的传递过程中,对请求和响应做一些手脚
2 生命周期: Pre Post
3 分类: 局部过滤器(作用在某一个路由上) 全局过滤器(作用全部路由上)
在Gateway中, Filter的生命周期只有两个：“pre” 和 “post”。
- PRE： 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
- POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。
Gateway 的Filter从作用范围可分为两种: GatewayFilter与GlobalFilter。
- GatewayFilter：应用到单个路由或者一个分组的路由上。
- GlobalFilter：应用到所有的路由上。
6.1局部过滤器
局部过滤器是针对单个路由的过滤器。
6.2全局过滤器
全局过滤器作用于所有路由, 无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。
6.2.1 内置全局过滤器
SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下：
6.2.2自定义全局过滤器
内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。
开发中的鉴权逻辑：
- 当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
- 认证通过，将用户信息进行加密形成token，返回给客户端aaaa，作为登录凭证
- 以后每次请求，客户端都携带认证的token
- 服务端对token进行解密，判断是否有效。
如上图，对于验证用户是否已经登录鉴权的过程可以在网关统一检验。
检验的标准就是请求中是否携带token凭证以及token的正确性。
下面的我们自定义一个GlobalFilter，去校验所有请求的请求参数中是否包含“token”，如何不包含请求参数“token”则不转发路由，否则执行正常的逻辑
自定义全局过滤器 要求：必须实现GlobalFilter,Ordered接口
package com.lzl.filter;
import com.alibaba.fastjson.JSON;
import com.lzl.entity.Anno;
import io.netty.util.internal.StringUtil;
import org.checkerframework.checker.units.qual.A;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.RequestPath;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
/**
* @create 2022-08-21
*/
@Component
public class LoginFilter implements GlobalFilter, Ordered {
@Autowired
private Anno anno;
//过滤方法 过滤业务
@Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
ServerHttpRequest request = exchange.getRequest();
ServerHttpResponse response = exchange.getResponse();
//0.获取路径
String path = request.getPath().toString();
//1.判断当前的请求路径是否为放行路径
if (anno.getUrl().contains(path)){
return chain.filter(exchange);//放行
}
//2.判断是否携带token
String token = response.getHeaders().getFirst("token");
if (StringUtils.hasText(token)&&"admin".equals(token)){
return chain.filter(exchange);//放行
}
//3.返回一个json数据
response.setStatusCode(HttpStatus.UNAUTHORIZED);
//3.1设置状态吗
Map map = new HashMap<>();
map.put("msg","未登录");
map.put("code",4000);
byte[] bytes = JSON.toJSONString(map).getBytes(StandardCharsets.UTF_8);
DataBuffer wrap = response.bufferFactory().wrap(bytes);
return response.writeWith(Mono.just(wrap));
}
@Override
// 优先级 值越小优先级越高
public int getOrder() {
return 0;
}
}