Spring Cloud Gateway 之 服務注冊與發現

簡介

上幾篇主要講解了網關在單個服務的使用，在實際的工作中，服務的相互調用都是依賴于服務中心提供的入口來使用，服務中心往往注冊了很多服務，如果每個服務都需要單獨配置的話，非常麻煩。Spring Cloud Gateway 提供了一種默認轉發的能力，只要將 Spring Cloud Gateway 注冊到服務中心，Spring Cloud Gateway 默認就會代理服務中心的所有服務，下面就具體講解下。

工程介紹

本節案例中一共有四個工程，如下：

工程詳情

注冊中心

pom.xml

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

application.yml

server:
  port: 8760

eureka:
  instance:
    hostname: localhost
  client:
    registerWithEureka: false
    fetchRegistry: false
    serviceUrl:
      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/

spring:
  application:
    name: sc-eurka-server

路由網關

pom.xml

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

application.yml

server:
  port: 8761

spring:
  application:
    name: sc-service-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8760/eureka/

配置說明：

• spring.cloud.gateway.discovery.locator.enabled：是否與服務注冊于發現組件進行結合，通過 serviceId 轉發到具體的服務實例。默認為 false，設為 true 便開啟通過服務中心的自動根據 serviceId 創建路由的功能。
• pring.cloud.gateway.discovery.locator.lowerCaseServiceId：是將請求路徑上的服務名配置為小寫（因為服務注冊的時候，向注冊中心注冊時將服務名轉成大寫的了）。
• eureka.client.service-url.defaultZone：指定注冊中心的地址，以便使用服務發現功能。
• logging.level.org.springframework.cloud.gateway：調整相 gateway 包的 log 級別，以便排查問題。

服務提供者

pom.xml

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

application.yml

server:
  port: 8762

spring:
  application:
    name: sc-service-hi

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8760/eureka/

啟動類

@SpringBootApplication
@EnableEurekaClient
@RestController
public class ScServiceHiApplication {

    public static void main(String[] args) {
        SpringApplication.run( ScServiceHiApplication.class, args );
    }

    @Value("${server.port}")
    String port;

    @GetMapping("/hi")
    public String home(@RequestParam(value = "name", defaultValue = "zhangsan") String name) {
        return "hi " + name + " ,i am from port:" + port;
    }

}

啟動三個項目后，訪問 http://localhost:8761/sc-service-hi/hi?name=zhangsan~，返回如下：

hi zhangsan~ ,i am from port:8762

說明服務網關轉發成功了。

自定義請求路徑

在上面的例子中，向sc-service-gateway發送的請求時，url必須帶上服務名sc-service-hi這個前綴，才能轉發到sc-service-hi上，轉發之前會將sc-service-hi去掉。有時服務名稱過長，不易使用，需要自定義路徑并轉發到具體的服務上。配置如下：

server:
  port: 8761

spring:
  application:
    name: sc-service-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: false
          lowerCaseServiceId: true
      routes:
        - id: sc-service-hi
          uri: lb://SC-SERVICE-HI
          predicates:
          - Path=/demo/**
          filters:
          - StripPrefix=1

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8760/eureka/

logging:
  level:
    org.springframework.cloud.gateway: debug

在上面的配置中，配置了一個Path 的 predict,將以/demo/**開頭的請求都會轉發到uri為lb://SC-SERVICE-HI的地址上，lb://SC-SERVICE-HI即sc-service-hi服務的負載均衡地址，并用StripPrefix的filter 在轉發之前將/demo去掉。同時將spring.cloud.gateway.discovery.locator.enabled改為false，如果不改的話，之前的localhost:8761/sc-service-hi/hi?name=zhangsan~這樣的請求地址也能正常訪問，因為這時為每個服務創建了2個router。

重啟sc-service-gateway項目后，訪問 http://localhost:8761/demo/hi?name=zhangsan~ ，返回如下：

hi zhangsan~ ,i am from port:8762

服務網關轉發成功，說明自定義請求路徑生效了。

源碼:https://github.com/gf-huanchupk/SpringCloudLearning/tree/master/chapter13

歡迎關注我的公眾號《程序員果果》，關注有驚喜~~