Gateway

什么是Gateway

  由于Netflix的zuul發(fā)生問(wèn)題，spring公司自己研發(fā)了一套網(wǎng)關(guān)框架Gateway用于取代zuul的使用。什么是gateway呢？spring cloud Gateway是使用Webflux中的reactor-netty響應(yīng)式編程組件，底層使用的是netty通訊框架。

什么是api網(wǎng)關(guān)

  API gateway 處于客戶(hù)端與各個(gè)微服務(wù)之間，它擔(dān)任了反向代理的角色，將不同的請(qǐng)求路由到相對(duì)應(yīng)的微服務(wù)中去。與此同時(shí)，它還有以下功能：安全，限流，緩存，日志，監(jiān)控，重試，熔斷等。網(wǎng)關(guān)就是所有項(xiàng)目的一個(gè)統(tǒng)一入口，也可以說(shuō)是進(jìn)入系統(tǒng)的唯一節(jié)點(diǎn)。

網(wǎng)關(guān)的三個(gè)核心概念

路由(Route)

  路由是構(gòu)建網(wǎng)關(guān)的基本模塊，它由ID、目標(biāo)URI、一系列的斷言和過(guò)濾器組成，如果斷言為真則匹配該路由。就是根據(jù)斷言和過(guò)濾器提供的某些規(guī)則,將請(qǐng)求發(fā)送到指定服務(wù)上

斷言(Predicate)

  開(kāi)發(fā)人員可以匹配HTTP請(qǐng)求中的所有內(nèi)容(例如請(qǐng)求頭或請(qǐng)求參數(shù))，如果請(qǐng)求與斷言相匹配則進(jìn)行路由，就是定義匹配規(guī)則，只有滿(mǎn)足斷言的請(qǐng)求才會(huì)繼續(xù)進(jìn)行路由

過(guò)濾(Filter)

  指的是Spring框架中GatewayFilter的實(shí)例，使用過(guò)濾器，可以在請(qǐng)求被路由前或者之后對(duì)請(qǐng)求進(jìn)行修改。當(dāng)請(qǐng)求進(jìn)行斷言之前，或者滿(mǎn)足斷言后會(huì)繼續(xù)進(jìn)行路由，但是由于過(guò)濾的存在請(qǐng)求會(huì)再次被過(guò)濾條件進(jìn)行指定的修改操作

