SpringCloudAlibaba进阶：Gateway——服务网关

推荐阅读

Spring Cloud Alibaba微服务架构学习路线笔记

网关简介

大家都都知道在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。

这样的架构，会存在着诸多的问题：

• 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性

• 认证复杂，每个服务都需要独立认证。

• 存在跨域请求，在一定场景下处理相对复杂。

上面的这些问题可以借助API网关来解决。

所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等等。

添加上API网关之后，系统的架构图变成了如下所示：

我们也可以观察下，我们现在的整体架构图：

在业界比较流行的网关，有下面这些：

• Ngnix+lua：使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用，lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本

• Kong：基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题：只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。

• Zuul ：Netflflix开源的网关，功能丰富，使用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 路由管理方式。它的目标是替代Netflflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

优点：

• 性能强劲：是第一代网关Zuul的1.6倍

• 功能强大：内置了很多实用的功能，例如转发、监控、限流等

• 设计优雅，容易扩展

缺点：

• 其实现依赖Netty与WebFlux，不是传统的Servlet编程模型，学习成本高

• 不能将其部署在Tomcat、Jetty等Servlet容器里，只能打成jar包执行

• 需要Spring Boot 2.0及以上的版本，才支持

Gateway快速入门

要求: 通过浏览器访问api网关,然后通过网关将请求转发到商品微服务

基础版

第1步：创建一个 api-gateway 的模块,导入相关依赖

<?xml version="1.0" encoding="UTF-8"?> 

<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/xsd/maven-4.0.0.xsd"> 

<parent> 

<artifactId>springcloud-alibaba</artifactId> 

<groupId>com.itheima</groupId> 

<version>1.0-SNAPSHOT</version> 

</parent> 

<modelVersion>4.0.0</modelVersion> 

<artifactId>api-gateway</artifactId> 

<dependencies> 

<!--gateway网关--> 

<dependency>

<groupId>org.springframework.cloud</groupId> 

<artifactId>spring-cloud-starter-gateway</artifactId> 

</dependency> 

</dependencies> 

</project>

第2步: 创建主类

package com.itheima; 

@SpringBootApplication 

public class GatewayApplication { 

public static void main(String[] args) { 

SpringApplication.run(GatewayApplication.class, args); 

} 

}

第3步: 添加配置文件

server: 

port: 7000 

spring: 

application: 

name: api-gateway 

cloud: 

gateway: 

routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务] 

\- id: product_route # 当前路由的标识, 要求唯一 

uri: http://localhost:8081 # 请求要转发到的地址 

order: 1 # 路由的优先级,数字越小级别越高 

predicates: # 断言(就是路由转发要满足的条件) 

\- Path=/product-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发 

filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改 

\- StripPrefix=1 # 转发之前去掉1层路径

第4步: 启动项目, 并通过网关去访问微服务

增强版

第1步：加入nacos依赖

<!--nacos客户端--> 

<dependency> 

<groupId>com.alibaba.cloud</groupId> 

<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 

</dependency> 

第2步：在主类上添加注解

@SpringBootApplication 

@EnableDiscoveryClient 

public class ApiGatewayApplication { 

public static void main(String[] args) { 

SpringApplication.run(ApiGatewayApplication.class, args); 

} 

} 

第3步：修改配置文件

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://service-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均 

衡策略 

predicates: 

