網關我選 Spring Cloud Gateway

  • 2019 年 10 月 11 日
  • 筆記

網關可提供請求路由與組合、協議轉換、安全認證、服務鑒權、流量控制與日誌監控等服務。可選的網關有不少，比如 Nginx、高性能網關 OpenResty、Linkerd 以及 Spring Cloud Gateway。

如果是真的追求高性能，那肯定是選擇 Nginx 或者 OpenResty 無疑了， 但是對性能要求不是很高的話，並且又在用 Spring Cloud 系列，那當然就要選擇 Spring Cloud Gateway 了。

網關的基礎就是路由功能，通俗解釋就是地址轉發，將一個請求地址轉發到實際的服務地址。比如請求的是 http://xxx.com/api 的路由地址，實際上會被轉發到 http://xxx.com:8888 上來，這就是個最簡單的路由方式。

我們可以理解為 Spring Cloud Gateway 就是針對進來的請求做各種判斷和處理，比如說判斷請求的合法性、權限驗證，請求地址改寫，請求參數、頭信息、cookie 信息的分析和改寫，請求速率控制，日誌留存等。而這些都可以方便的通過 Predicate 和 GatewayFilter 來組合實現。

創建 Spring Cloud Gateway 項目

Spring Cloud 版本是 Greenwich.SR2，Spring Boot 版本 2.1.6.RELEASE，JDK 1.8。

接下來正式創建一個 Gateway 項目。

首先做兩個微服務，當做路由轉發的目標服務

兩個微服務是以 consul 作為服務註冊中心的，可以看這篇文章服務註冊發現、配置中心集一體的 Spring Cloud Consul

1、創建 consul-order 服務，具體可以去 github 上看代碼（https://github.com/huzhicheng/spring-cloud-study/tree/master/consul/consul-order），很簡單的一個服務。創建的 RESTful Controller 如下：

@RestController  @RequestMapping(value = "order")  public class OrderController {        @Value("${spring.application.name}")      private String applicationName;          @GetMapping(value = "get")      public CustomerOrder getOrder(){          CustomerOrder customerOrder = new CustomerOrder();          customerOrder.setOrderId("9999");          customerOrder.setProductName("MacBook Pro");          customerOrder.setClient(applicationName);          return customerOrder;      }  }

總之，最後直接訪問這個接口的地址為 http://localhost:5006/order/get

