Gateway服务网关

Posted 2023-04-08 ?Suki

Gateway服务网关

• 3.Gateway服务网关
• • 3.1.为什么需要网关
  • 3.2.gateway快速入门
  • • 1）创建gateway服务，引入依赖
    • 2）编写启动类
    • 3）编写基础配置和路由规则
    • 4）重启测试
    • 5）网关路由的流程图
  • 3.3.断言工厂
  • 3.4.过滤器工厂
  • • 3.4.1.路由过滤器的种类
    • 3.4.2.请求头过滤器
    • 3.4.3.默认过滤器
    • 3.4.4.总结
  • 3.5.全局过滤器
  • • 3.5.1.全局过滤器作用
    • 3.5.2.自定义全局过滤器
    • 3.5.3.过滤器执行顺序
  • 3.6.跨域问题
  • • 3.6.1.什么是跨域问题
    • 3.6.2.模拟跨域问题
    • 3.6.3.解决跨域问题

---

3.Gateway服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

---

3.1.为什么需要网关

Gateway网关是我们服务的守门神，所有微服务的统一入口。

网关的核心功能特性：

• 请求路由
• 权限控制
• 限流

架构图：

权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

在SpringCloud中网关的实现包括两种：

• gateway
• zuul

Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

---

3.2.gateway快速入门

下面，我们就演示下网关的基本路由功能。基本步骤如下：

1. 创建SpringBoot工程gateway，引入网关依赖
2. 编写启动类
3. 编写基础配置和路由规则
4. 启动网关服务进行测试

---

1）创建gateway服务，引入依赖

创建服务：

引入依赖：

<!--网关-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

---

2）编写启动类

package cn.itcast.gateway;

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

@SpringBootApplication
public class GatewayApplication 

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

---

3）编写基础配置和路由规则

创建application.yml文件，内容如下：

server:
  port: 10010 # 网关端口
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos地址
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id，自定义，只要唯一即可
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

本例中，我们将 /user/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

---

4）重启测试

重启网关，访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://userservice/user/1，得到了结果：

---

5）网关路由的流程图

整个访问的流程如下：

总结：

网关搭建步骤：

1. 创建项目，引入nacos服务发现和gateway依赖

2. 配置application.yml，包括服务基本信息、nacos地址、路由

路由配置包括：

1. 路由id：路由的唯一标示

2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

3. 路由断言（predicates）：判断路由的规则，

4. 路由过滤器（filters）：对请求或响应做处理

接下来，就重点来学习路由断言和路由过滤器的详细知识

---

3.3.断言工厂

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件

