← 返回学习路线

SYSTEM

服务网关路由

Java基础服务网关system
src/content/notes/system/服务网关.md

服务网关

Zuul

SpringCloud 中所集成的 Zuul 版本,采用的是 Tomcat 容器,基于 Servlet 之上的一个阻塞式处理模型,不支持任何长连接,用 Java 实现,而 JVM 本身会有第一次加载较慢的情况,使得 Zuul 的性能相对较差

官网: https://github.com/Netflix/zuul/wiki


Gateway

基本介绍

SpringCloud Gateway 是 Spring Cloud 的一个全新项目,基于 Spring 5.0+Spring Boot 2.0 和 Project Reactor 等技术开发的网关,旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

  • 基于 WebFlux 框架实现,而 WebFlux 框架底层则使用了高性能的 Reactor 模式通信框架 Netty(异步非阻塞响应式的框架)
  • 基于 Filter 链的方式提供了网关基本的功能,例如:安全、监控/指标、限流等

Gateway 的三个核心组件:

  • Route:路由是构建网关的基本模块,由 ID、目标 URI、一系列的断言和过滤器组成,如果断言为 true 则匹配该路由
  • Predicate:断言,可以匹配 HTTP 请求中的所有内容(例如请求头或请求参数),如果请求参数与断言相匹配则进行路由
  • Filter:指 Spring 框架中的 GatewayFilter实例,使用过滤器可以在请求被路由前或之后(拦截)对请求进行修改

Cloud-Gateway工作流程

核心逻辑:路由转发 + 执行过滤器链

  • 客户端向 Spring Cloud Gateway 发出请求,然后在 Gateway Handler Mapping 中找到与请求相匹配的路由,将其发送到 Gateway Web Handler
  • Handler 通过指定的过滤器链来将请求发送到际的服务执行业务逻辑,然后返回
  • 过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(pre)或之后(post)执行业务逻辑
  • Filter 在 pre 类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等,在 post 类型的过滤器中可以做响应内容、响应头的修改、日志的输出、流量监控等

网关使用

配置方式

