Spring Cloud Gateway构建微服务网关

网关是微服务中不可或缺的部分。使用网关后,网关统一向外部系统提供REST API。在Spring Cloud中,使用Zuul、Spring Cloud Gateway等作为API GateWay来实现动态路由、监控、回退、安全等功能。
Spring Cloud Gateway 是Spring Cloud生态系统中的网关,是基于Spring 5.0、Spring Boot 2.0和Project Reactor 等技术开发的,旨在为微服务提供简单有效的、统一的API路由管理方式,并为微服务提供安全、监控、指标和弹性功能。
注意: Spring Cloud Gateway 用 “Netty + Webflux”实现, 不要加入Web依赖,否则会报错。需要加入Webflux依赖。

Spring Cloud Gateway 特点

  • 基于Spring 5.0、Spring Boot 2.0构建和Project Reactor 等技术开发
  • 能够匹配任何请求属性的路由
  • 易于编写谓词(Predicate)和过滤器(Filters)
  • 其Predicates和Filters可作用与特定路由
  • 支持路径重写
  • 支持动态路由
  • 集成了Hystrix断路器
  • 集成了Spring Cloud DiscoveryClient
  • 支持限流

Spring Cloud Gateway工作流程

Spring Cloud Gateway工作流程图

工作流程为:
(1)客户端向Spring Cloud Gateway发送请求。
(2)DispatcheHandle接收用户请求
(3)RoutePredicateHandleMapping进行路由匹配
(4)如果网关处理程序发现请求与路由匹配,则将请求发送至FilteringWebHandle(即网关处理程序)。如果发现请求与路由不匹配,则将请求返回给DispatcherHandle处理。
(5)FilteringWebHandle通过特定过滤器发送请求,先执行所有“PRE”逻辑,然后进行代理请求,最后执行“POST”逻辑。
(6)FilteringWebHandle将请求转发到具体的服务中。
(7)FilteringWebHandle将处理结果返回给用户

快速入门

  • Spring Boot版本 2.1.7
  • Consul版本1.8.4
  • Spring Cloud版本Greenwich.SR2

配置路由规则方式

Spring Cloud Gateway网关路由有两种默认配置方式。

  • Java API方式配置
  • 在配置文件中配置
    实现案例如下:

准备工作

服务端配置,经Gateway把请求路由转发到该服务上
新建新的子模块 spring-cloud-service-consumer

添加依赖
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-consul-discovery</artifactId>
</dependency>

<!-- web依赖,提供服务-->
dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
配置文件添加
spring:
  application:
    name: service-consumer
  cloud:
    consul:
      host: localhost
      port: 8500
      discovery:
        register: false
        service-name: service-consumer
server:
  port: 8088
定义Controller,发布HTTP接口
@RestController
@RequestMapping("/user")
public class UserController {

    private static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    @GetMapping(value = "/info")
    public String info() {
        LocalDateTime localDateTime = LocalDateTime.now();
        String dateStr = DATE_TIME_FORMATTER.format(localDateTime);
        return "User info: {\"name\":\"zsp\", \"age\":30, \"date\": " + dateStr + "}";
    }
}

实现过程

1. 添加依赖
<?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>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ping</groupId>
    <artifactId>cloud-gateway-consul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>cloud-gateway-consul</name>
    <description>cloud-gateway基于consul</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.SR2</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>
        </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>
2.1 方式一: 在配置文件中配置路由
server:
  port: 8220
spring:
  cloud:
    gateway:
      routes:
        - id: user
          uri: http://localhost:8088
          predicates:
            - Path=/user/**
logging:
  level:
    ROOT: debug
测试路由效果

启动项目,访问http://localhost:8020/user/info, 可以看到控制台信息

路由效果图1

当请求匹配了路由ID为“user”的路由时,匹配的路由方式为“Paths”。 Spring Cloud Gateway会把请求转发到地址http://localhost:8088/user/info.

2.2 方式二: 在配置文件中配置路由
@SpringBootApplication
public class CloudGatewayConsulApplication {
    public static void main(String[] args) {
        SpringApplication.run(CloudGatewayConsulApplication.class, args);
    }

    @Bean
    public RouteLocator routeLocator(RouteLocatorBuilder builder) {
        return builder
                .routes()
                .route("user", r -> r.path("/user/info")
                        .uri("http://localhost:8088/user/info")).build();
    }
}
测试路由效果

路由效果图2

当请求匹配了路由ID为“user”的路由时,匹配的路由方式为“Paths”。 Spring Cloud Gateway会把请求转发到地址http://localhost:8088/user/info

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,904评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,581评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,527评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,463评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,546评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,572评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,582评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,330评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,776评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,087评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,257评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,923评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,571评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,192评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,436评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,145评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352