Spring Cloud Gateway 入门示例

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6

前言

Spring Cloud Gateway 基于 Spring Boot 2.x、Spring WebFlux和Project ReactorWebFlux默认启动容器是Netty在学习之前最好是做一些相关的了解。特别是WebFlux。

pom文件配置

<?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.example</groupId>
    <artifactId>myGateway</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <build.name>myGateway</build.name>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>

        <spring.cloud.version>2021.0.4</spring.cloud.version>
        <spring.cloud.alibaba.version>2021.0.4.0</spring.cloud.alibaba.version>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.11</version>
    </parent>

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

    <dependencies>
        <!-- 添加网关支持 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
    </dependencies>


    <profiles>
        <profile>
            <id>dev</id>
            <properties>
                <profileActive>dev</profileActive>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profileActive>test</profileActive>
            </properties>
        </profile>
        <profile>
            <id>pre</id>
            <properties>
                <profileActive>pre</profileActive>
            </properties>
        </profile>
        <profile>
            <id>prod</id>
            <properties>
                <profileActive>prod</profileActive>
            </properties>
        </profile>
    </profiles>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>

        <finalName>${build.name}</finalName>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
                <includes>
                    <include>mapper/**/*.xml</include>
                    <include>application.yml</include>
                    <include>application-${profileActive}.yml</include>
                    <include>application.properties</include>
                    <include>application-${profileActive}.properties</include>
                    <include>bootstrap.properties</include>
                    <include>logback-spring.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

</project>

在pom文件中添加spring-cloud-starter-gateway依赖即可。

yml配置

server:
  port: 8080