Gateway 网关路由有两种配置方式,分别为通过 yml 配置和注入 Bean

  • 引入 pom 依赖:Gateway 不需要 spring-boot-starter-web 依赖,否在会报错,原因是底层使用的是 WebFlux 与 Web 冲突

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
  • application.yml:

    server:
      port: 9527
    
    spring:
      application:
        name: cloud-gateway
    
    eureka:
      instance:
        hostname: cloud-gateway-service
      client: #服务提供者provider注册进eureka服务列表内
        service-url:
          register-with-eureka: true
          fetch-registry: true
          defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka #集群版
  • 主启动类(网关不需要业务类):

    @SpringBootApplication
    @EnableEurekaClient
    public class GateWayMain9527 {
        public static void main(String[] args) {
            SpringApplication.run(GateWayMain9527.class, args);
        }
    }
  • 以前访问 provider-payment8001 中的 Controller 方法,通过 localhost:8001/payment/get/id 和 localhost:8001/payment/lb,项目不想暴露 8001 端口号,希望在 8001 外面套一层 9527 端口:

    server:
      port: 9527
    
    spring:
      application:
        name: cloud-gateway
    ## =====================新增====================
      cloud:
        gateway:
          routes:
            - id: payment_routh # payment_route	#路由的ID,没有固定规则但要求【唯一】,建议配合服务名
              uri: http://localhost:8001		#匹配后提供服务的路由地址
              predicates:
                - Path=/payment/get/**			# 断言,路径相匹配的进行路由
    
            - id: payment_routh2 # payment_route#路由的ID,没有固定规则但要求【唯一】,建议配合服务名
              uri: http://localhost:8001     	#匹配后提供服务的路由地址
              predicates:
                - Path=/payment/lb/**			# 断言,路径相匹配的进行路由
    • uri + predicate 拼接就是具体的接口请求路径,通过 localhost:9527 映射的地址
    • predicate 断言 http://localhost:8001下面有一个 /payment/get/** 的地址,如果找到了该地址就返回 true,可以用 9527 端口访问,进行端口的适配
    • ** 表示通配符,因为这是一个不确定的参数

注入Bean

通过 9527 网关访问到百度的网址 https://www.baidu.com/,在 config 包下创建一个配置类,路由规则是访问 /baidu 跳转到百度

@Configuration
public class GatewayConfig {
    // 配置了一个 id 为 path_route_cloud 的路由规则
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        // 构建一个路由器,这个routes相当于yml配置文件中的routes
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        // 路由器的id是:path_route_cloud,规则是访问/baidu ,将会转发到 https://www.baidu.com/
        routes.route("path_route_cloud",
                r -> r.path("/baidu").uri(" https://www.baidu.com")).build();
        return routes.build();
    }
}

动态路由

Gateway 会根据注册中心注册的服务列表,以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由和负载均衡,避免出现一个路由规则仅对应一个接口方法,当请求地址很多时需要很大的配置文件

application.yml 开启动态路由功能

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true		# 开启从注册中心动态创建路由的功能,利用微服务名进行路由
      routes:
        - id: payment_routh1   					# 路由的ID,没有固定规则但要求唯一,建议配合服务名
          uri: lb://cloud-payment-service		# 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/get/**              # 断言,路径相匹配的进行路由

        - id: payment_routh2      				#路由的ID,没有固定规则但要求唯一,建议配合服务名
          uri: lb://cloud-payment-service		#匹配后提供服务的路由地址
          predicates:
            - Path=/payment/lb/**               # 断言,路径相匹配的进行路由
            - After=2021-09-28T19:14:51.514+08:00[Asia/Shanghai]

lb:// 开头代表从注册中心中获取服务,后面是需要转发到的服务名称


断言类型

After Route Predicate:匹配该断言时间之后的 URI 请求

  • 获取时间:

    public class TimeTest {
        public static void main(String[] args) {
            ZonedDateTime zbj = ZonedDateTime.now(); // 默认时区
            System.out.println(zbj); //2023-01-10T16:31:44.106+08:00[Asia/Shanghai]
        }
    }
  • 配置 yml:动态路由小结有配置

  • 测试:正常访问成功,将时间修改到 2023-01-10T16:31:44.106+08:00[Asia/Shanghai] 之后访问失败

    Cloud-Gateway时间断言

常见断言类型:

  • Before Route Predicate:匹配该断言时间之前的 URI 请求

  • Between Route Predicate:匹配该断言时间之间的 URI 请求

    - Between=2022-02-02T17:45:06.206+08:00[Asia/Shanghai],2022-03-25T18:59:06.206+08:00[Asia/Shanghai]
  • Cookie Route Predicate:Cookie 断言,两个参数分别是 Cookie name 和正则表达式,路由规则会通过获取对应的 Cookie name 值和正则表达式去匹配,如果匹配上就会执行路由

    - Cookie=username, seazean # 只有发送的请求有 cookie,而且有username=seazean这个数据才能访问,反之404
  • Header Route Predicate:请求头断言

    - Header=X-Request-Id, \d+ # 请求头要有 X-Request-Id 属性,并且值为整数的正则表达式
  • Host Route Predicate:指定主机可以访问,可以指定多个用 , 分隔开

    - Host=**.seazean.com
  • Method Route Predicate:请求类型断言

    - Method=GET	# 只有 Get 请求才能访问
  • Path Route Predicate:路径匹配断言

  • Query Route Predicate:请求参数断言

    - Query=username, \d+ # 要有参数名 username 并且值还要是整数才能路由

Filter使用

Filter 链是同时满足一系列的过滤链,路由过滤器可用于修改进入的 HTTP 请求和返回的 HTTP 响应,路由过滤器只能指定路由进行使用,Spring Cloud Gateway 内置了多种路由过滤器,都由 GatewayFilter 的工厂类来产生

配置文件:https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#gatewayfilter-factories

自定义全局过滤器:实现两个主要接口 GlobalFilter, Ordered

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("*********************come in MyLogGateWayFilter:  "+ new Date());
        // 取出请求参数的uname对应的值
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        // 如果 uname 为空,就直接过滤掉,不走路由
        if(uname == null){
            log.info("************* 用户名为 NULL 非法用户 o(╥﹏╥)o");

            // 判断该请求不通过时:给一个回应,返回
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }

        // 反之,调用下一个过滤器,也就是放行:在该环节判断通过的 exchange 放行,交给下一个 filter 判断
        return chain.filter(exchange);
    }
	
    // 设置这个过滤器在Filter链中的加载顺序,数字越小,优先级越高
    @Override
    public int getOrder() {
        return 0;
    }
}