Spring Cloud之网关-Gateway(一)

因为最近公司也计划将原有的项目改造成微服务的架构,加上之前自己面试过程中也发现自己在这方面也比较欠缺,所以准备好好的来学习一下微服务的各个常用的组件。其实微服务发展到现在出现的各种架构都比较成熟了,我觉得具体情况具体分析就好了,不存在最好只有最适合,当然如果不知道怎么选型,那我觉得选择spring cloud官方的组件应该也不会差。 上周开始项目组就在研究技术选型的问题,因为没有架构师所以很多东西需要项目组来确定,另外也要参考公司的其他部门的经验,大概介绍一下我们的技术组件吧:Nacos做注册中心和配置中心;网关就是这次学习的spring cloud gateway;日志框架就是ELK,这个之前我也搭建过;缓存的话选择的Redis;微服务监控选择的是admin;另外就是跟踪链选择的是skywalking,其实上周有几天我一直在熟悉skywalking的部署,还是踩了一些坑,后面有机会我专门再写一篇吧。其他的比如jekins、docker、k8s等等,目前技术框架整体就是这样一个情况,这些内容也需要后面去学习。
今天主要学习下微服务网关,API 网关可以说是整个微服务的统一入口,其可以提供请求路由、协议转换、安全认证、服务鉴权、流量控制等等一系列服务。之前spring cloud推荐的网关是Zuul,它的1.0版本是基于阻塞IO的网关,其性能相比spring cloud gateway是要差很多的,不过Zuul也出了2.0版本,基于Netty、非阻塞、支持长链接,性能会有较大提升,只是目前spring cloud还没有整合。
Gateway是建立在Spring WebFluxSpring Boot2.xProject Reactor之上,这是一个全新的项目。不管是从性能还是说以后的可扩展性考虑,我们项目组对原有项目的改造在网关上就选择了使用GatewayGateway有几个比较新的特征:1、基于java 8,2 、基于Spring 5,Spring Boot 2.x;3、支持动态路由等。这个我建议多看下文档,介绍的比较详细,spring gateway 文档。我觉得看了文档后使用上应该没有什么问题,下图是Gateway的工作流程。客户端请求会先打到Gateway,具体的讲应该是DispacherHandler(因为Gateway引入了WebFlux,作用可以类比MVC的DispacherServlet),Gateway根据用户的请求找到相应的HandlerMapping,请求和具体的handler之间有一个映射关系,网关会对请求进行路由,handler会匹配到RoutePredicateHandlerMapping,匹配请求对应的Route,然后到达Web处理器,WebHandler代理了一系列网关过滤器和全局过滤器的实例,这些过滤器可以对请求和响应进行修改,最后由代理服务完成用户请求,并将结果返回。

图-1.png

接下来我们还是创建一个项目,引入相关的依赖:

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

之所以引入eureka是因为网关在微服务的架构中也是作为一个服务存在的,因此需要将gateway注册到eureka。

自定义路由

gateway有几个核心的概念,需要我们注意,1:Route,即路由,它是gateway非常基础也非常重要的一个块,主要由一个id,一个目标URI,一个predicates集合和一个filter集合几部分组成。2、Predicate,这个java 8中的一个断言函数,它的返回结果是boolean,这里就不再介绍了。它的入参是ServerWebExchange,它封装了ServerHttpRequestServerHttpResponse,这样开发过程中就可以针对用户请求和响应进行一些操作。3:Filter,这些filter都是由相关的工厂创建 出来的GatewayFilter实例,在这些过滤器里面可以对请求和响应进行修改,然后传递给下游。
下面的配置文件就是自己定义的一个路由:

spring:
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: http://localhost:9010
          predicates:
            - Path=/user/**
        - id: order-service
          uri: http://localhost:9020
          predicates:
            - Path=/order/**
            - Query=role,ABO

因为我还没有创建其他服务,所以只是随意配置了两个路由,id属性可以自己随意指定,如果不显式指定的话就是一个UUID;uri是具体的目标URI;predicates则是一个List,可以定义多个不同的PredicateDefinition,即请求都会找到具体的路由信息,然后判断是否满足定义的predicates条件。比如上面我定义的id为order-service的路由,在进行路由时会判断请求的path是不是满足"/order/**",且请求参数中是不是有参数名称为"role",且值为"ABO",只有同时满足这两个条件才对请求路由。因为自己还没完整的搭建好相关的服务,所以关于这块只能后期完善之后在进行测试了。
除了使用配置文件,我们也可以通过配置类来完成这些配置内容,比如下面使用代码定义了上面配置文件的路由断言,代码如下:

@Configuration
public class GatewayConfig {

    @Bean
    public RouterFunction<ServerResponse> pathPredicate() {
        RouterFunction routerFunction = RouterFunctions.route(
                RequestPredicates.path("/user/**"),
                serverRequest -> ServerResponse.ok().body(BodyInserters.fromValue("custom path route predicate")));

        return routerFunction;
    }

    @Bean
    public RouterFunction<ServerResponse> pathAndQueryPredicate() {
        RouterFunction routerFunction = RouterFunctions.route(
                RequestPredicates.path("/order/**").and(RequestPredicates.queryParam("role",Predicate.isEqual("ABO"))),
                serverRequest -> ServerResponse.ok().body(BodyInserters.fromValue("custom path and query param route predicate")));

        return routerFunction;
    }
}

此外也可以通过代码实现自定义的过滤器,如下:

    @Bean
    public RouteLocator customRoute(RouteLocatorBuilder locatorBuilder) {
        log.info(">>>> custom routeLocator <<<<");
        RouteLocator routeLocator = locatorBuilder.routes().route("custom-route",
                r -> r.path("/order/hello").
                        filters(f -> f.addRequestParameter("role","ABO")).uri("http://localhost:9010"))
                .build();

        return routeLocator;
    }

上面的代码中自定义了一个过滤器,当请求为"/order/hello"时,网关会将请求转发给"localhost:9010",且在会增加一个请求参数"role",其值为"ABO"。
关于使用上这里就不再介绍了,官方文档非常的详细,需要的时候看下官方文档我觉得应该没什么问题。有一点可能会比较好奇,就是微服务是有多个实例的,那么网关在进行路由的时候是怎么做负载均衡的呢?这一点其实只需要在自定义路由时进行配置就可以了,依然用上面的配置文件举例,我们需要对每个服务进行路由配置,比如有"user-service"和"order-service"两个服务,负载均衡可以如下:

spring:
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: lb://user-service
          predicates:
            - Path=/user/**
        - id: order-service
          uri: lb://user-service
          predicates:
            - Path=/order/**
            - Query=role,ABO

这样网关就可以对我们的路由进行负载均衡,但是负载均衡的实现还不是很了解,包括负载均衡的策略,这些都是以后自己需要学习的方向。

GlobalFilter

另外有一个很重要的一点,不管我们使用Gateway是做鉴权还是认证都其实都需要一个过滤器作为入口,这个过滤器在Gateway中就是GlobalFilter,这个接口的特殊之处在于它默认的会应用于所有的路由,也就是说当一个请求进来之后,GlobalFilter的实例和其他的过滤器都会被添加到过滤器链,当然这些过滤器链中的过滤器都是有序的,这些过滤器是按照org.springframework.core.Ordered进行排序的。另外一点,就是过滤器是双向的,也就是说请求时第一个进入的过滤器,在响应时是最后一个出去的。接下来我们代码来实现一个GlobalFilter,代码如下:

@Component
public class CustomFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest httpRequest = exchange.getRequest();
        ServerHttpResponse httpResponse = exchange.getResponse();
        // 业务代码省略
        ....
        
        return chain.filter(exchange);
    }

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

在这个过滤器里面我们可以获取到请求和响应,所以不管我们想针对用户的某个请求或者响应做一些特殊处理都可以在这里完成,使用上应该还是很简单的。


其实就使用上来讲Gateway应该没什么问题,而且官方的文档内容也是比较详细的,但是比较遗憾的是我这次没有准备项目,按理讲其实我应该先准备好几个小的demo,然后再来学习Gateway会好一些,比如我自定义的路由是不是生效,负载均衡有没有问题,怎么自定义负载均衡策略,全局过滤器的使用等等。不过自己之后慢慢的会把微服务的各个组件会搭建起来,这些问题就以后再讲吧。其实我比较关心的可能还是一些底层的实现,特别是源码部分,但是因为自己也是最近接触,所以这里暂时不对源码进行分析了,等对Gateway熟悉之后,我们再来学习它的源码。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容