网关作为流量的入口,常用的功能包括路由转发,权限校验,限流等
Spring Cloud Gateway 是Spring Cloud官方推出的第二代网关框架,定位于取代 Netflix Zuul。
相比 Zuul 来说,Spring Cloud Gateway 提供更优秀的性能,更强大的有功能。
Spring Cloud Gateway 是由 WebFlux + Netty + Reactor 实现的响应式的 API 网关。
它不能在传统的 servlet 容器中工作,也不能构建成 war 包。
Spring Cloud Gateway 旨在为微服务架构提供一种简单且有效的 API 路由的管理方式,并基于
Filter 的方式提供网关的基本功能,例如说安全认证、监控、限流等等。
官网文档:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html
/#gateway-starter
路由(route)
路由是网关中最基础的部分,路由信息包括一个ID、一个目的URI、一组谓 词工厂、一组Filter
组成。如果谓词为真,则说明请求的URL和配置的路由匹配。
谓词(predicates)
即java.util.function.Predicate , Spring Cloud Gateway使用Predicate实现路由的匹配条件。
过滤器(Filter)
SpringCloud Gateway中 的filter分为Gateway FilIer和Global Filter。Filter可以对请求和响应
进行处理。
【路由就是转发规则,谓词就是是否走这个路径的条件,过滤器可以为路由添加业务逻辑,修改
请求以及响应】
客户端向 Spring Cloud Gateway 发出请求,如果请求与网关程序定义的路由匹配,则该请求就会
被发送到网关 Web 处理程序,此时处理程序运行特定的请求过滤器链。
过滤器之间用虚线分开的原因是过滤器可能会在发送代理请求的前后执行逻辑。所有 pre 过滤器逻
辑先执行,然后执行代理请求;代理请求完成后,执行 post 过滤器逻辑。
getway不可以
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-gatewayartifactId>
dependency>
<dependency>
<groupId>com.alibaba.cloudgroupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discoveryartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
<scope>testscope>
dependency>
dependencies>
server:
port: 13001
spring:
application:
name: msb-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
#默认值是false,如果设为true开启通过微服务创建路由的功能,即可以通过微服务名访问服务
#http://localhost:13001/msb-order/order/create
#不建议打开,因为这样暴露了服务名称
enabled: false
#是否开启网关
enabled: true
routes:
#路由ID全局唯一
- id: msb-order-route
#目标微服务的请求地址和端口
uri: lb://msb-order
predicates:
- Path=/order/*
这里注意不要引入springmvc工程否则会报错如下
不建议开启通过微服务创建路由的功能,这样就把微服务名称暴露了
刚才能成功主要是
http://localhost:13001/msb-order/order/create 可以进行转化:
http://localhost:13001/msb-order/order/create可以替换为http://localhost:8001/order/create
然而此时的请求是转化不了的
http://localhost:13001/order/create
这是我们就需要我们的gateway 中的 route& predicates 建立映射
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: http://localhost:8001
表示访问 GATEWAY_URL/ == 会转发到http://localhost:8001/ ==
注:上面路由的配置必须和下面谓词(Predicate)配合使用才行
spring:
cloud:
gateway:
routes:
-id: {唯一标识}
uri: http://localhost:8001/
predicates:
- Path=/order/
表示访问 GATEWAY_URL/order/会转发到 http://localhost:8001/order/
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: lb://msb-order
表示访问 GATEWAY_URL/会转发到 msb-order 微服务的 /
注:上面路由的配置必须和下面谓词(Predicate)配合使用才行
spring:
cloud:
gateway:
routes:
- id: {唯一标识}
uri: lb://msb-order/
predicates:
- Path=/order/*
表示访问 GATEWAY_URL/order/ 会转发到 msb-order 微服务的 /order/
官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayrequest-predicates-factories
网关项目启动日志:
关于时间的谓词技巧:时间可使用 System.out.println(ZonedDateTime.now()); 打印,然后即可看到时区。例如:
2023-06-01T11:16:53.291+08:00[Asia/Shanghai]
该断言工厂的参数是两个 UTC 格式的时间。其会将请求访问到 Gateway 的时间与这两个参数时间相比,若请求时间在这两个 两个时间之间可以正常请求
server:
port: 13001
spring:
application:
name: msb-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
#默认值是false,如果设为true开启通过微服务创建路由的功能,即可以通过微服务名访问服务
#http://localhost:13001/msb-order/order/create
#不建议打开,因为这样暴露了服务名称
enabled: false
#是否开启网关
enabled: true
routes:
#路由ID全局唯一
- id: msb-order-route
#目标微服务的请求地址和端口
uri: lb://msb-order
predicates:
- Path=/order/*
# - TimeBetween= 上午08:00,下午10:00
- Between=2023-05-31T00:00:01+08:00[Asia/Shanghai], 2023-05-31T23:59:59+08:00[Asia/Shanghai]
#Cookie配置
# - Cookie=username, msb
# - Header=X-Request-Id, \d+
# # #请求某个接口在这个时间段是有效的
filters:
# - AddResponseHeader=X-Response-name, msb
- PrintLog=sex,man
在这个时间范围内的请求,可以正常转发,不在这个时间范围内的请求,则 404
该断言工厂的参数是一个 UTC 格式的时间。其会将请求访问到 Gateway 的时间与该参数时间相比,若请求时间在参数时间后面,则可以正常访问,否则404
该断言工厂的参数是一个 UTC 格式的时间。其会将请求访问到 Gateway 的时间与该参数时间相比,若请求时间在参数时间前面,则可以正常访问,否则404
该断言工厂中包含两个参数,分别是 cookie 的 key 与 value。当请求中携带了指定 key与 value 的 cookie 时,匹配对应的请求,否则 404 value值可以是具体的值,也可以是正则表达式
该断言工厂中包含两个参数,分别是请求头 header 的 key 与 value。当请求中携带了指定 key 与 value 的 header 时,正常转发,否则404 value可以是正则
该断言工厂中包含的参数是请求头中的 Host 属性。当请求中携带了指定的 Host 属性值时,匹配成功,断言为 true。
谓词还有很多,Weight不长用,却很重要。
该断言工厂中包含两个参数,分别是用于表示组 group,与权重 weight。对于同一组中的多个 uri 地址,路由器会根据设置的权重,按比例将请求转发给相应的 uri。实现负载均衡。可以实现灰度发布功能。
spring:
cloud:
gateway:
routes:
- id: weight_high
uri: https://weighthigh.org
predicates:
- Weight=group1, 8
- id: weight_low
uri: https://weightlow.org
predicates:
- Weight=group1, 2
group 组,权重根据组来计算
weight 权重值,是一个 Int 的值
@Data
public class TimeBetweenConfig {
private LocalTime start;
private LocalTime end;
}
@Slf4j
@Component
public class TimeBetweenRoutePredicateFactory extends AbstractRoutePredicateFactory<TimeBetweenConfig1> {
public TimeBetweenRoutePredicateFactory() {
super(TimeBetweenConfig1.class);
}
@Override
public Predicate<ServerWebExchange> apply(TimeBetweenConfig1 config) {
LocalTime start = config.getStart();
LocalTime end = config.getEnd();
return new Predicate<ServerWebExchange>() {
@Override
public boolean test(ServerWebExchange serverWebExchange) {
LocalTime now = LocalTime.now();
//匹配规则,返回true则正常转发
return now.isAfter(start) && now.isBefore(end);
}
};
}
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList("start","end");
}
}
SpringCloudGateway 内置了很多的过滤器工厂,我们通过一些过滤器工厂可以进行一些业务逻辑处理器,比如添加剔除响应头,添加去除参数等
官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html
/#gatewayfilter-factories
为原始请求添加名为 X-Request-Foo ,值为 Bar 的请求头。
spring:
cloud:
gateway:
routes:
- id: add_request_header_route
uri: https://example.org
filters:
- AddRequestHeader=X-Request-Foo, Ba
为原始请求添加请求参数 foo=bar
spring:
cloud:
gateway:
routes:
- id: add_request_parameter_route
uri: https://example.org
filters:
- AddRequestParameter=foo, bar
添加名为 X-Response-foo ,值为 addHeader 的响应头
spring:
cloud:
gateway:
routes:
- id: add_request_parameter_route
uri: https://example.org
filters:
- AddRequestParameter=foo, bar
- AddResponseHeader=X-Response-foo,addHeader
== Spring Cloud Greenwich SR2提供的新特性,低于这个版本无法使用 ==
强烈建议阅读一下类org.springframework.cloud.gateway.filter.factory.
DedupeResponseHeaderGatewayFilterFactory上的注释,比官方文档写得还好
spring:
cloud:
gateway:
routes:
- id: dedupe_response_header_route
uri: https://example.org
filters:
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin, RETAIN_FIRST
剔除重复的响应头。
举个例子:
我们在Gateway以及微服务上都设置了CORS(解决跨域)header,如果不做任何配置,请求 -> 网关 -> 微服务,获得的响应就是这样的:
Access-Control-Allow-Credentials: true, true
Access-Control-Allow-Origin: https://www.msbedu.com, https://www.msbedu.com
** 也就是Header重复了。要想把这两个Header去重,只需设置成如下即可。**
filters:
- DedupeResponseHeader=Access-Control-Allow-Credentials Access-Control-Allow-Origin
也就是说,想要去重的Header如果有多个,用空格分隔即可;
去重策略:
RETAIN_FIRST: 默认值,保留第一个值
RETAIN_LAST: 保留最后一个值
RETAIN_UNIQUE: 保留所有唯一值,以它们第一次出现的顺序保留
为匹配的路由添加前缀。例如:访问 ${GATEWAY_URL}/hello 会转发到 https://example.org /mypath/hello
spring:
cloud:
gateway:
routes:
- id: prefixpath_route
uri: https://example.org
filters:
- PrefixPath=/mypath
如果不设置,那么名为 Host 的Header由Http Client控制;如果设置了,那么会设置一个请求属性。(preserveHostHeader=true),路由过滤器会检查从而去判断是否要发送原始的、名为Host的Header。
spring:
cloud:
gateway:
routes:
- id: preserve_host_route
- uri: https://example.org
- filters:
- PreserveHostHeader
spring:
cloud:
gateway:
routes:
- id: requestratelimiter_route
uri: https://example.org
filters:
- name: RequestRateLimiter
args:
redis-rate-limiter.replenishRate: 10
redis-rate-limiter.burstCapacity: 20
上面配置表达的意思是: ${GATEWAY_URL}/hello 会重定向到 https://ecme.org/hello ,并且携
带一个 Location:http://www.msb.com 的Header。
spring:
cloud:
gateway:
routes:
- id: prefixpath_route
uri: https://example.org
filters:
# 配置成HTTP状态码, URL的形式
- RedirectTo=302, http://www.msb.com
spring.cloud.gateway.filter.remove-hop-by-hop.headers: Connection,Keep-Alive
移除转发请求的Header,多个用 , 分隔。默认情况下,移除如下Header。这些Header是由 IETF 组
织规定的。
原始请求删除名为 X-Request-Foo 的请求头
spring:
cloud:
gateway:
routes:
- id: removerequestheader_route
uri: https://example.org
filters:
- RemoveRequestHeader=X-Request-Foo
删除名为 X-Request-Foo 的响应头。
spring:
cloud:
gateway:
routes:
- id: removeresponseheader_route
uri: https://example.org
filters:
- RemoveResponseHeader=X-Response-Foo
重写请求路径。如上配置,访问 /foo/bar 会将路径改为 /bar 再转发,也就是会转发到 https://exa
mple.org/bar 。需要注意的是,由于YAML语法,需用 $\ 替换 $ 。
spring:
cloud:
gateway:
routes:
- id: rewritepath_route
uri: https://example.org
predicates:
- Path=/foo/**
filters:
# 配置成原始路径正则, 重写后的路径的正则
- RewritePath=/foo/(?>.*), /$\{segment}
对部分参数进行替换,如手机号,证件号 加*
如果名为 X-Response-Foo 的响应头的内容是 /42?user=ford&password=omg!
what&flag=true,则会被修改为 /42?user=ford&password=***&flag=true。
spring:
cloud:
gateway:
routes:
- id: rewriteresponseheader_route
uri: https://example.org
filters:
- RewriteResponseHeader=X-Response-Foo, password=[^&]+, password=***
在转发到后端微服务请求之前,强制执行 WebSession::save 操作。用在那种像 Spring Session 延
迟数据存储(笔者注:数据不是立刻持久化)的,并希望在请求转发前确保session状态保存情况。
如果你将 Spring Secutiry于 Spring Session集成使用,并想确保安全信息都传到下游机器,你就需
要配置这个filter。
spring:
cloud:
gateway:
routes:
- id: save_session
uri: https://example.org
predicates:
- Path=/foo/**
filters:
- SaveSession
添加一系列起安全作用的响应头。Spring Cloud Gateway参考了这篇博客的建议:https://blog.
appcanary.com/2017/http-security-headers.html
默认会添加如下Header(包括值):
采用路径 template参数,通过请求路径的片段的模板化,来达到操作修改路径的母的,运行多个路
径片段模板化。
如上配置,访问 ${GATEWAY_PATH}/foo/bar ,则对于后端微服务的路径会修改为 /bar 。
spring:
cloud:
gateway:
routes:
- id: setpath_route
uri: https://example.org
predicates:
- Path=/foo/{segment}
filters:
- SetPath=/{segment}
修改响应的状态码,值可以是数字,也可以是字符串。但一定要是Spring HttpStatus 枚举类中的
值。如上配置,两种方式都可以返回HTTP状态码401。
spring:
cloud:
gateway:
routes:
- id: setstatusstring_route
uri: http://example.org
filters:
- SetStatus=BAD_REQUEST
- id: setstatusint_route
uri: http://example.org
filters:
- SetStatus=401
数字表示要截断的路径的数量。如上配置,如果请求的路径为 /name/bar/foo ,则路径会修改为 /f
oo ,也就是会截断2个路径。
spring:
cloud:
gateway:
routes:
- id: nameRoot
uri: http://nameservice
predicates:
- Path=/name/**
filters:
- StripPrefix=2
针对不同的响应做重试,可配置如下参数:
spring:
cloud:
gateway:
routes:
- id: retry_test
uri: http://localhost:8080/flakey
predicates:
- Host=*.retry.com
filters:
- name: Retry
args:
retries: 3
statuses: BAD_GATEWAY
为后端服务设置收到的最大请求包大小。如果请求大小超过设置的值,则返回 413 Payload Too
Large 。默认值是5M
spring:
cloud:
gateway:
routes:
- id: request_size_route
uri: http://localhost:8080/upload
predicates:
- Path=/upload
filters:
- name: RequestSize
args:
# 单位字节
maxSize: 5000000
spring:
cloud:
gateway:
default-filters:
- AddResponseHeader=X-Response-Default-Foo, Default-Bar
- PrefixPath=/httpbin
pre : Gateway转发请求之前
post : Gateway转发请求之后
过滤器工厂的顶级接口是GatewayFilterFactory,我们可以直接继承它的两个抽象类来简化开发AbstractGatewayFilterFactory和AbstractNameValueGatewayFilterFactory,这两个抽象类的区别就是前者接收一个参数(像StripPrefix和我们创建的这种),后者接收两个参数(像AddResponseHeader)
注意自定义拦截器的命名,以GatewayFilterFactory结尾,前面是拦截器名
@Slf4j
@Component
public class ITestGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory{
@Override
public GatewayFilter apply(NameValueConfig config) {
return new GatewayFilter() {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//
log.info("打印请求信息?:{}:{}",config.getName(),config.getValue());
// 获取request就可以进行修改了
// ServerHttpRequest modifiedRequest1 = exchange.getRequest().mutate().build();
ServerHttpRequest request = exchange.getRequest().mutate().build();
HttpMethod method = request.getMethod();
log.info(String.valueOf(method.getClass().getFields().length));
ServerWebExchange modifiedExchange = exchange.mutate().request(request).build();
return chain.filter(modifiedExchange);
}
};
}
}
通过NameValueConfig config 的对象可以拿到拦截器的key value值,exchange 可以获取请求request相关的信息
@Data
public class ITestFilterConfig {
public String iTest;
}
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.List;
@Slf4j
@Component
public class ITest2GatewayFilterFactory extends AbstractGatewayFilterFactory<ITestFilterConfig> {
public ITest2GatewayFilterFactory() {
super(ITestFilterConfig.class);
}
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList("iTest");
}
@Override
public GatewayFilter apply(ITestFilterConfig config) {
return (exchange, chain) -> {
// http://localhost:10010/user/8?name=yh config.param ==> name
//获取请求参数中param对应的参数名 的参数值
ServerHttpRequest request = exchange.getRequest();
log.info("打印请求信息?:{}:{}",config.getITest()+"99");
if (request.getQueryParams().containsKey(config.iTest)){
request.getQueryParams().get(config.iTest).forEach((v) -> {
System.out.print("--局部过滤器--获得参数 "+config.iTest+"="+ v);
});
}
return chain.filter(exchange);//执行请求
};
}
}
@Slf4j
@Component
public class IPAddressStatisticsFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
InetSocketAddress host = exchange.getRequest().getHeaders().getHost();
if (host == null || host.getHostName() == null) {
exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
return exchange.getResponse().setComplete();
}
String hostName = host.getHostName();
AtomicInteger count = IpCache.CACHE.getOrDefault(hostName, new AtomicInteger(0));
count.incrementAndGet();
IpCache.CACHE.put(hostName, count);
log.info("IP地址:" + hostName + ",访问次数:" + count.intValue());
return chain.filter(exchange);
}
@Override
public int getOrder() {
return -1;
}
}
用于存放不同ip请求次数的map
//用于保存次数的缓存
public class IpCache {
public static final Map<String, AtomicInteger> CACHE = new ConcurrentHashMap<>();
}