\- Path=/product-serv/** 

filters: 

\- StripPrefix=1 

第4步:测试

简写版

第1步: 去掉关于路由的配置

server: 

port: 7000 

spring: 

application: 

name: gateway 

cloud: 

nacos: 

discovery: 

server-addr: 127.0.0.1:8848 

gateway: 

discovery: 

locator: 

enabled: true

第2步: 启动项目，并通过网关去访问微服务

这时候，就发现只要按照网关地址微服务接口的格式去访问，就可以得到成功响应。

Gateway核心架构

基本概念

路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

• id，路由标识符，区别于其他 Route。

• uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。

• order，用于多个 Route 之间的排序，数值越小排序越靠前，匹配优先级越高。

• predicate，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。

• fifilter，过滤器用于修改请求和响应信息。

执行流程

执行流程大体如下：

1. Gateway Client向Gateway Server发送请求

2. 请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文

3. 然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给RoutePredicateHandlerMapping

4. RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用

5. 如果过断言成功，由FilteringWebHandler创建过滤器链并调用

6. 请求会一次经过PreFilter--微服务-PostFilter的方法，最终返回响应

断言

Predicate(断言, 谓词) 用于进行条件判断，只有断言都返回真，才会真正的执行路由。

断言就是说: 在 什么条件下 才能进行路由转发

内置路由断言工厂

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是否具有给定名称且值与正则表达式匹配。

-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 

routes: 

\- id: product_route 

uri: lb://service-product 

predicates: 

\- Path=/product-serv/** 

\- Before=2019-11-28T00:00:00.000+08:00 #限制请求时间在2019-11-28之前 

\- Method=POST #限制请求方式为POST 

filters: 

\- StripPrefix=1

自定义路由断言工厂

我们来设定一个场景: 假设我们的应用仅仅让age在(min,max)之间的人来访问。

第1步：在配置文件中,添加一个Age的断言配置

spring: 

application: 

name: api-gateway 

cloud: 

nacos: 

discovery: 

server-addr: 127.0.0.1:8848 

gateway: 

discovery: 

locator: 

enabled: true 

routes: 

\- id: product-route 

uri: lb://service-product 

predicates: 

\- Path=/product-serv/** 

\- Age=18,60 # 限制年龄只有在18到60岁之间的人能访问 

filters: 

\- StripPrefix=1 

第2步：自定义一个断言工厂, 实现断言方法

package com.itheima.predicates; 

//泛型 用于接收一个配置类,配置类用于接收中配置文件中的配置 

@Component 

public class AgeRoutePredicateFactory 

extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> { 

public AgeRoutePredicateFactory() { 

super(AgeRoutePredicateFactory.Config.class); 

}

//用于从配置文件中获取参数值赋值到配置类中的属性上 

@Override 

public List<String> shortcutFieldOrder() { 

//这里的顺序要跟配置文件中的参数顺序一致 

return Arrays.asList("minAge", "maxAge"); 

}

//断言 

@Override 

public Predicate<ServerWebExchange> apply(AgeRoutePredicateFactory.Config 

config) {

return new Predicate<ServerWebExchange>() { 

@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(); 

}

return true; 

} 

}; 

} 

}

//自定义一个配置类, 用于接收配置文件中的参数 

@Data 

class Config { 

private int minAge; 

private int maxAge; 

}

第4步：启动测试

\#测试发现当age在(20,60)可以访问,其它范围不能访问 

http://localhost:7000/product-serv/product/1?age=30 

http://localhost:7000/product-serv/product/1?age=10

过滤器

三个知识点:

1. 作用: 过滤器就是在请求的传递过程中,对请求和响应做一些手脚

2. 生命周期: Pre Post

3. 分类: 局部过滤器(作用在某一个路由上) 全局过滤器(作用全部路由上)

在Gateway中, Filter的生命周期只有两个：“pre” 和 “post”。

• PRE： 这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

• POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

Gateway 的Filter从作用范围可分为两种: GatewayFilter与GlobalFilter。

• GatewayFilter：应用到单个路由或者一个分组的路由上。

• GlobalFilter：应用到所有的路由上。

局部过滤器

局部过滤器是针对单个路由的过滤器。

内置局部过滤器

在SpringCloud Gateway中内置了很多不同类型的网关路由过滤器。具体如下：

过滤器工厂	作用	参数
AddRequestHeader	为原始请求添加Header	Header的名称及值
AddRequestParameter	为原始请求添加请求参数	参数名称及值
AddResponseHeader	为原始响应添加Header	Header的名称及值
DedupeResponseHeader	剔除响应头中重复的值	需要去重的Header名称及去重策略
Hystrix	为路由引入Hystrix的断路器保护	HystrixCommand的名称
FallbackHeaders	为fallbackUri的请求头中添加具体的异常信息	Header的名称
PrefixPath	为请求添加一个 preserveHostHeader=true的属性，路由过滤器会检查该属性以决定是否要发送原始的Host	无
RequestRateLimiter	用于对请求限流，限流算法为令牌桶	keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatus
RedirectTo	将原始请求重定向到指定的URL	http状态码及重定向的 url
RemoveHopByHopHeadersFilter	为原始请求删除IETF组织规定的 一系列Header	默认就会启用，可以通 过配置指定仅删除哪些 Header
RemoveResponseHeader	为原始请求删除某个Header	Header名称
RemoveRequestHeader	为原始请求删除某个Header	Header名称
RewritePath	重写原始的请求路径	原始路径正则表达式以 及重写后路径的正则表达式
RewriteResponseHeader	重写原始响应中的某个Header	Header名称，值的正 则表达式，重写后的值
SaveSession	在转发请求之前，强制执行 WebSession::save操作	无
secureHeaders	为原始响应添加一系列起安全作用的响应头	无，支持修改这些安全 响应头的值
SetPath	修改原始的请求路径	修改后的路径
SetResponseHeader	修改原始响应中某个Header的值	Header名称，修改后的值
SetStatus	修改原始响应的状态码	HTTP 状态码，可以是 数字，也可以是字符串
StripPrefix	用于截断原始请求的路径	使用数字表示要截断的 路径的数量
Retry	针对不同的响应进行重试	retries、statuses、 methods、series
RequestSize	设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回 413 Payload Too Large	请求包大小，单位为字 节，默认值为5M
ModifyRequestBody	在转发请求之前修改原始请求体内容	修改后的请求体内容
ModifyResponseBody	修改原始响应体的内容	修改后的响应体内容
内置局部过滤器的使用

server: 

port: 7000 

spring: 

application: 

name: api-gateway 

cloud: 

nacos: 

discovery: 

server-addr: localhost:8848 

gateway: 

discovery: 

locator: 

enabled: true 

routes: 

\- id: product_route 

uri: lb://service-product 

order: 1 

predicates: 

\- Path=/product-serv/** 

filters: 

\- StripPrefix=1 

\- SetStatus=2000 # 修改返回状态

自定义局部过滤

第1步：在配置文件中,添加一个Log的过滤器配置

spring: 

application: 

name: gateway 

cloud: 

nacos: 

discovery: 

server-addr: 127.0.0.1:8848 

gateway: 

discovery: 

locator: 

enabled: true 

routes: 

\- id: consumer 

order: -1 

uri: lb://consumer 

predicates: 

\- Path=/consumer-serv/** 

filters: 

\- StripPrefix=1 

\- Log=true,false # 控制日志是否开启

第2步：自定义一个过滤器工厂,实现方法

//自定义局部过滤器 

@Component 

public class LogGatewayFilterFactory 

extends AbstractGatewayFilterFactory<LogGatewayFilterFactory.Config> { 

//构造函数 

public LogGatewayFilterFactory() { 

super(LogGatewayFilterFactory.Config.class); 

}

//读取配置文件中的参数 赋值到 配置类中 

@Override 

public List<String> shortcutFieldOrder() { 

return Arrays.asList("consoleLog", "cacheLog"); 

}

//过滤器逻辑 

@Override 

public GatewayFilter apply(LogGatewayFilterFactory.Config config) { 

return new GatewayFilter() { 

@Override 

public Mono<Void> filter(ServerWebExchange exchange, 

GatewayFilterChain chain) { 

if (config.isCacheLog()) {

System.out.println("cacheLog已经开启了...."); 

}

if (config.isConsoleLog()) { 

System.out.println("consoleLog已经开启了...."); 

}

return chain.filter(exchange); 

} 

}; 

}

//配置类 接收配置参数 

@Data 

@NoArgsConstructor 

public static class Config { 

private boolean consoleLog; 

private boolean cacheLog; 

}

第3步：启动测试

全局过滤器

全局过滤器作用于所有路由, 无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。

内置全局过滤器

SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下：

自定义全局过滤器

内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。

开发中的鉴权逻辑：

• 当客户端第一次请求服务时，服务端对用户进行信息认证（登录）

• 认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证

• 以后每次请求，客户端都携带认证的token

• 服务端对token进行解密，判断是否有效。

  

如上图，对于验证用户是否已经登录鉴权的过程可以在网关统一检验。

检验的标准就是请求中是否携带token凭证以及token的正确性。

下面的我们自定义一个GlobalFilter，去校验所有请求的请求参数中是否包含“token”，如何不包含请求参数“token”则不转发路由，否则执行正常的逻辑。

package com.itheima.filters; 

//自定义全局过滤器需要实现GlobalFilter和Ordered接口 

@Component 

public class AuthGlobalFilter implements GlobalFilter, Ordered { 

//完成判断逻辑 

@Override 

public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain 

chain) {

String token = exchange.getRequest().getQueryParams().getFirst("token"); 

if (StringUtils.isBlank(token)) { 

System.out.println("鉴权失败"); 

exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); 

return exchange.getResponse().setComplete(); 

}

//调用chain.filter继续向下游执行 

return chain.filter(exchange); 

}

//顺序,数值越小,优先级越高 

@Override 

public int getOrder() {

return 0; 

} 

}

网关限流

网关是所有请求的公共入口，所以可以在网关进行限流，而且限流的方式也很多，我们本次采用前面学过的Sentinel组件来实现网关的限流。Sentinel支持对SpringCloud Gateway、Zuul等主流网关进行限流。

从1.6.0版本开始，Sentinel提供了SpringCloud Gateway的适配模块，可以提供两种资源维度的限流：

• route维度：即在Spring配置文件中配置的路由条目，资源名为对应的routeId

• 自定义API维度：用户可以利用Sentinel提供的API来自定义一些API分组

1 导入依赖

<dependency> 

<groupId>com.alibaba.csp</groupId> 

<artifactId>sentinel-spring-cloud-gateway-adapter</artifactId> 

</dependency> 

2 编写配置类

基于Sentinel 的Gateway限流是通过其提供的Filter来完成的，使用时只需注入对应的SentinelGatewayFilter实例以及 SentinelGatewayBlockExceptionHandler 实例即可。

@Configuration 

public class GatewayConfiguration { 

private final List<ViewResolver> viewResolvers;private final ServerCodecConfigurer serverCodecConfigurer; 

public GatewayConfiguration(ObjectProvider<List<ViewResolver>> 

viewResolversProvider, 

ServerCodecConfigurer serverCodecConfigurer) { 

this.viewResolvers = 

viewResolversProvider.getIfAvailable(Collections::emptyList); 

this.serverCodecConfigurer = serverCodecConfigurer; 

}

// 初始化一个限流的过滤器 

@Bean 

@Order(Ordered.HIGHEST_PRECEDENCE) 

public GlobalFilter sentinelGatewayFilter() { 

return new SentinelGatewayFilter(); 

}

// 配置初始化的限流参数 

@PostConstruct 

public void initGatewayRules() { 

Set<GatewayFlowRule> rules = new HashSet<>(); 

rules.add(

new GatewayFlowRule("product_route") //资源名称,对应路由id 

.setCount(1) // 限流阈值 

.setIntervalSec(1) // 统计时间窗口，单位是秒，默认是 1 秒 

);

GatewayRuleManager.loadRules(rules); 

}

// 配置限流的异常处理器 

@Bean 

@Order(Ordered.HIGHEST_PRECEDENCE) 

public SentinelGatewayBlockExceptionHandler 

sentinelGatewayBlockExceptionHandler() { 

return new SentinelGatewayBlockExceptionHandler(viewResolvers, 

serverCodecConfigurer); 

}

// 自定义限流异常页面 

@PostConstruct 

public void initBlockHandlers() { 

BlockRequestHandler blockRequestHandler = new BlockRequestHandler() { 

public Mono<ServerResponse> handleRequest(ServerWebExchange 

serverWebExchange, Throwable throwable) { 

Map map = new HashMap<>(); 

map.put("code", 0); 

map.put("message", "接口被限流了"); 

return ServerResponse.status(HttpStatus.OK).contentType(MediaType.APPLICATION_JSON_UTF8). 

body(BodyInserters.fromObject(map)); 

} 

};

GatewayCallbackManager.setBlockHandler(blockRequestHandler); 

} 

}

3 测试

在一秒钟内多次访问http://localhost:7000/product-serv/product/1就可以看到限流启作用了。

4 自定义API分组

自定义API分组是一种更细粒度的限流规则定义

/**

\* 配置初始化的限流参数 

*/ 

