SpringCloud --- 服务网关 (Gateway)

Posted 2022-11-28 黑桃️

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了SpringCloud --- 服务网关 (Gateway)相关的知识，希望对你有一定的参考价值。

服务网关

🔺 Gateway 新一代网关

🔺 Gateway 新一代网关

一、概述简介

(1) 官网

① 上一代zuul 1.x

https://github.com/Netflix/zuul/wiki

② 当前gateway

https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/

(2) 是什么

① 概述

② 一句话

SpringCloud Gateway使用的是Webflux中的reactor-netty响应式编程组件,底层使用了Netty通讯框架

(3) 能干嘛

反向代理
鉴权
流量控制
熔断
日志监控

(4) 微服务架构中网关在哪里

(5) 有Zuull了怎么又出来gateway

① 我们为什么选择Gateway?

netflix不太靠谱,zuul2.0一直跳票,迟迟不发布
SpringCloud Gateway具有如下特性
SpringCloud Gateway与Zuul的区别

② Zuul1.x模型

③ Gateway模型

WebFlux是什么

https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html#spring-webflux

说明

二、三大核心概念

(1) Route(路由)

路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如断言为true则匹配该路由

(2) Predicate(断言)

参考的是Java8的java.util.function.Predicate
开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由

(3) Filter(过滤)

指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改.

(4) 总结

三、Gateway工作流程

(1) 官网总结

(2) 核心逻辑

路由转发 + 执行过滤器链

四、入门配置

(1) 新建模块 cloud-gateway-gateway9527

(2) 配置 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">
    <parent>
        <artifactId>cloud2020</artifactId>
        <groupId>com.atguigu.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-gateway-gateway9527</artifactId>

    <dependencies>
        <!--gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--eureka-client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>$project.version</version>
        </dependency>
        <!--一般基础配置类-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

(3) 配置 application.yml

server:
  port: 9527

spring:
  application:
    name: cloud-gateway

eureka:
  instance:
    hostname: cloud-gateway-service
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka

(4) 创建主启动类

@SpringBootApplication
@EnableDiscoveryClient
public class GateWayMain9527 
    public static void main(String[] args) 
        SpringApplication.run(GateWayMain9527.class, args);

(5) 9527网关如何做路由映射呢???

cloud-provider-payment8001看看controller的访问地址

get：http://localhost:8001/payment/get/1
lb：http://localhost:8001/payment/lb

我们目前不想暴露8001端口,希望在8001外面套一层9527

(6) YML新增网关配置

cloud:
   gateway:
     discovery:
       locator:
         enabled: true # 开启从注册中心动态创建路由的功能，利用微服务名称j进行路由
     routes:
       - id: payment_route # 路由的id,没有规定规则但要求唯一,建议配合服务名
         #匹配后提供服务的路由地址
         uri: http://localhost:8001
         predicates:
           - Path=/payment/get/** # 断言，路径相匹配的进行路由
       - id: payment_route2
         uri: http://localhost:8001
         predicates:
           Path=/payment/lb/** #断言,路径相匹配的进行路由

(7) 测试

启动 7001，9527，8001(如果eureka配的是集群，还要启动7002等)

(8) YML配置说明

Gateway网关路由有两种配置方式:

1 在配置文件yaml中配置 (见前面的步骤)
2 代码中注入RouteLocator的Bean

官网样例：

自己写一个通过网关9527访问国内新闻网址的配置

百度国内新闻网址 - http://news.baidu.com/guonei

在 9527 中创建 GateWayConfig

@Configuration
public class GateWayConfig 

    // 作用同application.xml中的routes配置
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) 

        RouteLocatorBuilder.Builder routes = builder.routes();

        routes.route("path_route_atguigu", r -> r.path("/guonei").uri("http://news.baidu.com/guonei")).build();

        return routes.build();

五、通过服务名实现动态

默认情况下Gatway会根据注册中心注册的服务列表, 以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能

(1) 启动

7001，7002，8001，8002

(2) 添加依赖到 pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

(3) 添加配置到 application.yml

(4) 测试：

六、Predicate 断言

(1) 是什么

启动 9527 时可以看到

(2) Route Predicate Factories 是什么

(3) 常用的Route Predicate

常用的Route Predicate

The After Route Predicate Factory
The Before Route Predicate Factory
The Between Route Predicate Factory
The Cookie Route Predicate Factory
The Header Route Predicate Factory
The Host Route Predicate Factory
The Method Route Predicate Factory
The Path Route Predicate Factory
The Query Route Predicate Factory
The RemoteAddr Route Predicate Factory
The weight Route Predicate Factory

(4) 尝试常用断言 — The After Route Predicate Factory

(5) 尝试常用断言 — The Cookie Route Predicate Factory

(6) 小总结

说白了,Predicate就是为了实现一组匹配规则, 让请求过来找到对应的Route进行处理

七、Filter的使用

(1) 是什么

(2) Spring Cloud Gateway的filter

① 生命周期,Only Two

pre
post

② 种类,Only

GatewayFilter 链接
GlobalFilter 链接

(3) 常用的GatewayFilter (不重要)

AddRequestParameter

(4) 自定义过滤器 (★)

自定义全局GlobalFilter

① 两个主要接口介绍

implements GlobalFilter, Ordered

② 能干嘛

全局日志记录
统一网关鉴权
…

③ 案例代码

@Component
@Slf4j
public class MyLogGatewayFilter implements GlobalFilter, Ordered 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) 

        log.info("---------come in global filter: ", new Date());

        ServerHttpRequest request = exchange.getRequest();

        String uname = request.getQueryParams().getFirst("uname");

        if (uname == null) 
            log.info("用户名为null，非法用户");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        

        // 放行
        return chain.filter(exchange);
    

    // 过滤器加载的顺序 越小,优先级别越高
    @Override
    public int getOrder() 
        return 0;

④ 测试

现在yaml中把之前配置的断言等删除

以上是关于SpringCloud --- 服务网关 (Gateway)的主要内容，如果未能解决你的问题，请参考以下文章

搭建SpringCloud微服务框架：SpringCloud-Gateway 服务网关处理

springcloud学习之路: springcloud集成Zuul网关

SpringCloud服务网关Zuul分析①分发

SpringCloud：服务网关zuul-API网关

SpringCloud之网关服务(gateway)