### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

- Spring Cloud Gateway是Spring Cloud技術棧中的閘道器服務，本文實戰構建一個SpringCloud環境，並開發一個SpringCloud Gateway應用，快速體驗閘道器服務；
### 環境資訊
1. 作業系統：win10(64位)
2. JDK：1.8.0_181
3. Maven：3.5.0
4. Spring Cloud：Greenwich.SR

### 原始碼下載
- 如果您不打算寫程式碼，也可以從GitHub上下載本次實戰的原始碼，地址和連結資訊如下表所示：

| 名稱      |   連結 |   備註|
| :-------- | :----| :----|
| 專案主頁| https://github.com/zq2599/blog_demos | 該專案在GitHub上的主頁 |
| git倉庫地址(https)| https://github.com/zq2599/blog_demos.git | 該專案原始碼的倉庫地址，https協議 |
| git倉庫地址(ssh)| git@github.com:zq2599/blog_demos.git | 該專案原始碼的倉庫地址，ssh協議 |

- 這個git專案中有多個資料夾，本章的原始碼在gatewaydemo資料夾下，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190706234941981.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

### 整體設計
- 本次實戰的原始碼涉及到三個應用：註冊中心、服務提供者、閘道器，它們的關係和業務邏輯如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707000537192.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 整個工程基於maven構建，採用父子結構，父工程名為gatewaydemo，裡面有三個modular，分別是：eureka（）註冊中心）、provider（服務提供者）、閘道器（gateway），在IDEA上呈現的結構如下圖所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/2019070708343847.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 準備完畢，開始編碼吧；

### 建立父工程
- 建立名為gatewaydemo的maven工程，pom.xml內容如下，這是個典型的父子工程pom，dependencyManagement節點接管了版本匹配：
```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelversion>4.0.0</modelversion>

<parent>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-starter-parent</artifactid>
        <version>2.1.6.RELEASE</version>
        <relativepath></relativepath>
    </parent>
    
    <groupid>com.bolingcavalry</groupid>
    <artifactid>gatewaydemo</artifactid>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>eureak</module>
        <module>provider</module>
        <module>gateway</module>
    </modules>

<properties>
        <java.version>1.8</java.version>
        <spring-boot.version>2.1.6.RELEASE</spring-boot.version>
        <maven-compiler-plugin.version>3.5</maven-compiler-plugin.version>
        <maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
        <maven-failsafe-plugin.version>2.18.1</maven-failsafe-plugin.version>
        <maven-surefire-plugin.version>2.21.0</maven-surefire-plugin.version>
        <spring-cloud.version>Greenwich.SR2</spring-cloud.version>
    </properties>

<dependencymanagement>
        <dependencies>
            <dependency>
                <groupid>org.springframework.cloud</groupid>
                <artifactid>spring-cloud-dependencies</artifactid>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencymanagement>
</project>
```

- 如果您是用IDEA建立的工程，那麼IDEA可能會在pom.xml所在目錄自動建立 **src** 資料夾，請手動將其刪除，因為用不上；

### eureka工程
- 接下來是建立註冊中心，滑鼠右鍵點選 **gatewaydemo** 資料夾，選擇"New -> Module"：