gateway的工作流程

  客戶(hù)端向Spring Cloud Gateway發(fā)出請(qǐng)求。然后在Gateway Handler Mapping 中找到與請(qǐng)求相匹配的路由，將其發(fā)送到GatewayWeb Handler。Handler再通過(guò)指定的過(guò)濾器鏈來(lái)將請(qǐng)求發(fā)送到我們實(shí)際的服務(wù)執(zhí)行業(yè)務(wù)邏輯，然后返回。

  過(guò)濾器之間用虛線分開(kāi)是因?yàn)檫^(guò)濾器可能會(huì)在發(fā)送代理請(qǐng)求之前(“pre”）或之后(“post”)執(zhí)行業(yè)務(wù)邏輯。Filter在“pre”類(lèi)型的過(guò)濾器可以做參數(shù)校驗(yàn)、權(quán)限校驗(yàn)、流量監(jiān)控、日志輸出、協(xié)議轉(zhuǎn)換等，在“post”類(lèi)型的過(guò)濾器中可以做響應(yīng)內(nèi)容、響應(yīng)頭的修改，日志的輸出，流量監(jiān)控等有著非常重要的作用。

如何使用Gateway

gateway路由轉(zhuǎn)發(fā)

使用配置文件

  第一步： 創(chuàng)建一個(gè)子模塊用于配置gateway，導(dǎo)入相關(guān)依賴(lài)，其中最重要的就是gateway的啟動(dòng)器。一定不能引入web場(chǎng)景啟動(dòng)器依賴(lài)，否則gateway模塊將無(wú)法啟動(dòng)

<!--gateway-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

  第二步： 配置文件

server:
  port: 9527

spring:
  application:
    name: cloud-gateway

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服務(wù)提供者provider注冊(cè)進(jìn)eureka服務(wù)列表內(nèi)
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://localhost:7001/eureka

  第三步： 現(xiàn)在我們想在支付微服務(wù)8001之前使用gateway網(wǎng)關(guān)，讓請(qǐng)求在訪問(wèn)8001微服務(wù)之前先經(jīng)過(guò)gateway網(wǎng)關(guān)。于是我們需要先配置配置文件

spring:
  cloud:
    gateway:
      routes:
        - id: payment_routh #payment_route    #路由的ID，沒(méi)有固定規(guī)則但要求唯一，建議配合服務(wù)名
          #uri: http://localhost:8001          #匹配后提供服務(wù)的路由地址
          uri: lb://cloud-payment-service #匹配后提供服務(wù)的路由地址
          predicates:
            - Path=/payment/get/**         # 斷言，路徑相匹配的進(jìn)行路由

        - id: payment_routh2 #payment_route    #路由的ID，沒(méi)有固定規(guī)則但要求唯一，建議配合服務(wù)名
          #uri: http://localhost:8001          #匹配后提供服務(wù)的路由地址
          uri: lb://cloud-payment-service #匹配后提供服務(wù)的路由地址
          predicates:
            - Path=/payment/create/**         # 斷言，路徑相匹配的進(jìn)行路由
            - After=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]

  經(jīng)過(guò)如上操作，即可實(shí)現(xiàn)如果通過(guò)9527端口也可以訪問(wèn)8001的接口，也就是說(shuō)請(qǐng)求先是通過(guò)9527網(wǎng)關(guān)，將符合yml配置文件中配置的請(qǐng)求進(jìn)行路由轉(zhuǎn)發(fā)至8001端口

使用代碼配置

  使用代碼配置的話(huà)就需要使用到自定義配置類(lèi)了，將上面的第三步由配置文件配置修改為自定義配置類(lèi)，前兩步要保持一致。其中route方法的第一個(gè)參數(shù)相當(dāng)于id配置，r.path相當(dāng)于predicates斷言，r.path.uri就是請(qǐng)求將要路由到的地址

@Configuration
public class GateWayConfig {
    @Bean
    public RouteLocator customRouteLocatorBuilder(RouteLocatorBuilder routeLocatorBuilder) {
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_route_atguigu",
                        r -> r.path("/guonei")
                                .uri("http://news.baidu.com/guonei"))
                .build();
        return routes.build();
    }
}

路由實(shí)現(xiàn)負(fù)載均衡

  之前都是通過(guò)ribbon來(lái)實(shí)現(xiàn)請(qǐng)求的負(fù)載均衡，其實(shí)gateway網(wǎng)關(guān)也可以通過(guò)注冊(cè)中心的微服務(wù)名來(lái)實(shí)現(xiàn)負(fù)載均衡，也就是動(dòng)態(tài)路由的功能。這里我們先通過(guò)以下配置開(kāi)啟從注冊(cè)中心動(dòng)態(tài)創(chuàng)建路由的功能

spring:
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true #開(kāi)啟從注冊(cè)中心動(dòng)態(tài)創(chuàng)建路由的功能，利用微服務(wù)名進(jìn)行路由

然后將原先寫(xiě)死的路徑改為微服務(wù)名，通過(guò)這個(gè)實(shí)現(xiàn)對(duì)微服務(wù)的輪詢(xún)

spring:
  cloud:
    gateway:
      routes:
        - id: payment_routh #payment_route    #路由的ID，沒(méi)有固定規(guī)則但要求唯一，建議配合服務(wù)名
          #uri: http://localhost:8001          #匹配后提供服務(wù)的路由地址
          uri: lb://cloud-payment-service   #匹配后提供服務(wù)的路由地址
          predicates:
            - Path=/payment/get/**         # 斷言，路徑相匹配的進(jìn)行路由

        - id: payment_routh2 #payment_route    #路由的ID，沒(méi)有固定規(guī)則但要求唯一，建議配合服務(wù)名
          #uri: http://localhost:8001          #匹配后提供服務(wù)的路由地址
          uri: lb://cloud-payment-service   #匹配后提供服務(wù)的路由地址
          predicates:
            - Path=/payment/create/**         # 斷言，路徑相匹配的進(jìn)行路由

gateway九種斷言

  gateway的斷言實(shí)際上就是配置文件中的predicates配置項(xiàng)，既然這個(gè)單詞是復(fù)數(shù)，那就意味著它不僅僅可以配置一種斷言，實(shí)際上斷言的類(lèi)型有九種，它們的意思以及使用方式我都寫(xiě)在了下面

predicates:
    - Path=/payment/create/**         # 路徑斷言，路徑相匹配的進(jìn)行路由
    - Before=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]   # 時(shí)間斷言，時(shí)間Before、After、Between指定時(shí)間的請(qǐng)求進(jìn)行路由
    - After=2020-03-08T10:59:34.102+08:00[Asia/Shanghai]
    - Between=2020-03-08T10:59:34.102+08:00[Asia/Shanghai] ,  2020-03-08T10:59:34.102+08:00[Asia/Shanghai]
    - Cookie=username,zzyy            # cookie斷言，攜帶名為username且值為zzyy的請(qǐng)求進(jìn)行路由（zzyy可以替換為正則）
    - Header=X-Request-Id, \d+        # header斷言，請(qǐng)求頭攜帶X-Request-Id且值滿(mǎn)足正則"\d+"的請(qǐng)求進(jìn)行路由
    - Host=**.atguigu.com, **.atg.com # host斷言，請(qǐng)求格式符合的請(qǐng)求進(jìn)行路由
    - Method=GET                      # method斷言，請(qǐng)求方式為get的請(qǐng)求進(jìn)行路由
    - Query=username, \d+             # query斷言，有參數(shù)名為username且值滿(mǎn)足正則"\d+"的請(qǐng)求進(jìn)行路由

gateway過(guò)濾修改

  使用配置文件實(shí)現(xiàn)filter過(guò)濾修改很簡(jiǎn)單，類(lèi)似于斷言的使用，在配置文件直接配置即可

filters:
    - AddRequestParameter=X-Request-Id,1024

  但是一般不這么使用filter，我們都是自定義一個(gè)全局GlobalFilter，重點(diǎn)就是@Component注解，類(lèi)實(shí)現(xiàn)GlobalFilter, Ordered接口重寫(xiě)方法，設(shè)置過(guò)濾規(guī)則和優(yōu)先級(jí)

@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        /**
         * 判斷請(qǐng)求中包含uname參數(shù)且它的值不為空，否則拒絕請(qǐng)求
         */
        String uname = exchange.getRequest().getQueryParams().getFirst("uname");
        if (uname == null) {
            log.info("*******用戶(hù)名為null，非法用戶(hù)，o(╥﹏╥)o");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }
    /**
     * 加載過(guò)濾器順序，數(shù)字越小優(yōu)先級(jí)越高
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

到此這篇關(guān)于SpringCloud服務(wù)網(wǎng)關(guān)Gateway的使用教程詳解的文章就介紹到這了,更多相關(guān)SpringCloud Gateway內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！