spring:
  cloud:
    gateway:
      routes:
        - id: myCloud_route
          uri: http://127.0.0.1:8701/myCloud
          predicates:
            - Path=/myCloud/**

我们的路由开发端口为8080上下文为/

这里我们配置了一个路径断言Predicate所有/myCloud上下文的请求都路由到http://127.0.0.1:8701/myCloud。路由到的地址是我们前文中的Provider 8701。

启动类

package com.yyoo.cloud.gateway;

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

@SpringBootApplication(scanBasePackages = {"com.yyoo"})
public class Application {

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

}

我们的启动类没有任何的区别。

访问验证

访问 http://127.0.0.1:8080/myCloud/conf/getCommonConf 返回结果如下

CommonConf(name=没事儿写两篇, age=12, desc=Spring Cloud 学习)8701

我们通过Gateway网关的接口访问到了我们的Provider 8701的接口。

网关的关键组件

  1. 路由route路由是网关的基础构件其内部包括id路由的名称、uri目标url、predicates断言集合、filters过滤器集合
  2. 断言predicate对请求进行断言如果断言为真则匹配该路由访问该路由配置的uri。
  3. 过滤器filter通过过滤器可以在发送下游请求之前或之后修改请求和响应。

路由断言工厂

注以下均为官网示例

断言指定时间之后

spring:
  cloud:
    gateway:
      routes:
      - id: after_route
        uri: https://example.org
        predicates:
        - After=2017-01-20T17:42:47.789-07:00[America/Denver]

该路由匹配 2017 年 1 月 20 日 17:42 之后提出的任何请求。(注意时区)此配置是ZonedDateTime对象

断言指定时间之前

spring:
  cloud:
    gateway:
      routes:
      - id: before_route
        uri: https://example.org
        predicates:
        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]

断言在指定时间之间

spring:
  cloud:
    gateway:
      routes:
      - id: between_route
        uri: https://example.org
        predicates:
        - Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]

Cookie断言

spring:
  cloud:
    gateway:
      routes:
      - id: cookie_route
        uri: https://example.org
        predicates:
        - Cookie=chocolate, ch.p

此路由匹配具有名为 chocolate的cookie并且其值与 ch.p 正则表达式相匹配的 cookie 的请求。

请求头断言

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: https://example.org
        predicates:
        - Header=X-Request-Id, \d+

意为请求头为X-Request-Id其值满足正则表达式\d+多个请求头添加多个predicate即可。

路径断言

spring:
  cloud:
    gateway:
      routes:
      - id: path_route
        uri: https://example.org
        predicates:
        - Path=/red/{segment},/blue/{segment}

{segment}为占位符断言工厂会将对应的值通过ServerWebExchange.setAttributes()放在ServerWebExchange其key值为ServerWebExchangeUtils.URI_TEMPLATE_VARIABLES_ATTRIBUTE。之后可以在GatewayFilter中使用

Map<String, String> uriVariables = ServerWebExchangeUtils.getPathPredicateVariables(exchange);
String segment = uriVariables.get("segment");

其他断言工厂

其他断言工厂请查看官网网关路由断言工厂

网关过滤器工厂

添加请求头

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue

使用URI扩展变量

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        predicates:
        - Path=/red/{segment}
        filters:
        - AddRequestHeader=X-Request-Red, Blue-{segment}

与之对应的还有添加请求参数添加响应头删除请求参数、请求头响应头等网关过滤器。

路径重写过滤器

spring:
  cloud:
    gateway:
      routes:
      - id: rewritepath_route
        uri: https://example.org
        predicates:
        - Path=/red/**
        filters:
        - RewritePath=/red/?(?<segment>.*), /$\{segment}

对于请求路径/red/blue会将路径设置为/blue发出下游请求之前的路径。

由于 YAML 规范$ 被替换为。$\

此操作相当于把当前的请求uri中的/red给去掉了这在要访问的uri上下文和我们网关访问的uri的上下午不一致时非常有用。

重试过滤器

spring:
  cloud:
    gateway:
      httpclient:
        connect-timeout: 1000 # 连接超时
        response-timeout: 5s # 响应超时响应超时请合理设置太短会造成多次重试
      routes:
        - id: myCloud_route
          uri: http://127.0.0.1:8701/myCloud
          predicates:
            - Path=/myCloud/**
          filters:
            - AddRequestHeader=X-token, blue
            - name: Retry
              args:
                retries: 3
                statuses: BAD_GATEWAY
                methods: GET,POST
                backoff:
                  firstBackoff: 10ms
                  maxBackoff: 50ms
                  factor: 2
                  basedOnPreviousValue: false

示例设置了连接超时和响应超时的时间设置

注特别是响应超时的时候其实请求是实际发送了的只是服务端响应时间太长导致响应超时这就要确保我们请求的接口幂等性否则会有重复数据出现。

重试参数说明

  • retries应尝试的重试次数。
  • statuses应该重试的HTTP状态码org.springframework.http.HttpStatus。
  • methods应该重试的 HTTP 方法org.springframework.http.HttpMethod。
  • series要重试的一系列状态码org.springframework.http.HttpStatus.Series。
  • exceptions应重试的抛出异常列表。
  • backoff重试退避指数。在退避间隔 firstBackoff * (factor ^ n) 后执行重试其中n是迭代。如果已配置 maxBackoff则最大退避限制为 maxBackoff. 如果basedOnPreviousValue为真则使用 prevBackoff * factor 计算退避。

重试参数默认值

  • retries: 3
  • series5XX
  • methods: GET
  • exceptions:IOException和TimeoutException
  • backoffnull 禁用

其他过滤器工厂

其他过滤器工厂请查看官网网关路由过滤器工厂

阿里云国内75折 回扣 微信号：monov8
阿里云国际，腾讯云国际，低至75折。AWS 93折 免费开户实名账号 代冲值 优惠多多 微信号：monov8 飞机：@monov6
标签: Spring
返回列表

上一篇：Webshell（网页后门）_webshell后门

下一篇：Python(12)--元组

“Spring Cloud Gateway 入门示例” 的相关文章

Spring Cloud:微服务基础知识_spring cloud 微服务协议1年前 (2023-02-02)
springboot~WebMvcConfigurer详解1年前 (2023-02-02)
Spring配置详解，Spring配置元信息详解，Spring配置大全及源码分析1年前 (2023-02-02)
停车系统源码-基于springboot+uniapp开源项目1年前 (2023-02-02)
Spring入门-IOC/DI相关配置与使用(1)1年前 (2023-02-02)
网盘系统|基于SpringBoot的网盘系统的设计与实现1年前 (2023-02-02)
循环依赖报错.BeanCurrentlyInCreationException(Spring 不是解决了循环依赖嘛？)1年前 (2023-02-02)
java+springboot笔记20230021年前 (2023-02-02)
云收藏系统|基于Springboot实现云收藏系统1年前 (2023-02-02)
SpringBoot+2次MD5登录密码加密+MyBatisPlus+Thymeleaf+Bootstrap简单实现登录功能，一文轻松搞定！1年前 (2023-02-02)

阿里云国际版