springcloud gateway概念精讲

Posted 2021-07-10 如何在3年拿到50K

一、定义

外部请求通过gateWay转发到后端微服务,网关一般提供如下功能

1. 统一接入，路由转发
2. 安全审查，校验鉴权
3. 熔断降级，数据缓存
4. 统一日志，全局监控

总的来说，gateway提供了一个入口来管控所有的微服务，基于这个特点可以灵活使用。

网关解决方案对比

nginx+lua 高性能反向代理服务器，一般作为负载均衡入口

Zuul是第一代网关，spring

cloud是第二代网关，基于Netty\\Reactor\\WebFLux构建

• 性能强劲，zuul1.6倍
• 功能强大，内置转发，监控，限流等功能

缺点

• 不能再servlet容器下功能，不能使用war包

基础说明

1. spring cloud gateway基于springBoot2.x系列，webflux，reactor等技术，传统的同步库都是不能使用的
2. gateway底层依赖netty,不接受servlet容器或者war包

二、核心术语

Route路由

基础的转发规则，包含下面几部分，当predicate满足时则代表匹配

• id
• 目标url
• predicate集合：满足条件才转发
• filter集合：满足条件则过滤（改变请求）

Predicate谓词、断言

java.util.funcation.Predicate实现路由匹配条件，通过ServletWebExchange(封装了HTTP请求和相应)作为入参，来对request的各种属性（参考predicate的各种规则）做匹配。

Filter过滤器

修改请求及响应

gateway已经为了我们准备了各种过滤器工厂,我们也可以通过自定义过滤器

三、简单原理

1. client发送请求给gateway,handlermapping判断请求路径是否匹配路由配置
2. 如果匹配成功web handler会读取路由配置过滤器，把请求交给过滤器处理
3. 过滤器如图是链式结构，分为pre和post处理

四、概念讲解

Route Predcate Factories

符合Predicate的条件，就使用该路由的配置，否则就不管。

https://www.imooc.com/article/290804

配置形式

模糊匹配和精确匹配

路由到指定URL

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一标识}
        uri: http://www.itmuch.com

表示访问 GATEWAY_URL/** 会转发到 http://www.itmuch.com/**
需要和predicate配合使用，满足条件则转发

spring:
  cloud:
    gateway:
      routes:
      - id: {唯一标识}
        uri: http://www.itmuch.com/spring-cloud/spring-cloud-stream-pan-ta/

表示访问 GATEWAY_URL/spring-cloud/spring-cloud-stream-pan-ta/ 会转发到 http://www.itmuch.com/spring-cloud/spring-cloud-stream-pan-ta/

路由转发到微服务

路由到服务发现组件上的微服务

 routes:
        - id: user_route
          uri: lb://user-center
          predicates:
            - Path=/users/**

浏览器访问 网关url时，http://localhost:8040/users/1会自动转发到user-center服务的接口，等同于访问http://localhost:9099/users/1

自定义predicate工厂

xxxxRoutePredicateFactory必须以这种形式结尾

      routes:
        - id: after_route
          uri: lb://user-center
          predicates:
            # 当且仅当请求时的时间After配置的时间时，才会转发到用户微服务
            # 目前配置不会进该路由配置，所以返回404
            # 将时间改成 < now的时间，则访问localhost:8040/** -> user-center/**
            # eg. 访问http://localhost:8040/users/1 -> user-center/users/1
            - After=2010-01-20T17:42:47.789-07:00[America/Denver]
            - TimeBetween=00:00:00,12:44:13

@Data
public class TimeBetweenBean {
    private String  start;
    private String end;
}

@Component
public class TimeBetweenRoutePredicateFactory
        extends AbstractRoutePredicateFactory <TimeBetweenBean>{

    public TimeBetweenRoutePredicateFactory() {
        super(TimeBetweenBean.class);
    }

    /**
     * 谓词工厂的核心方法，控制路由的判断人条件
     * @param config
     * @return
     */
    @Override
    public Predicate<ServerWebExchange> apply(TimeBetweenBean config) {

        String start = config.getStart();
        String end = config.getEnd();
        return  serverWebExchange ->{
            LocalTime now = LocalTime.now();
            System.out.println(now.isAfter(LocalTime.parse(start)));
            return now.isAfter(LocalTime.parse(start)) && now.isBefore(LocalTime.parse(end));
        };
    }

    /**
     * 控制配置类和配置文件映射关系,和配置文件顺序一致
     * @return
     */
    @Override
    public List<String> shortcutFieldOrder() {

        return Arrays.asList("start","end");
    }
}

