统一网关Gateway介绍和使用

13-Gateway网关-快速入门_哔哩哔哩_bilibili学习笔记

目录

一、介绍

 二、搭建网关服务步骤

 三、路由断言工厂predicate factory

 四、过滤器工厂

1、什么是请求头和响应头？

2、路由的过滤器配置 

3、路由过滤器的种类

五、全局过滤器 

 实现步骤

 六、执行顺序​编辑

七、跨域问题处理

---

一、介绍

网关主要是起到对微服务的保护功能 

网关技术的实现

 二、搭建网关服务步骤

1、创建gateway module，引入SpringCloudGateway依赖和nacos的服务发现依赖

<!--网关-->
<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>
<!--添加loadbalanncer依赖, 添加spring-cloud的依赖-->
<dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

2、创建启动类

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、编写基础配置和路由规则

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就是load balance负载均衡，后面跟服务名称
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

4、测试，访问不成功的检查一下gateway和service是否不在同一个命名空间里

 三、路由断言工厂predicate factory

官方文档：Spring Cloud Gateway

 四、过滤器工厂

介绍路由过滤器，首先先介绍请求头和响应头，以下引用自什么是请求头？常见的请求头有哪些？-CSDN博客

关于请求头、请求体、响应头和响应体的介绍-CSDN博客

1、什么是请求头和响应头？

请求头（Request Headers）是在HTTP协议中用于传递关于请求的额外信息的部分。它包含了客户端（通常是浏览器或应用程序）与服务器之间进行通信所需的元数据。

请求头的作用有以下几个方面：

传递请求的附加信息：请求头可以携带一些客户端相关的信息，如用户代理（User-Agent）、接受的内容类型（Accept）、身份验证凭证（Authorization）等。这些信息可以帮助服务器更好地理解和处理请求。

控制缓存行为：通过请求头中的Cache-Control字段，客户端可以告知服务器如何处理响应的缓存，包括是否使用缓存、缓存的有效期等。

进行身份验证：请求头中的Authorization字段常用于传递身份验证凭证，如基本认证（Basic Authentication）或令牌（Token）。服务器可以根据这些凭证对请求进行身份验证，以确定是否允许访问受保护的资源。

控制请求体的格式：Content-Type字段指定了请求体中数据的格式类型，如JSON、表单数据等。服务器可以根据Content-Type来正确解析请求体中的数据。

提供跳转来源信息：Referer字段指示了当前请求是从哪个URL页面发起的，可以帮助服务器识别请求的来源。

通过请求头，客户端可以向服务器提供更多的信息，以便服务器能够根据这些信息做出相应的处理和响应。同时，服务器也可以使用请求头来控制和管理请求的行为，确保通信的顺利进行。

响应头（Response Header）是在HTTP协议中用于描述服务器响应的元数据。它是服务器在响应客户端请求时发送给客户端的一部分响应信息,包含了服务器的相关配置和响应内容的描述。响应头通常包含以下几个部分：

1.状态码（Status Code）：表示服务器对请求的处理结果的状态码,如200表示成功、404表示未找到资源等。

2.状态消息（Status Message）：对状态码的文本描述,如200的状态消息是"OK"。

3.协议版本（Protocol Version）：指定了服务器使用的HTTP协议版本。

4.Content-Type（内容类型）：指定了服务器返回的响应内容的类型。

5.Content-Length（内容长度）：指定了响应内容的长度。

6.ETag（实体标记）：用于实体的缓存控制,客户端可以通过该标记判断资源是否改变。

7.Location（重定向地址）：用于重定向响应,客户端可以根据该字段的值重新发送请求。

8.Set-Cookie（设置Cookie）：用于在响应中设置Cookie,服务器可以通过该字段在客户端保存会话信息。

响应头的作用是让服务器能够向客户端传递一些额外的信息,以控制或者说明响应的方式、内容和缓存等。客户端根据响应头中的信息进行相应的处理,如解析响应内容、处理重定向、保存Cookie等。响应头的具体内容可以根据实际需求进行定制和扩展。

2、路由的过滤器配置 

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

3、路由过滤器的种类

相关资料：

网关 Spring Cloud Gateway 内置过滤器工厂(超级全30种)_application.properties配置gateway内置过滤器工厂-CSDN博客

以第一个为例，eg：

修改gateway服务的application.yml文件生效，当前filters写在userservice路由下，因此仅仅对访问userservice的请求有效

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

 写到default下，对所有路由都生效

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

五、全局过滤器 

 实现步骤：

实现GloabalFilter接口

添加@Order注解或实现Ordered接口，数字越小优先级越大

编写处理逻辑

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

//@Order(-1) //越小优先级越高
@Component
public class AuthorizeFilter implements GlobalFilter , Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain){
        //1、获取请求参数
        ServerHttpRequest request= exchange.getRequest();
        MultiValueMap<String,String> params=request.getQueryParams();
        //2、获取参数中的authorization
        String auth=params.getFirst("authorization");
        //3、判断参数值是否等于admin
        //3.1、是，放行
        if("admin".equals(auth)){
            return chain.filter(exchange);
        }
        //3.2 否，拦截
        //3.2.1 设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        //3.2.2 拦截请求
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

浏览器测试效果，此时只有后面加上了authorization=admin才可以正常访问 

 六、执行顺序

七、跨域问题处理

Cross-origin resource sharing (CORS)

在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 # 这次跨域检测的有效期（s）