文章目录
- 一、什么是网关
- 二、网关工作原理 (★)
- 三、SpringCloud Gateway
- 3.1 Gateway 简介
- 3.2 Gateway 环境搭建
- 3.3 自定义路由规则 (★)
- 3.4 局部过滤器
- 3.5 全局过滤器（案例：获取用户真实IP地址） (★)
- 补充1：不同类型的客户端如何设置网关
- 补充2：多个全局多滤器的执行优先级
- 补充3：局部过滤器和全局过滤器的执行优先级
一、什么是网关
在微服务架构中，⼀个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。
这样的架构，会存在着诸多的问题：
- 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性。
- 认证复杂，每个服务都需要独立认证。
- 微服务做集群的情况下，客户端并没有负载均衡的功能。
上面的这些问题可以借助 API 网关来解决。
API 网关指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统⼀服务，⼀些与业务本身功能无关的公共逻辑可以在这里实现，如：认证、鉴权、监控、路由转发等等。
添加上 API 网关之后，系统的架构图变成了如下所示：
二、网关工作原理 (★)
网关本身也是个微服务，服务注册中心以后，将注册中心的服务列表拉取到本地缓存，并配置相应的路由规则，如下图所示：
网关组件提供统一请求入口，可以进行统一逻辑的处理，并提供网络隔离的能力（即请求只能通过网关来访问，不能通过某一个服务的IP地址绕过网关来访问）。
当浏览器发起请求http://192.168.10.115/product-serv/product/1，
step1：网关获取到请求地址，默认截取域名后面的部分请求路径 /product-serv/product/1
step2：拿到路径信息和路由规则进行匹配，可以获取到对应的服务名product-service
step3：拿到服务名在本地的缓存列表中找到对应的IP地址列表，基于 Ribbon 实现负载均衡算法得出 IP 地址。
step4：进行 URL 地址拼接 http://192.168.10.110/product/1，最终进行网络的调用。
三、SpringCloud Gateway
3.1 Gateway 简介
Spring Cloud Gateway 是 Spring 公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术开发的网关，它旨在为微服务架构提供⼀种简单有效的统⼀的 API 路由管理方式。它的目标是替代 Netflflix Zuul，其不仅提供统⼀的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。
Spring Cloud Gateway 存在诸多优点，如：性能强劲、功能强大、易扩展，其内置了很多实用的功能，例如转发、监控、限流等。但也存在缺点，如：不能将其部署在 Tomcat、Jetty 等 Servlet 容器里，只能打成 jar 包执行，需要 Spring Boot 2.0及以上的版本才支持等。
3.2 Gateway 环境搭建
1、创建一个 api-gateway 的模块，导入相关依赖：
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.axy</groupId>
<artifactId>shop-parent</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>api-gateway</artifactId>
<name>api-gateway</name>
<dependencies>
<!--gateway⽹关-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos客户端-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
...
</dependencies>
<build>
<finalName>api-gateway</finalName>
</build>
</project>
2、编写启动类
@SpringBootApplication
@EnableDiscoveryClient
public class ApiGateWayServer {
public static void main(String[] args) {
SpringApplication.run(ApiGateWayServer.class, args);
}
}
3、编写配置⽂件
server:
port: 9000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true # 让gateway可以发现nacos中的微服务
注：spring.cloud.gateway.discovery.locator.enabled=true 的作用是让 Gateway 开启服务注册和发现的功能，并且为每一个微服务创建一个默认的路由，该路由将以服务名开头的请求路径转发到对应的服务。如：/product-service/** 转发到 product-service 的服务下。
4、启动测试
3.3 自定义路由规则 (★)
gateway 提供了默认的路由规则，但也支持自定义规则，具体属性如下：
① id：路由标识符，区别于其他 Route。
② uri：路由指向的目的地 uri，即客户端请求最终被转发到的微服务
③ order：用于多个 Route 之间的排序，数值越小排序越靠前，匹配优先级越高
④ predicate：断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由
⑤ filters：过滤器用于修改请求和响应信息
server:
port: 9000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true # 让gateway可以发现nacos中的微服务
routes: # 自定义路由配置
- id: product_route # 路由名称，保证唯一
uri: lb://product-service # 将符合条件的请求转发到哪个微服务，lb表示对服务进行负载均衡
predicates: # 拦截哪些请求
- Path=/product-serv/**
filters: # 前台访问：http://localhots:9000/product-service/product/1 去掉第一层以后路径以后，http://product-service/product/1
- StripPrefix=1 # 在转发请求之前，将拦截到的第一层路径删除掉
- id: order_route
uri: lb://order-service
predicates:
- Path=/order-serv/**
filters:
- StripPrefix=1
注：StripPrefix=1 表示在请求转发请求之前，将拦截到的第一层路径删除掉。
如：前台访问http://localhots:9000/product-service/product/1 去掉第一层以后路径以后变成 http://product-service/product/1
启动测试：
3.4 局部过滤器
局部过滤器是针对单个路由（或者单个服务）的过滤器，用以添加针对某一个服务的独立功能。下面以需求的形式讲解一下如何配置局部过滤器。
需求：统计订单服务调用耗时。
编写Filter类，注意名称是有固定格式 xxxGatewayFilterFactory。如下面设置 filters 的属性 Time=true，则编写局部过滤器的类名为 TimeGatewayFilterFactory。
继承 AbstractGatewayFilterFactory<TimeGatewayFilterFactory.Config> 类，其中 Config 类是该类的内部类用于承接配置文件中配置的值，重写 shortcutFieldOrder、apply 两个方法。
/**
* 局部过滤器
*/
@Component
public class TimeGatewayFilterFactory extends AbstractGatewayFilterFactory<TimeGatewayFilterFactory.Config> {
public TimeGatewayFilterFactory() {
super(Config.class);
}
// 读取配置⽂件中的参数赋值到配置类 Config 中
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList("show");
}
// 拦截到之后就会调用 apply 方法，把创建对象时候反射创建出来的 Config 传入进来
@Override
public GatewayFilter apply(Config config) {
return new GatewayFilter() {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 前置的逻辑
if (!config.show) {
return chain.filter(exchange);
}
System.out.println("前置逻辑");
long start = System.currentTimeMillis();
// exchange相当于request
return chain.filter(exchange).then(Mono.fromRunnable(() -> {
long end = System.currentTimeMillis();
System.out.println("请求耗时：" + (end - start));
// 后置的逻辑
System.out.println("后置逻辑");
}));
}
};
}
@Setter
@Getter
static class Config {
private boolean show;
}
}
注：其中 Config 作为内部类，是通过反射将配置文件里面的值设置到对应的属性上。如：配置文件中配置 Time=true，则 show 的值最终为 true。另外， shortcutFieldOrder() 方法的返回值是数组，其用于指定反射时的设置顺序。
如假设：配置文件Time=true,1,hello ，那么 Config 的设置应该有三个值，并且属性名与shortcutFieldOrder() 返回值的数组元素的 “名称” 一一对应，如下：
@Component
public class TimeGatewayFilterFactory extends AbstractGatewayFilterFactory<TimeGatewayFilterFactory.Config> {
public TimeGatewayFilterFactory() {
super(Config.class);
}
// 读取配置⽂件中的参数赋值到配置类 Config 中
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList("show", "xx", "yy");
}
...
@Setter
@Getter
static class Config {
private boolean show;
private Long xx;
private String yy;
}
}
访问订单服务的时候打印时间如下：
3.5 全局过滤器（案例：获取用户真实IP地址） (★)
全局过滤器作用于所有路由，无需配置文件配置。通过全局过滤器可以实现对权限的统⼀校验，安全性验证等功能。下面以需求的形式讲解一下如何配置局部过滤器：
需求：实现统⼀鉴权的功能，需要在网关判断请求中是否包含token，如果有则还需要在请求头中设置用户的IP地址，则执行正常逻辑。实现代码如下：
/**
* 全局过滤器
*/
@Component
public class AuthGlobalFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("全局过滤器前置过滤器");
// 获取到请求中的token信息，验证token是否有效，如果无效拦截请求
String token = exchange.getRequest().getQueryParams().getFirst("token");
if (StringUtils.isEmpty(token) || !"123".equals(token)) {
System.out.println("鉴权失败");
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
ServerHttpRequest request = exchange.getRequest().mutate().header("REAL_IP", exchange.getRequest().getRemoteAddress().getHostString()).build();
return chain.filter(exchange.mutate().request(request).build()).then(Mono.fromRunnable(new Runnable() {
@Override
public void run() {
System.out.println("全局过滤器后置过滤器");
}
}));
}
}
这里解释以下，为何要在网关获取用户的地址，因为当请求通过网关转发到微服务后使用 Request.getRomteAddr()获取到的只是网关的地址，因此需要在网关侧获取真实IP。
另外：鉴权逻辑一般放在拦截器中实现，后面将会详细说明。
补充1：不同类型的客户端如何设置网关
由于不同类型客户端访问微服务时，有些公共逻辑会存在差异，如：第三方访问时有限流的操作等。因此建议针对不同端，设置不同的网关。
补充2：多个全局多滤器的执行优先级
多个全局多滤器最终都是通过Order值进行排序执行，Order值越小越先执行。
两个全局过滤器Order值相同时，根据文件名字母排序，文件名靠前的优先更高。原因是包扫描时是按照文件的顺序扫描的，然后封装到List集合的，通过Order值排序时如果Order值相同，文件名在前名的依然会排在前面。
但也可以实现Ordered接口，重写 getOrder() 方法，以 Order 进行排序，Order 越小优先级越高。
@Component
public class AuthGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
...
}
@Override
public int getOrder() {
return 2;
}
}
补充3：局部过滤器和全局过滤器的执行优先级
多滤器最终都是通过Order值进行排序执行，Order值越小越先执行。
全局过滤器和局部过滤器Order值相同时，GlobalFilter类型优先更高。
原因是这两种过滤器最终会合并到一个过滤器集合中形成过滤器调用链，源码是通过 list.addAll(); 方法将局部过滤器加到了全局过滤器集合中，addAll()是末尾添加方式，所以 Order 值相同时局部过滤器会排在后面。
参考：https://blog.csdn.net/Anenan/article/details/114691488
文章参考：Java微服务商城高并发秒杀项目实战|Spring Cloud Alibaba真实项目实战+商城双11秒杀+高并发+消息+支付+分布式事物Seata