动态路由-服务名称转发
面向服务的路由，支持整合EUREKA或者NACOS注册中心，根据serviceId自动从注册中心获取服务地址并转发请求。不需要给每个微服务都配置路由规则

      discovery:
        locator:
          enabled: true # 开启从注册中心动态创建路由

例子：
http://localhost:8001/payment/get/1?uname=123
http://localhost:9527/cloud-payment-service/payment/get/1?uname=123

三、Filter

生命周期

• Pre:转发请求之前
• post:转发请求之后

gateway自带过滤器讲解

1. RewritePath 请求地址重定向

按照正则匹配上的路径重写为逗号后面的地址

pring:
  cloud:
    gateway:
      routes:
      - id: rewritepath_route
        uri: https://example.org
        predicates:
        - Path=/red/**
        filters:
        - RewritePath=/red/?(?<segment>.*), /$\\{segment}

注：效果是去掉/red

2. PrefixPath 添加前缀

给请求路径添加前缀

spring:
  cloud:
    gateway:
      routes:
      - id: prefixpath_route
        uri: https://example.org
        filters:
        - PrefixPath=/mypath

3. StripPrefix 删除前缀

删除请求的指定个数前缀后添加到服务末尾

spring:
  cloud:
    gateway:
      routes:
      - id: nameRoot
        uri: https://nameservice
        predicates:
        - Path=/name/**
        filters:
        - StripPrefix=2

例如：请求路径/name/blue/red，实际效果 nameservice/red

全局过滤器GlobalFilter

无需配置文件作用在所有的路由，最终通过gatewayfilterAdapter包装为过滤器

自定义过滤器工厂

• 继承AbstractGateWayFilterFactory
• 继承AbstractNameValueGatewayFilterFactory
  第一种方式的简化方式

自定义网关过滤器

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


    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
       log.info("**** com int mylogglbalfiltert{}",new Date());
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if(uname==null){
            log.info("非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE); //返回状态码
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

注册过滤器

@Configuration
public class GateWayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){

        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_route_kouryoushine",
                r->r.path("guonei").
                        uri("http://news.baidu.com/guonei")).build();

        return routes.build() ;
    }

}

全局过滤器

无需注册操作，默认直接生效

核心API

• exchange.getRequest().mutate().xxx 修改request
• exchange.mutate.xxx 修改exchange
• chain.filter(exchange) 传递给下一个过滤器
• exchange.getResponse() 获取响应

配置文件

    filters:
            - AddRequestHeader=X-Request-Foo,Bar
            - PreLog=a,b

@Slf4j
@Component
public class PreLogGatewayFilterFactory extends AbstractNameValueGatewayFilterFactory {
    @Override
    public GatewayFilter apply(NameValueConfig config) {
        log.info("请求建立了{}{}",config.getName(),config.getValue());
        return (exchagne,chain)->{
            log.info("请求建立了{}{}",config.getName(),config.getValue());
            ServerHttpRequest request = exchagne.getRequest()
                    .mutate()
                    .build();
            ServerWebExchange exchange = exchagne.mutate()
                    .request(request)
                    .build();
            return chain.filter(exchange);
        };
    }
}

全局过滤器

order越小有效执行
局部过滤器按照配置顺序执行
如果想自行控制order,返回OrderedGateFilter

全局监控

查看全局过滤器
http://localhost:8040/actuator/gateway/globalfilters

• routes展示路由列表

其他监控包括动态增加路由都可以百度