@PostConstruct 

public void initGatewayRules() { 

Set<GatewayFlowRule> rules = new HashSet<>(); 

rules.add(new 

GatewayFlowRule("product_api1").setCount(1).setIntervalSec(1)); 

rules.add(new 

GatewayFlowRule("product_api2").setCount(1).setIntervalSec(1)); 

GatewayRuleManager.loadRules(rules); 

}

//自定义API分组 

@PostConstruct 

private void initCustomizedApis() { 

Set<ApiDefinition> definitions = new HashSet<>(); 

ApiDefinition api1 = new ApiDefinition("product_api1") 

.setPredicateItems(new HashSet<ApiPredicateItem>() {{ 

// 以/product-serv/product/api1 开头的请求 

add(new ApiPathPredicateItem().setPattern("/product- 

serv/product/api1/**"). 

setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX)); 

}}); 

ApiDefinition api2 = new ApiDefinition("product_api2") 

.setPredicateItems(new HashSet<ApiPredicateItem>() {{ 

// 以/product-serv/product/api2/demo1 完成的url路径匹配

add(new ApiPathPredicateItem().setPattern("/product- 

serv/product/api2/demo1")); 

}}); 

definitions.add(api1); 

definitions.add(api2); 

GatewayApiDefinitionManager.loadApiDefinitions(definitions); 

}

文章持续更新，安利一个后端面试指南：github.com/ThinkingHan…，有大厂面试完整考点，欢迎Star。