Spring Cloud Gateway
是Spring Cloud
的一个全新项目,该项目是基于Spring 5.0
,Spring Boot 2.0
和Project Reactor
等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API
路由管理方式。
1.1.为什么需要网关
Gateway
网关是我们服务的守门神,所有微服务的统一入口。
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
架构图:
权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
路由和负载均衡:一切请求都必须先经过gateway
,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
在SpringCloud
中网关的实现包括两种:
gateway
zuul
Zuul
是基于Servlet
的实现,属于阻塞式编程。而SpringCloudGateway
则是基于Spring5
中提供的WebFlux
,属于响应式编程的实现,具备更好的性能。
1.2.gateway
快速入门
下面,我们就演示下网关的基本路由功能。基本步骤如下:
- 创建
SpringBoot
工程gateway
,引入网关依赖 - 编写启动类
- 编写基础配置和路由规则
- 启动网关服务进行测试
1)创建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>
2)编写启动类
package cn.itcast.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
3)编写基础配置和路由规则
创建application.yml文件,内容如下:
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就是负载均衡,后面跟服务名称
predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
我们将符合Path
规则的一切请求,都代理到 uri
参数指定的地址。
本例中,我们将 /user/**
开头的请求,代理到lb://userservice
,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
4)重启测试
重启网关,访问http://localhost:10010/user/1
时,符合/user/**
规则,请求转发到uri
:http://userservice/user/1
,得到了结果:
5)网关路由的流程图
整个访问的流程如下:
总结:
网关搭建步骤:
- 创建项目,引入
nacos
服务发现和gateway
依赖 - 配置
application.yml
,包括服务基本信息、nacos
地址、路由
路由配置包括:
- 路由
id
:路由的唯一标示 - 路由目标(
uri
):路由的目标地址,http
代表固定地址,lb代表根据服务名负载均衡 - 路由断言(
predicates
):判断路由的规则, - 路由过滤器(
filters
):对请求或响应做处理
1.3.断言工厂
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory
读取并处理,转变为路由判断的条件
例如Path=/user/**
是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory
类来
处理的,像这样的断言工厂在SpringCloudGateway
还有十几个:
名称 | 说明 | 示例 |
| 是某个时间点后的请求 |
|
| 是某个时间点之前的请求 |
|
| 是某两个时间点之前的请求 |
|
| 请求必须包含某些 |
|
| 请求必须包含某些 |
|
| 请求必须是访问某个 |
|
| 请求方式必须是指定方式 |
|
| 请求路径必须符合指定规则 |
|
| 请求参数必须包含指定参数 |
|
| 请求者的ip必须是指定范围 |
|
| 权重处理 |
我们只需要掌握Path这种路由工程就可以了。
1.4.过滤器工厂
GatewayFilter
是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
1.4.1.路由过滤器的种类
Spring
提供了31种不同的路由过滤器工厂。例如:
名称 | 说明 |
| 给当前请求添加一个请求头 |
| 移除请求中的一个请求头 |
| 给响应结果中添加一个响应头 |
| 从响应结果中移除有一个响应头 |
| 限制请求的流量 |
1.4.2.请求头过滤器
下面我们以AddRequestHeader
为例来讲解。
需求:给所有进入
userservice
的请求添加一个请求头:Truth=wo ai beijing tiananmen!
只需要修改gateway
服务的application.yml
文件,添加路由过滤即可:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
filters: # 过滤器
- AddRequestHeader=Truth, wo ai beijing tiananmen! # 添加请求头
当前过滤器写在userservice
路由下,因此仅仅对访问userservice
的请求有效。
1.4.3.默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default
下。格式如下:
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
default-filters: # 默认过滤项
- AddRequestHeader=Truth, wo ai beijing tiananmen!
1.4.4.总结
过滤器的作用是什么?
① 对路由的请求或响应做加工处理,比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
defaultFilters
的作用是什么?
① 对所有路由都生效的过滤器
1.5.全局过滤器
过滤器网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。
1.5.1.全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter
的作用一样。区别在于GatewayFilter
通过配置定义,处理逻辑是固定的;而GlobalFilter
的逻辑需要自己写代码实现。
定义方式是实现GlobalFilter
接口。
public interface GlobalFilter {
/**
* 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
*
* @param exchange 请求上下文,里面可以获取Request、Response等信息
* @param chain 用来把请求委托给下一个过滤器
* @return {@code Mono<Void>} 返回标示当前过滤器业务结束
*/
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
1.5.2.自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
- 参数中是否有
authorization
, authorization
参数值是否为admin
如果同时满足则放行,否则拦截
实现:
在gateway
中定义一个过滤器:
package com.dcxuexi.gateway;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
/***
* @Title AuthorizeFilter
* @Description TOTD
* @Auter DongChuang
* @Date 2023/3/14 22:36
* @Version 1.0.0
*/
@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取请求参数
MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
// 2.获取authorization参数
String auth = params.getFirst("authorization");
// 3.校验
if ("admin".equals(auth)){
// 放行
return chain.filter(exchange);
}
// 4.拦截
// 4.1.禁止访问,设置状态码
exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
// 4.2.结束处理
return exchange.getResponse().setComplete();
}
}
1.5.3.过滤器执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter
、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter
、GlobalFilter
,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
排序的规则是什么呢?
- 每一个过滤器都必须指定一个
int
类型的order
值,order
值越小,优先级越高,执行顺序越靠前。 -
GlobalFilter
通过实现Ordered
接口,或者添加@Order
注解来指定order
值,由我们自己指定 - 路由过滤器和
defaultFilter
的order
由Spring
指定,默认是按照声明顺序从1递增。 - 当过滤器的
order
值一样时,会按照defaultFilter
> 路由过滤器 >GlobalFilter
的顺序执行。
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()
方法是先加载defaultFilters
,然后再加载某个route
的filters
,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()
方法会加载全局过滤器,与前面的过滤器合并后根据order
排序,组织过滤器链
1.6.跨域问题
1.6.1.什么是跨域问题
跨域:域名不一致就是跨域,主要包括:
- 域名不同:
www.taobao.com
和www.taobao.org
和www.jd.com
和miaosha.jd.com
- 域名相同,端口不同:
localhost:8080
和localhost:8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax
请求,请求被浏览器拦截的问题
1.6.2.解决跨域问题
在gateway
服务的application.yml
文件中,添加下面的配置:
spring:
cloud:
gateway:
# 。。。
globalcors: # 全局的跨域处理
add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
corsConfigurations:
'[/**]':
allowedOrigins: # 允许哪些网站的跨域请求
- "http://localhost:8090"
allowedMethods: # 允许的跨域ajax的请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" # 允许在请求中携带的头信息
allowCredentials: true # 是否允许携带cookie
maxAge: 360000 # 这次跨域检测的有效期