![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707093924474.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 在彈出視窗選擇 **Spring Initializr** ，如下圖：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707094137515.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 接下來的視窗填寫Group、Artifact（這裡是eureka）、Version等資訊，其餘的預設，即可完成子工程的建立；

- 新的eureka模組的pom.xml，請修改成如下內容，可見除了指定父工程，還依賴了 **spring-cloud-starter-netflix-eureka-server** ：
```xml
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactid>gatewaydemo</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelversion>4.0.0</modelversion>

<artifactid>eureak</artifactid>
    <packaging>war</packaging>

<name>eureak Maven Webapp</name>

<dependencies>
        <dependency>
            <groupid>org.springframework.cloud</groupid>
            <artifactid>spring-cloud-starter-netflix-eureka-server</artifactid>
        </dependency>
    </dependencies>

<build>
        <finalname>${project.artifactId}</finalname>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>
        </plugins>
    </build>
</project>
```

- src\main\resources目錄下新增application.yml檔案，內容如下，這是普通的註冊中心設定：

```yml
spring:
  application:
    name: eureka
server:
  port: 8080

eureka:
  client:
    service-url:
      defaultZone: http://localhost:${server.port}/eureka/
    fetch-registry: false
    register-with-eureka: false
```

- java檔案只有一個，就是啟動類，還透過註解EnableEurekaServer開啟了註冊中心服務：
```java
package com.bolingcavalry.eureka;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

@SpringBootApplication
@EnableEurekaServer
public class EurekaApplication {

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

- 以上就是註冊中心eureka的內容，執行EurekaApplication即可啟動服務，訪問8080埠的結果如下：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707111324773.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 現在註冊中心已經就緒，開始編寫服務提供者provider應用的程式碼吧。

### provider工程
- 在gatewaydemo下建立一個子工程，名為provider，pom.xml內容如下，可見用到了spring-boot-starter-web和spring-cloud-starter-netflix-eureka-client這兩個依賴，分別用來支援web服務和註冊發現：

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactid>gatewaydemo</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelversion>4.0.0</modelversion>

<artifactid>provider</artifactid>

<dependencies>
        <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>
    </dependencies>

<build>
        <finalname>${project.artifactId}</finalname>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>
        </plugins>
    </build>
</project>
```

- 配置檔案application.yml如下，指定了註冊中心地址，並且自身埠為8081：
```yml
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8080/eureka/
server:
  port: 8081
spring:
  application:
    name: provider
```

- 啟動類ProviderApplication.java：
```java
package com.bolingcavalry.provider;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ProviderApplication {

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

- 增加一個controller，用於響應web請求，注意hello方法會從請求的header中取出名為 **extendtag** 的屬性值，返回給瀏覽器：

```java
package com.bolingcavalry.provider.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.text.SimpleDateFormat;
import java.util.Date;

@RestController
@RequestMapping("/hello")
public class HelloController {

@RequestMapping(value = "time", method = RequestMethod.GET)
    public String hello(HttpServletRequest request){

return "hello, "
                + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date())
                + ", extendtag ["
                + request.getHeader("extendtag")
                + "]";
    }
}
```

- 啟動應用，再次重新整理eureka的頁面localhost:8080，可見provider應用已經註冊上去了，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707114924514.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 訪問地址：http://localhost:8081/hello/time ，這是controller提供的web服務介面，得到響應如下圖，因為header中沒有名為"extendtag"的屬性，因此返回了null：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/2019070711513750.jpg)
提供服務的provider已經OK，可以開發閘道器服務了；

### gateway工程
- 在gatewaydemo下建立一個子工程，名為gateway，pom.xml內容如下，可見用到了spring-cloud-starter-gateway和spring-cloud-starter-netflix-eureka-client這兩個依賴，分別用來支援閘道器服務和註冊發現：

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactid>gatewaydemo</artifactid>
        <groupid>com.bolingcavalry</groupid>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelversion>4.0.0</modelversion>

<artifactid>gateway</artifactid>

<dependencies>
        <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>
    </dependencies>

<build>
        <finalname>${project.artifactId}</finalname>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>
        </plugins>
    </build>
</project>
```

- 配置檔案application.yml如下，指定了註冊中心地址，並且自身埠為8082，還有開啟了閘道器服務：
```yml
server:
  port: 8082

spring:
  application:
    name: gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
          lowerCaseServiceId: true
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8080/eureka/
```

- 啟動類GatewayApplication .java，可見例項化了一個RouteLocator，該例項就是路由規則，具體的功能請參考程式碼中的註釋：
```java
package com.bolingcavalry.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class GatewayApplication {

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

@Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                //增加一個path匹配，以"/gateway/hello/"開頭的請求都在此路由
                .route(r -> r.path("/customize/hello/**")
                        //表示將路徑中的第一級引數刪除，用剩下的路徑與provider的路徑做拼接，
                        //這裡就是"lb://provider/hello/"，能匹配到provider的HelloController的路徑
                        .filters(f -> f.stripPrefix(1)
                                       //在請求的header中新增一個key&value
                                       .addRequestHeader("extendtag", "geteway-" + System.currentTimeMillis()))
                        //指定匹配服務provider，lb是load balance的意思
                        .uri("lb://provider")
                ).build();
    }
}

```

- 啟動應用，再次重新整理eureka的頁面localhost:8080，可見gateway應用已經註冊上去了，如下圖紅框所示：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707130227316.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly94aW5jaGVuLmJsb2cuY3Nkbi5uZXQ=,size_16,color_FFFFFF,t_70)

- 訪問地址：http://localhost:8082/customize/hello/time ，這是符合前面我們配置的路由規則的路徑，customize被刪除掉之後，將剩餘的路徑轉發到provider服務，於是請求的真正地址就是provider服務的/hello/time，得到響應如下圖，因為gateway在轉發的時候給header中設定了名為"extendtag"的屬性，因此返回了extendtag是有內容的：
![在這裡插入圖片描述](https://img-blog.csdnimg.cn/20190707130925458.jpg)

- 至此，極速體驗SpringCloud Gateway的實戰就完成了，這裡我們只簡單的體驗了Gateway的一些基本功能，希望本文能幫助您快速搭建環境和開發應用，其實該框架的功能是非常強大的，如果您有興趣建議從官網的API文件入手深入學習。

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)

極速體驗SpringCloud Gateway

相關文章