[Руководство по Spring Cloud Elite] Углубленное исследование и практический бой: расширенные приложения и лучшие практики Gateway

[Руководство по Spring Cloud Elite] Углубленное исследование и практический бой: продвинутые приложения и лучшие практики шлюза

2024-07-12

1. Введение

Spring Cloud Gateway предоставляет шлюз API, построенный на основе экосистемы Spring, включая Spring 5, Spring Boot 2 и Project Reactor. Spring Cloud Gateway стремится предоставить простой, но эффективный способ маршрутизации и предоставляет им некоторые базовые функции шлюза, такие как безопасность, мониторинг/метрики и отказоустойчивость.

Ниже мы проиллюстрируем это на двух примерах:

2. Примечания к выпуску

Версия Spring Boot: 2.2.5.RELEASE

Версия Spring Cloud: Hoxton.SR3

Если не указано иное, все процедуры Spring Cloud будут использовать вышеуказанную версию.

3. Использование шлюза

Рекомендация: Прежде чем приступить к этому курсу, если вы не понимаете подробные этапы создания Эврики, рекомендуется прочитать [Узнайте, как использовать центр регистрации Spring Cloud Eureka на примере].Не беда, если вы еще этого не видели, просто следуйте инструкциям ниже, чтобы начать:

3.1 Создайте новый родительский проект

Если у вас нет родительского проекта (если вы завершили создание экземпляра центра регистрации, у вас должен быть родительский проект), используйте простой Maven для создания родительского проекта:

После его создания откройте файл pom.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>
 
    <groupId>org.cherry</groupId>
    <artifactId>springcloudproject</artifactId>
    <version>1.0-SNAPSHOT</version>
 
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>14</java.version>
        <spring-cloud.version>Hoxton.SR3</spring-cloud.version>
        <springboot.version>2.2.5.RELEASE</springboot.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>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${springboot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

Удалить папку src

3.2 Создать подпроект шлюза

В родительском проекте используйте Spring Initializr, чтобы создать новый подпроект шлюза и выбрать зависимость от шлюза. Простая карта выглядит следующим образом:

После сборки измените файл pom.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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>springcloudproject</artifactId>
        <groupId>com.cherry</groupId>
        <version>1.0-SNAPSHOT</version>
       <!-- <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/> &lt;!&ndash; lookup parent from repository &ndash;&gt;-->
    </parent>
    <groupId>com.cherry</groupId>
    <artifactId>gateway</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>gateway</name>
    <description>Demo project for Spring Boot</description>
 
    <!--<properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.SR3</spring-cloud.version>
    </properties>-->
 
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
 
    <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>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
 
</project>

Измените файл конфигурации application.properties, добавив суффикс yml (то есть измените имя файла на application.yml), чтобы настроить шлюз.

Здесь мы используем блог csdn в качестве поставщика услуг.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833

Выполнить запуск, запускается встроенный Tomcat Springboot, порт 9001

Входной адрес браузераhttp://localhost:9001/huanzi833

3.3 Закройте шлюз

Если вы хотите, чтобы шлюз был недоступен, вы можете добавить в application.yml следующие настройки:


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
      enabled: false

Доступ через браузер, результаты следующие:

4. Сопоставьте правила маршрутизации по времени

Примечание. После изменения файла свойств перезапустите приложение самостоятельно. Я не буду каждый раз повторять инструкции.

4.1 Время после сопоставления маршрута

Маршрутизация вступает в силу по истечении времени, установленного параметром «После». Например: запросы после 1 января 2020 года пересылаются в мой блог, а запросы до этого времени не могут быть перенаправлены.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
            - After=2020-01-01T00:00:00+08:00[Asia/Shanghai]
      enabled: true

4.2 Время до сопоставления маршрутизации

Маршрутизация до вступления в силу времени, установленного параметром «До». Например: запросы до 1 января 2021 года пересылаются в мой блог, а запросы после этого времени не могут быть перенаправлены.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
            - After=2020-01-01T00:00:00+08:00[Asia/Shanghai]
            - Before=Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
      enabled: true

4.3 Время между сопоставлением маршрутов

Вступает в силу маршрутизация между временами, установленными параметром «Между». Например: запросы в период с 1 января 2020 г. по 1 октября 2020 г. пересылаются в мой блог. Запросы вне этого времени не могут быть перенаправлены. Обычно «Между», «После» и «После». вместе, чтобы избежать повторных настроек.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
#            - After=2019-01-01T00:00:00+08:00[Asia/Shanghai]
#            - Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
            - Between=2020-01-01T00:00:00+08:00[Asia/Shanghai], 2020-10-01T00:00:00+08:00[Asia/Shanghai]
      enabled: true

4.4 Сопоставление маршрутов файлов cookie

Для файла cookie предикаты могут получать два параметра: один — имя файла cookie, а другой — регулярное выражение. Правила маршрутизации будут соответствовать соответствующему значению имени файла cookie и регулярному выражению. Если совпадения нет, маршрутизация будет выполнена. маршрутизация будет выполнена. Она не будет выполнена.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
#            - After=2019-01-01T00:00:00+08:00[Asia/Shanghai]
#            - Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
            - Between=2020-01-01T00:00:00+08:00[Asia/Shanghai], 2020-10-01T00:00:00+08:00[Asia/Shanghai]
            - Cookie=uid, cherry #通过cookie进行路由规则的匹配
      enabled: true

Используя сопоставление маршрутизации файлов cookie, мы можем ввести cmd для проверки и ввести в cmd следующий оператор:

4.5 Сопоставление маршрутов заголовка

Подобно сопоставлению маршрутов cookie, здесь также есть два параметра: имя параметра и регулярное выражение. Если совпадение есть, маршрут будет выполнен. Если совпадения нет, маршрут не будет выполнен.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
#            - After=2019-01-01T00:00:00+08:00[Asia/Shanghai]
#            - Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
            - Between=2020-01-01T00:00:00+08:00[Asia/Shanghai], 2020-10-01T00:00:00+08:00[Asia/Shanghai]
            - Cookie=uid, cherry #通过cookie进行路由规则的匹配
            - Header=X-Request-Id, d+ #Header路由规则
      enabled: true

Введите cmd для проверки, введите следующий оператор в cmd:

4.6 Сопоставление маршрута хоста

Следующая конфигурация соответствует адресу хоста, например www.csdn.net, www.baidu.com или blog.csdn.net и другим адресам.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
#            - After=2019-01-01T00:00:00+08:00[Asia/Shanghai]
#            - Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
            - Between=2020-01-01T00:00:00+08:00[Asia/Shanghai], 2020-10-01T00:00:00+08:00[Asia/Shanghai]
            - Cookie=uid, cherry #通过cookie进行路由规则的匹配
            - Header=X-Request-Id, d+ #Header路由规则
            - Host=**.csdn.net, **.baidu.com #Host路由规则
      enabled: true

Введите cmd для проверки, введите следующий оператор в cmd:

4.7 Маршрут сопоставления методов


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
#            - After=2019-01-01T00:00:00+08:00[Asia/Shanghai]
#            - Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
            - Between=2020-01-01T00:00:00+08:00[Asia/Shanghai], 2020-10-01T00:00:00+08:00[Asia/Shanghai]
            - Cookie=uid, cherry #通过cookie进行路由规则的匹配
            - Header=X-Request-Id, d+ #Header路由规则
            - Host=**.csdn.net, **.baidu.com #Host路由规则
            - Method=GET, POST #Method路由规则
      enabled: true

Введите cmd для выполнения теста Get. Введите следующий оператор в cmd:

Введите cmd для выполнения теста POST. Введите следующий оператор в cmd: (Примечание: если путь в контроллере поставщика услуг использует GetMapping и при вызове здесь используется -X POST, появится ошибка 404).

4.8 Сопоставление IP-адресов

предикат также поддерживает маршрутизацию, устанавливая запрос с определенным номером интервала IP, например 192.168.1.1/24 (где 192.168.1.1 — это IP-адрес, 24 — это маска подсети, а 24 здесь означает, что маска подсети — 255.255.255.0 ). Вы можете установить этот адрес в качестве локального IP-адреса для тестирования.


server:
  port: 9001
 
spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
        - id: gateway-service
          uri: https://blog.csdn.net
          predicates:
            - Path=/huanzi833
#            - After=2019-01-01T00:00:00+08:00[Asia/Shanghai]
#            - Before=2021-01-01T00:00:00+08:00[Asia/Shanghai]
            - Between=2020-01-01T00:00:00+08:00[Asia/Shanghai], 2020-10-01T00:00:00+08:00[Asia/Shanghai]
            - Cookie=uid, cherry #通过cookie进行路由规则的匹配
            - Header=X-Request-Id, d+ #Header路由规则
            - Host=**.csdn.net, **.baidu.com #Host路由规则
            - Method=GET, POST #Method路由规则
            - RemoteAddr=192.168.1.1/24
      enabled: true

Сопоставление маршрута пути/сопоставление параметров/сопоставление веса будет завершено при интеграции с центром регистрации ниже.

5. Сделать шлюз услугой и связать его с центром регистрации, поставщиками услуг и потребителями.

1. Сначала создаем сервисный центр Эврика, код такой:

Обмен технологиями