一、概述
1、Gateway简介
SpringCloud Gateway是SpringCloud的一个全新的项目,基于Spring 5.0 + SpringBoot 2.0和Project Reactor等技术开发的网关。为提高网关性能,SpringCloud Gateway 是基于WebFlux框架实现的,而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。其目标是提供统一的路由方式且基于Filter链的方式提供了网关基本的功能,例如:安全,监控/指标,限流。官方文档地址 https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.2.RELEASE/reference/html/ 。
2、网关:实现反向代理、鉴权、流量控制、熔断、日志监控等。
二、核心概念
1、路由(Route)
路由是构建网关的基本模块,它由ID、目标URI以及一系列的断言和过滤器组成,如果断言为true则匹配该路由。
2、断言(Predicate)
参考的是Java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言匹配则进行路由。
3、过滤(Filter)
Spring框架中GatewayFilter的实例,使用过滤器可以在请求被路由前或者之后对请求就行修改。
三、Gateway工作流程
1、工作流程图如下
2、说明
- 客户端向Spring Cloud Gateway发出请求。如果在Gateway Handler Mapping中找到匹配的路由,则将其发送到Gateway Web Handler。
- Handler通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。过滤器由虚线分隔的原因是,过滤器可以在发送代理请求之前(pre)和之后(post)运行逻辑。
- Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等;在“post”类型的过滤器中可以做响应内容、响应头的修改、日志的输出、流量监控。
四、案例配置
1、新建一个模块用于网关,在pom中添加以下依赖。
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!-- eureka-client -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--引入自己定义的包-->
<dependency>
<groupId>com.xhanglog.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</version>
</dependency>
<!--热部署-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
2、在application.xml中添加如下配置,启动项目,便可以通过路由去访问。
server:
port: 9527
spring:
application:
name: cloud-gateway-service
cloud:
gateway:
routes:
- id: payment_routh #路由ID,没有固定规则但要求唯一
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** #断言,路径匹配的进行路由
- id: payment_routh2 #路由ID,没有固定规则但要求唯一
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** #断言,路径匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client:
#是否从Eureka server 抓取已有的注册信息,默认为true。单节点无所谓,集群必须设置为true才能配合ribbon使用负载均衡
fetch-registry: true
#表示是否将自己注册进入Eureka server ,默认为true
register-with-eureka: true
service-url:
defaultZone: http://localhost:7001/eureka
3、通过微服务名实现动态路由
默认情况下Gateway会根据注册服务中心注册的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能。
-
在网关的application.yml配置中添加以下内容
spring: cloud: gateway: discovery: locator: enabled: true #开启从注册中心动态创建路由的功能,利用微服务进行路由
-
将请求提供服务端地址修改为注册中心上微服务名即可。
4、自定义全局过滤器
-
定义一个类实现 GlobalFilter, Ordered 即可。
public class MyGlobalFilter implements GlobalFilter, Ordered { public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { log.info("*********************** MyGlobalFilter, date"+new Date()); return chain.filter(exchange); } public int getOrder() { return 0; //过滤器加载顺序,数字越小优先级越高 } }