SpringCloud(一)【SpringCloud基础】
SpringCloud(二)【单体服务及远程调用】
SpringCloud(三)【Eureka注册中心】
SpringCloud(四)【Ribbon负载均衡】
SpringCloud(五)【Nacos注册中心】
SpringCloud(六)【Feign】
Gateway网关
一、网关作用
网关功能
- 对用户请求做身份认证和权限校验
- 将用户请求路由到微服务,并且实现负载均衡
- 对用户请求做限流
二、网关快速入门
SpringCloud中网关的技术实现
- Gateway
SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。 - Zuul
Zul是基于Servlet的实现,属于阻塞式编程。
搭建网关服务步骤
-
新建一个moudle
-
引入依赖
<!-- nacos的服务注册发现依赖-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!-- 网关gateway依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
3. 为新的moudle创建main函数
注意需要创建包,再创建main函数。
- 编写路由配置及nacos地址
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848 #nacos地址
gateway:
routes:
# 代理 user service
- id: user-service #路由标识,必须唯一
# uri: http://127.0.0.1:8081 # 路由的目标地址http是固定地址
uri: lb://userservice # 路由的目标地址【lb:load balance】
predicates: # 路由断言,判断请求是否符合规则
- Path=/user/** # 路径断言,判断路径是否咦/user开头,如果是则符合
# 代理 order service
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
5. 启动gateway访问http://localhost:10010/user/1
预期:返回用户“1”的信息
实际:报错
This application has no configured error view, so you are seeing this as a fallback.
原因分析:
gateway服务只配置了nacos和gateway网关,查看nacos,发现gateway这个服务和orderservice以及userservice不在一个命名空间,存在环境隔离。具体见:SpringCloud(五)【Nacos注册中心】
- gateway在public下面
- 其他的dev下
解决办法:
使命名空间在同一个。
此处配置gateway,将namespace配置为dev。
spring:
cloud:
nacos:
server-addr: localhost:8848 #nacos地址
discovery:
namespace: b47b494b-da3e-4cb8-b348-78213cfe0e77 #配置namespace
ephemeral: true #是否是临时实例
6. 再次访问,请求成功。
gateway路由流程图
三、断言
网关路由可以配置的内容
- 路由id:路由唯一标识
- uri:路由目的地,支持lb和http两种
- predicates:路由断言,判断请求是否符合要求,符合则转发到陆游目的地
- filter:路由过滤器,处理请求或者响应
断言工厂
- 我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件。
例如:
Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handlerpredicate.PathRoutePredicateFactory类(断言工厂)来处理的。
- 其余路由断言工厂及其使用可以通过spring官方网站文档查看。
名称 | 说明 | 示例 |
---|---|---|
After | 在某个时间点之后的请求 | - After=2017-01-20T17:42:47.789-07:00[America/Denver] |
Before | 在某个时间点之前的请求 | - Before=2017-01-20T17:42:47.789-07:00[Asia/Shanghai] |
Between | 在某两个时间点之间的请求 | - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 请求必须包含某些cookie | - Cookie=chocolate, ch.p |
Header | 请求必须包含某些header | - Header=X-Request-Id, \d+ |
Host | 请求必须是访问某个host(域名) | - Host=**.somehost.org,**.anotherhost.org |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须符合规则 | - Path=/red/{segment},/blue/{segment} |
Query | 请求参数必须包含指定参数 | - Query=green或者- Query=name,jack |
RemoteAddr | 请求ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 | |
XForwarded Remote Addr | 基于X-Forwarded-For HTTP头过滤请求 | - XForwardedRemoteAddr=192.168.1.1/24 |
Weight的示例
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
使用示例
在2017-01-20T17:42:47.789年之前,结果是访问失败404。
spring:
cloud:
gateway:
routes:
# 代理 user service
- id: user-service #路由标识,必须唯一
# uri: http://127.0.0.1:8081 # 路由的目标地址http是固定地址
uri: lb://userservice #路由的目标地址【lb:load balance】
predicates: #路由断言,判断请求是否符合规则
- Path=/user/** # 路径断言,判断路径是否咦/user开头,如果是则符合
# 代理 order service
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
- Before=2017-01-20T17:42:47.789-07:00[Asia/Shanghai]
四、过滤器
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理。spring提供的路由过滤器工厂
名称 | 说明 | 示例 |
---|---|---|
AddRequestHeader | 给当前请求添加一个请求头 | - AddRequestHeader=X-Request-Red, Blue-{segment} |
RemoveRequestHeader | 移除请求中的一个请求头 | - RemoveRequestHeader=X-Request-Foo |
AddResponseHeader | 给响应结果添加一个响应头 | - AddResponseHeader=X-Response-Red, Blue |
RemoveResponseHeader | 从响应结果移除一个响应头 | - RemoveResponseHeader=X-Response-Foo |
路由过滤器
给userservice 服务的请求添加一个header请求头:header=Add a header!
- 在gateway的配置文件中增加过滤器
spring:
cloud:
gateway:
routes:
# 代理 user service
- id: user-service #路由标识,必须唯一
# uri: http://127.0.0.1:8081 # 路由的目标地址http是固定地址
uri: lb://userservice #路由的目标地址【lb:load balance】
predicates: #路由断言,判断请求是否符合规则
- Path=/user/** # 路径断言,判断路径是否咦/user开头,如果是则符合
filters: #路由过滤器
- AddRequestHeader=header, Add a header!
2. 改造userservice的接口
3. 通过http://localhost:10010/user/1
请求成功,可以看到成功添加header。
默认过滤器
如果想给所有的路由都配置过滤器,可以使用默认过滤器。
配置文件
spring:
cloud:
gateway:
routes:
# 代理 user service
- id: user-service #路由标识,必须唯一
# uri: http://127.0.0.1:8081 # 路由的目标地址http是固定地址
uri: lb://userservice #路由的目标地址【lb:load balance】
predicates: #路由断言,判断请求是否符合规则
- Path=/user/** # 路径断言,判断路径是否咦/user开头,如果是则符合
# filters: #过滤器
# - AddRequestHeader=header, Add a header!
# 代理 order service
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
- After=2017-01-20T17:42:47.789-07:00[Asia/Shanghai]
default-filters: #默认过滤器,对所有路由都生效
- AddRequestHeader=header, Add a header!
重启gateway,访问userservic的user接口。
路由user-service
下配置的过滤器已经被注释,但是请求的时候仍然添加了header,默认过滤器的配置生效。
全局过滤器
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。
区别在于GatewayFilter通过配置定义,处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。
定义方式
- 实现GlobalFilter接口。
@Component
@Order(-1)
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//1.获取请求参数
ServerHttpRequest request = exchange.getRequest();
//2.获取参数中的 authorization 参数
MultiValueMap<String, String> params = request.getQueryParams();
//3.判断参数是否等于admin
String auth = params.getFirst("authorization");
//4.是,放行
if("admin".equals(auth)){
return chain.filter(exchange);
}
//5.否,拦截
//5.1 设置返回状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); //401 未登录认证
//5.2 拦截请求
return exchange.getResponse().setComplete();
}
}
其中,需要注意的是@Order(-1)
是全局过滤器的执行顺序,参数值越小优先级越高,默认值:2147483647。
- 顺序的实现方式
- 注解
@Order(-1)
- 实现接口
Ordered
@Component
public class AuthorizeFilter implements GlobalFilter , Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//1.获取请求参数
ServerHttpRequest request = exchange.getRequest();
//2.获取参数中的 authorization 参数
MultiValueMap<String, String> params = request.getQueryParams();
//3.判断参数是否等于admin
String auth = params.getFirst("authorization");
//4.是,放行
if("admin".equals(auth)){
return chain.filter(exchange);
}
//5.否,拦截
//5.1 设置返回状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); //401 未登录认证
//5.2 拦截请求
return exchange.getResponse().setComplete();
}
@Override
public int getOrder() {
return -1;
}
}
- 重启网关,访问
http://localhost:10010/user/1?authorization=admin
可以通过,其他不能通过,实现了简单的登录校验。
过滤器链执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器 、DefaultFilter、GlbalFilter。
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器,执行顺序如下。
三种过滤器可以合并到一个过滤器链中的原因:
默认过滤器和路由过滤器的配置方式是一样的只是作用范围不同,本质相同,都是GatewayFilter
。都由AddRequestHeaderGatewayFilterFactory
过滤工厂来实现。
而全局过滤器将GlobalFilter
适配为GatewayFilter
,所以三者本质相同。
总结
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定。
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器>GlobalFilter的顺序执行。
五、跨域
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题。
解决方案:CORS
spring:
cloud:
gateway:
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
- "http://www.leyou.com"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期