统一网关Gateway
本篇基于黑马教程
网关的技术实现
在springcloud中网关的实现包括两种:
- gateway
- zuul
Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程,具备更好的性能。
网关的作用
- 对用户请求做身份验证、权限验证
- 将用户请求路由到微服务,并实现负载均衡
- 对用户请求做限流
搭建网关
搭建网关服务的步骤:
- 创建新的module,引入SpringCloudGateway的依赖和nacos的服务发现:
<!-- 网关依赖 -->
<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>
- 编写路由配置及nacos地址
server:
port: 10010 #网关端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
server-addr: localhost:8848 #nacos地址
gateway:
routes: #网关相关配置
- id: user-service #路由id,自定义、唯一即可
# uri : http://127.0.0.1:8081 #路由的目标地址,http就是固定地址
uri: lb://userservice #路由目标地址 lb就是负载均衡,后面跟服务名称
perdicatess: #路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user/** #这个是按照路径匹配,只有以/user/开头就符合要求
流程:用户访问到网关,网关服务检测到url中的参数,通过断言判断需要远程调用哪个服务。然后从服务中心拉取服务,并且发送请求。
断言工厂Route Predicate Factory
网关路由可以配置的内容包括:
- 路由id:路由唯一标识
- uri:路由目的地,支持lb和HTTP
- predicates:路由断言,判断请求是否符合要求,符合则转发到路由目的地
- filters:路由过滤器,处理请求或相应
spring提供了11种基本的Predicate工厂:
名称 | 说明 | |
---|---|---|
After | 是某个时间点之后的请求 | |
Before | 是某个时间点之前的请求 | |
Between | 是某两个时间点之前的请求 | |
Cookie | 请求必须包含某些cookie | |
Header | 请求必须包含某些header | |
Host | 请求必须是访问某个host | |
Method | 请求方式必须是指定的方式 | |
Path | 请求路径必须符合指定规则 | |
Query | 请求参数必须包含指定参数 | |
RemoteAddr | 请求者的ip必须是指定范围 | |
Weight | 权重处理 |
路由过滤器GatewayFilter
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
Spring提供了31种不同的路由过滤器工厂。例如:
名称 | 说明 |
---|---|
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddRequestHeader | 给响应结果中添加一个响应头 |
… |
配置过滤器
局部生效的过滤器,在哪个路由的配置文件中设置,就对哪个路由生效。
server:
port: 10010 #网关端口
spring:
application:
name: gateway #服务名称
cloud:
nacos:
server-addr: localhost:8848 #nacos地址
gateway:
routes: #网关相关配置
- id: user-service #路由id,自定义、唯一即可
# uri : http://127.0.0.1:8081 #路由的目标地址,http就是固定地址
uri: lb://userservice #路由目标地址 lb就是负载均衡,后面跟服务名称
perdicatess: #路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user/** #这个是按照路径匹配,只有以/user/开头就符合要求
filter:
- AddRequestHeader=True, zhe-li-shi-tian-jia-qing-qiu-tou-de-nei-rong #添加请求头
默认过滤器
如果想要过滤器对所有路由都生效,可以
添加到默认过滤器default-filters里。默认过滤器属性的位置和routes同级。
gateway:
routes: #网关相关配置
- id: user-service #路由id,自定义、唯一即可
# uri : http://127.0.0.1:8081 #路由的目标地址,http就是固定地址
uri: lb://userservice #路由目标地址 lb就是负载均衡,后面跟服务名称
perdicatess: #路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user/** #这个是按照路径匹配,只有以/user/开头就符合要求
default-filters:
- AddRequestHeader=True, zhe-li-shi-tian-jia-qing-qiu-tou-de-nei-rong #添加默认请求头
全局过滤器
过滤器执行顺序
- 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前.
- GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
- 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增
- 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器>GobalFilter的顺序执行
可以参考下面几个类的源码来查看:
rg.springframework.cloud.gateway.route.RouteDefinitionRouteLocator
#getFilters()方法先加载defaultFilters,然后再加载某个route的filters,然后合并
org.springframework.cloud.cateway.handler.FilterindlebHandler
#handle()方法会加载全局过滤器与前面的过滤器合并后根据order排序,组织过滤器链
跨域问题
网关处理跨域采用的同样是CORS方案,并且只需要简单配置即可实现:
spring:
cloud:
gateway:
...
globalcors: #全局的跨域处理
add-to-simple-url-handler-mapping: true #解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: #允许哪些网站可以跨域请求
- "http://localhost:8090"
- "http://www.leyou.com"
alloweMethods: #允许的跨域Ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
alloweHeaders: "*" #允许在请求中携带的头信息
allowCredentials: true #是否允许携带cookie
maxAge: 360000 #这次跨域检测的有效期