2、創建 consul-user 服務，具體代碼可以到 github 上查看(https://github.com/huzhicheng/spring-cloud-study/tree/master/consul/consul-user)。創建的 RESTful Controller 內容如下：

@RestController  @RequestMapping(value = "user")  public class UserController {        @GetMapping(value = "get")      public User getUserInfo(){          User user = new User();          user.setName("古時的風箏");          user.setAge(8);          user.setLocation("北京");          return user;      }  }

和上面的微服務有點區別的就是設置了 context-path

server:    port: 5005    servlet:      context-path: /user-service

之所以這樣不同的設置，是因為下面要驗證一個 filter。總之，最後上述接口的訪問地址為：http://localhost:5005/user-service/user/get

創建一個項目，並引入 maven 包

<dependency>      <groupId>org.springframework.cloud</groupId>      <artifactId>spring-cloud-starter-gateway</artifactId>  </dependency>  <dependency>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-starter-webflux</artifactId>  </dependency>  <dependency>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-starter-actuator</artifactId>  </dependency>

配置簡單的路由轉發

路由配置有兩種方式。一種是配置文件，另外一種是代碼方式配置，WebFlux 的反應式編程方式。所以我們 pom 文件中要引入 WebFlux 的包。這是 Spring 5 的新特性。

1、先看第一種配置文件方式配置：

server:    port: 10000  spring:    application:      name: gateway    cloud:      gateway:        discovery:          locator:            enabled: true            lower-case-service-id: false # 是否將服務id轉換為小寫        routes:        - id: userServiceRouter          uri: lb://consul-user          predicates:          - Path=/user-service/**        - id: orderServiceRouter          uri: lb://consul-order          predicates:          - Path=/order-service/**          filters:          - StripPrefix=1      consul:        host: localhost #註冊gateway網關到consul        port: 8500        discovery:          service-name: service-gateway

其中包括 Spring Boot 項目的基本配置，name、port ，還有關於 consul 的配置，要將網關服務註冊到註冊中心。

上面配置中創建了兩條路由規則，路由規則名稱通過 id 設置，分別是 userServiceRouter 和 orderServiceRouter，通過 predicates.Path 設置待轉發的 url，通過 uri 設置轉發後的目標地址。上面配置將以/user-service/開頭的地址轉發到 lb://consul-user,固定格式 lb + 服務id，在有註冊中心的情況下要這樣寫，如過沒有註冊中心，可以直接寫目標 url。

下面的路由規則中多了一個 StripPrefix 的 filter ，這個是 Gateway 的內置 filter，作用就是去掉 Path 中的指定部分，StripPrefix=1，就是以 / 分隔，去掉第一部分，比如 /a/b/c 這個地址，在 StripPrefix=1 的作用下，就會轉發到 /b/c/，當 StripPrefix=2 的時候，就會轉發到 /c/。

配置好上述接口，然後啟動網關服務。訪問規則就會有如下對應關係:

http://localhost:10000/user-service/user/get->http://localhost:5005/user-service/user/get

http://localhost:10000/order-service/order/get->http://localhost:5006/order/get

當然這只是針對每一個目標服務只有一個實例的情況，如果有多個實例，就會按照負載策略落到對應的實例中。

2、代碼方式的路由配置

@Bean  public RouteLocator kiteRouteLocator(RouteLocatorBuilder builder) {      return builder.routes()          .route("userRouter", r -> r.path("/user-service/**")              .filters(f ->                  f.addResponseHeader("X-CustomerHeader", "kite"))              .uri("lb://consul-user")          )          .route("orderRouter", r -> r.path("/order-service/**")              .filters(f -> f.stripPrefix(1)).uri("lb://consul-order")          )          .build();  }

上面的這段代碼和前面的配置文件的內容是同樣的作用。只要實現一個返回類型為 RouteLocator，參數為 RouteLocatorBuilder類型的 Bean。

你看後面那一連串的 r.path().filters().uri() 了嗎，用它們就可以簡單的配置出路由規則，而且可讀性也比較強。另外，Gateway 還套用了 Predicate 的規則來構建更加靈活、複雜的路由規則。Predicate 是 Java 8 增加的邏輯計算庫，有 negate()、and()、or()、isEqual()幾個方法。具體的代碼在 PredicateSpec 和 UriSpec 這兩個類里，一目了然。

PredicateSpec 里有這麼多方法，都可以結合 and、or 組合起來使用。

接下來就說到 filter，Gateway 內置了很多的 filter，可以在 GatewayFilterSpec 類下找到方法封裝，每一個 filter 都由一個 factory 的 apply 實現，都在 org.springframework.cloud.gateway.filter.factory包下，有必要的話可以直接看源碼。 比如上面用到的 StripPrefix。還有 addResponseHeader，它的作用是在 Response 對象的 header 中添加請求頭。

啟動網關服務

啟動網關，並訪問兩個接口測試，接口分別為 http://localhost:10000/user-service/user/get和http://localhost:10000/order-service/order/get，正常返回數據，則說明網關服務配置正常。

巧用 StripPrefix filter

微服務多了之後，路由的轉發規則也就多了，比方說訂單相關請求要轉發到訂單微服務集群，用戶相關請求要轉發到用戶微服務集群，最終開放給終端的接口也要能表明是哪個微服務的，除了接口文檔里說明之外，接口本身最好也能明確標識。

一種方式是在微服務的配置文件中配置上server.servlet.context-path。

還有一種方式就是在路由規則的 path 中配置，然後加上 StripPrefix 配置，選擇性的去掉請求 url 中的某些部分。比如我們請求 Gateway的地址為 order-service/order/get，則經過 StripPrefix(1) 之後，會把請求地址變為 order/get，然後根據路由規則定向到具體的微服務地址或者特定的 url。

本篇就介紹 Spring Cloud Gateway 的基本用法，後續還會有關於集成安全認證、鑒權、限流、日誌等相關內容，敬請關注。

不要吝惜你的「推薦」呦

歡迎關注，不定期更新本系列和其他文章
古時的風箏 ，進入公眾號可以加入交流群

VirMach 便宜 VPS

QNews

QNews