例如Path=/user/**是按照路径匹配，这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

名称	说明	示例
After	是某个时间点后的请求	- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before	是某个时间点之前的请求	- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between	是某两个时间点之前的请求	- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie	请求必须包含某些cookie	- Cookie=chocolate, ch.p
Header	请求必须包含某些header	- Header=X-Request-Id, \\d+
Host	请求必须是访问某个host（域名）	- Host=.somehost.org,.anotherhost.org
Method	请求方式必须是指定方式	- Method=GET,POST
Path	请求路径必须符合指定规则	- Path=/red/segment,/blue/**
Query	请求参数必须包含指定参数	- Query=name, Jack或者- Query=name
RemoteAddr	请求者的ip必须是指定范围	- RemoteAddr=192.168.1.1/24
Weight	权重处理

我们只需要掌握Path这种路由工程就可以了。

---

3.4.过滤器工厂

GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：

---

3.4.1.路由过滤器的种类

Spring提供了31种不同的路由过滤器工厂。例如：

名称	说明
AddRequestHeader	给当前请求添加一个请求头
RemoveRequestHeader	移除请求中的一个请求头
AddResponseHeader	给响应结果中添加一个响应头
RemoveResponseHeader	从响应结果中移除有一个响应头
RequestRateLimiter	限制请求的流量

---

3.4.2.请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!

只需要修改gateway服务的application.yml文件，添加路由过滤即可：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。

---

3.4.3.默认过滤器

如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

---

3.4.4.总结

过滤器的作用是什么？

① 对路由的请求或响应做加工处理，比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么？

① 对所有路由都生效的过滤器

---

3.5.全局过滤器

上一节学习的过滤器，网关提供了31种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。

3.5.1.全局过滤器作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

public interface GlobalFilter 
    /**
     *  处理当前请求，有必要的话通过@link GatewayFilterChain将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return @code Mono<Void> 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);

在filter中编写自定义逻辑，可以实现下列功能：

• 登录状态判断
• 权限校验
• 请求限流等

---

3.5.2.自定义全局过滤器

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

• 参数中是否有authorization，

• authorization参数值是否为admin

如果同时满足则放行，否则拦截

实现：

在gateway中定义一个过滤器：

package cn.itcast.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter 
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) 
        // 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.获取authorization参数
        String auth = params.getFirst("authorization");
        // 3.校验
        if ("admin".equals(auth)) 
            // 放行
            return chain.filter(exchange);
        
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    

---

3.5.3.过滤器执行顺序

请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器：

排序的规则是什么呢？

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

详细内容，可以查看源码：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链

---

3.6.跨域问题

---

3.6.1.什么是跨域问题

跨域：域名不一致就是跨域，主要包括：

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

• 域名相同，端口不同：localhost:8080和localhost8081

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CORS，这个以前应该学习过，这里不再赘述了。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html

---

3.6.2.模拟跨域问题

找到课前资料的页面文件：

放入tomcat或者nginx这样的web服务器中，启动并访问。

可以在浏览器控制台看到下面的错误：

从localhost:8090访问localhost:10010，端口不同，显然是跨域的请求。

---

3.6.3.解决跨域问题

在gateway服务的application.yml文件中，添加下面的配置：

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

---

学习笔记 from 黑马程序员

By – Suki 2023/4/7

SpringCloud --- 服务网关 (Gateway)

服务网关

• 🔺 Gateway 新一代网关
• • 一、概述简介
  • • (1) 官网
    • • ① 上一代zuul 1.x
      • ② 当前gateway
    • (2) 是什么
    • • ① 概述
      • ② 一句话
    • (3) 能干嘛
    • (4) 微服务架构中网关在哪里
    • (5) 有Zuull了怎么又出来gateway
    • • ① 我们为什么选择Gateway?
      • ② Zuul1.x模型
      • ③ Gateway模型
  • 二、三大核心概念
  • • (1) Route(路由)
    • (2) Predicate(断言)
    • (3) Filter(过滤)
    • (4) 总结
  • 三、Gateway工作流程
  • • (1) 官网总结
    • (2) 核心逻辑
  • 四、入门配置
  • • (1) 新建模块 cloud-gateway-gateway9527
    • (2) 配置 pom.xml
    • (3) 配置 application.yml
    • (4) 创建主启动类
    • (5) 9527网关如何做路由映射呢???
    • (6) YML新增网关配置
    • (7) 测试
    • (8) YML配置说明
  • 五、通过服务名实现动态
  • • (1) 启动
    • (2) 添加依赖到 pom.xml
    • (3) 添加配置到 application.yml
    • (4) 测试：
  • 六、Predicate 断言
  • • (1) 是什么
    • (2) Route Predicate Factories 是什么
    • (3) 常用的Route Predicate
    • (4) 尝试常用断言 --- The After Route Predicate Factory
    • (5) 尝试常用断言 --- The Cookie Route Predicate Factory
    • (6) 小总结
  • 七、Filter的使用
  • • (1) 是什么
    • (2) Spring Cloud Gateway的filter
    • • ① 生命周期,Only Two
      • ② 种类,Only
    • (3) 常用的GatewayFilter (不重要)
    • (4) 自定义过滤器 (★)
    • • ① 两个主要接口介绍
      • ② 能干嘛
      • ③ 案例代码
      • ④ 测试

---

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

1. netflix不太靠谱,zuul2.0一直跳票,迟迟不发布

2. SpringCloud Gateway具有如下特性

3. 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中把之前配置的断言等删除