目录

今日说码

点滴记录中国代码进程

X

Spring Cloud Alibaba学习笔记(九):路由网关(Gateway)

目录:Spring Cloud Alibaba学习笔记(总) - 今日说码 (96xl.top)

上一篇:Spring Cloud Alibaba学习笔记(八):熔断器仪表盘监控(Sentinel控制台) - 今日说码 (96xl.top)

下一篇:Spring Cloud Alibaba学习笔记(十):网关全局过滤 - 今日说码 (96xl.top)


概述

Spring Cloud Gateway 是 Spring 官方基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等技术开发的网关,Spring Cloud Gateway 旨在为微服务架构提供一种简单而有效的统一的 API 路由管理方式。Spring Cloud Gateway 作为 Spring Cloud 生态系中的网关,目标是替代 Netflix ZUUL ,其不仅提供统一的路由方式,并且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控/埋点,和限流等。

image.png

功能特征

  • 基于 Spring Framework 5,Project Reactor 和 Spring Boot 2.0
  • 动态路由
  • Predicates 和 Filters 作用于特定路由
  • 集成 Hystrix 断路器
  • 集成 Spring Cloud DiscoveryClient
  • 易于编写的 Predicates 和 Filters
  • 限流
  • 路径重写

工程流程

客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由,将其发送到 Gateway Web Handler。Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。

image.png

过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(pre)或之后(post)执行业务逻辑。

创建子模块

创建一个名称为 spring-cloud-alibaba-gateway的子模块,继承 spring-cloud-alibaba-dependencies模块,创建过程参考Spring Cloud Alibaba学习笔记(二):创建依赖管理项目 - 今日说码 (96xl.top)

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>

    <parent>
        <groupId>com.xl</groupId>
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>
        <version>1.0.0</version>
        <relativePath>../spring-cloud-alibaba-dependencies/pom.xml</relativePath>
    </parent>

    <artifactId>spring-cloud-alibaba-gateway</artifactId>
    <name>spring-cloud-alibaba-gateway</name>
    <packaging>jar</packaging>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- Spring Boot Begin -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot End -->

        <!-- Spring Cloud Begin -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!-- Spring Cloud End -->

        <!-- Commons Begin -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
        </dependency>
        <!-- Commons End -->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.xl.gateway.GatewayApplication</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>
  • 主要增加了org.springframework.cloud:spring-cloud-starter-gateway 依赖。
  • 由于Spring Cloud Gateway的内部是通过 Netty + WebFlux 实现的,WebFlux实现和SpringMVC配置依赖冲突,所以代码中不能引入org.springframework.boot:spring-boot-starter-web 依赖,如果引入了启动会出现Spring MVC found on classpath, which is incompatible with Spring Cloud Gateway. 报错。
  • 不引入org.springframework.boot:spring-boot-starter-web 依赖项目启动时会出现找不到javax.servlet.ServletException的类文件 报错,所以需要额外引入javax.servlet:javax.servlet-api 依赖。

创建代码目录

创建过程参考Spring Cloud Alibaba学习笔记(四):创建服务提供者 - 今日说码 (96xl.top)

创建启动类

创建过程参考Spring Cloud Alibaba学习笔记(四):创建服务提供者 - 今日说码 (96xl.top)

Application文件内容如下:

package com.xl.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class GatewayApplication extends SpringBootServletInitializer {

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

创建配置文件

创建过程参考Spring Cloud Alibaba学习笔记(四):创建服务提供者 - 今日说码 (96xl.top)

yml文件内容如下:

spring:
  application:
    #当前的服务名称
    name: spring-gateway
  cloud:
    nacos:
      discovery:
        #Nacos Server启动监听的ip地址和端口
        server-addr: 127.0.0.1:8848
    sentinel:
      transport:
        port: 8721
        dashboard: localhost:8080
    #路由网关配置
    gateway:
      #设置与服务注册发现组件结合,这样可以采用服务名的路由策略
      discovery:
        locator:
          enabled: true
      #配置路由规则
      routes:
        #采用自定义路由ID(有固定用法,不同的id有不同的功能,详见:https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html#gateway-route-filters)
        - id: NACOS-CONSUMER
          #采用LoadBalanceClient方式请求,以lb://开头,后面的是注册在Nacos上的服务名
          uri: lb://nacos-consumer
          #Predicate翻译过来是“谓词”的意思,必须,主要作用是匹配用户的请求,有很多种用法
          predicates:
            # Method方法谓词,这里是匹配GET和POST请求
            - Method=GET,POST
        - id: NACOS-CONSUMER-FEIGN
          uri: lb://nacos-consumer-feign
          predicates:
            - Method=GET,POST

server:
  port: 9093

management:
  endpoints:
    web:
      exposure:
        include: "*"

feign:
  sentinel:
    enabled: true

项目结构

项目最终目录结构如下:

image.png

测试路由网关

右键启动类,选择Debug启动,等待出现 Started GatewayApplication in 8.461 seconds (JVM running for 9.565) 启动成功的提示后,访问http://localhost:9093/nacos-consumer/test/app/name,会出现以下响应:

image.png

访问http://localhost:9093/nacos-consumer-feign/test/hi,会出现以下响应:

image.png

我访问的地址是刚才创建的路由网关项目,但是请求能够正确的转发到之前创建的服务消费者项目上,并且出现正确响应,说明Gateway路由功能配置成功。而且由此可以看出,请求路由网关的路径格式为:http://路由网关IP:路由网关Port/服务名/接口地址,这里的服务名就是在 application.yml 配置文件中配置的。


目录:Spring Cloud Alibaba学习笔记(总) - 今日说码 (96xl.top)

上一篇:Spring Cloud Alibaba学习笔记(八):熔断器仪表盘监控(Sentinel控制台) - 今日说码 (96xl.top)

下一篇:Spring Cloud Alibaba学习笔记(十):网关全局过滤 - 今日说码 (96xl.top)


标题:Spring Cloud Alibaba学习笔记(九):路由网关(Gateway)
作者:96XL
地址:https://solo.96xl.top/articles/2022/02/11/1644571253848.html