【SpringCloud】Gateway微服务网关（gateway快速⼊⻔ 断⾔⼯⼚ 过滤器⼯⼚ 浏览器同源策略）

时间：2024-10-22 07:07:25

Gateway微服务网关

  • Gateway服务网关
    • 什么是Gateway网关？
      • 为什么需要网关？
    • Gateway快速入门
      • 创建gateway服务，引入依赖
      • 编写配置文件yaml和路由规则
      • 重启测试
    • 断言工厂
    • 过滤器工厂
      • 路由过滤器的种类
      • 请求头过滤器
      • 默认过滤器
      • 全局过滤器【可写自定义逻辑】
      • 自定义全局过滤器【自定义Auth认证】
      • 过滤器执行顺序
          • 过滤器执⾏顺序
          • 测试优先级
    • 浏览器同源策略
    • 跨域问题解决方案
  • 前后端设计：
      • 单体架构
      • 微服务架构

Gateway服务网关

什么是Gateway网关？

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

为什么需要网关？

Gateway⽹关是我们服务的守⻔神，所有微服务的统⼀⼊⼝。

⽹关的核⼼功能特性：

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

整体架构为：

**权限控制：**⽹关作为微服务⼊⼝，需要校验⽤户是否有请求资格，如果没有则进⾏拦截。

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

**限流：**当请求流量过⾼时，在⽹关中按照下流的微服务能够接受的速度来放⾏请求，避免服务压⼒过⼤。

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

  • Gateway【基于Spring5中提供的 WebFlux，属于响应式编程的实现，具备更好的性能】
  • zuul【基于Servlet的实现，是属于阻塞式编程】

Gateway快速入门

基本步骤如下：

  1. 创建SpringBoot⼯程gateway，引⼊⽹关依赖
    2.编写基础配置和路由规则
  1. 启动⽹关服务进⾏测试

创建gateway服务，引入依赖

新增模块gateway

导入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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>springcloud_alibaba</artifactId>
        <groupId>com.stringzhua</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>api-gateway</artifactId>

    <dependencies>
        <!--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>
    </dependencies>

</project>

编写配置文件yaml和路由规则

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      discovery:
        locator:
          enabled: true # 让gateway可以发现nacos中的微服务
      routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
        - id: product_route # 当前路由的标识, 要求唯一
          uri: lb://service-product # 请求要转发到的地址
          order: 1 # 路由的优先级,数字越小级别越高
          predicates: # 断言(就是路由转发要满足的条件)
            - Path=/product-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发
          filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
            - StripPrefix=1 # 转发之前去掉1层路径
        - id: order_route # 当前路由的标识, 要求唯一
          uri: lb://service-order # 请求要转发到的地址
          order: 1 # 路由的优先级,数字越小级别越高
          predicates: # 断言(就是路由转发要满足的条件)
            - Path=/order-serv/** # 当请求路径满足Path指定的规则时,才进行路由转发
          filters: # 过滤器,请求在传递过程中可以通过过滤器对其进行一定的修改
            - StripPrefix=1 # 转发之前去掉1层路径

重启测试

这里我们使用了nacos的lb轮询策略，而不是把服务的端口号写死：

总结

网关搭建步骤：

  • 1.创建项目，引入nacos服务发现和gateway依赖
  • 2.配置application.yaml，包括服务基本信息、nacos地址、路由

路由配置包括：

  • 1.路由id：路由的唯一标识
  • 2.路由目标uri：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
  • 3.路由断言predicates：判断路由的规则
  • 4.路由过滤器filters：对请求或响应做处理

断言工厂

我们在配置⽂件中写的断⾔规则只是字符串，这些字符串会被Predicate Factory读取并处理，转 变为路由判断的条件 例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理 的，像这样的断⾔⼯⼚在SpringCloudGateway还有⼗⼏个:

例如：

After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]

那么就会访问不到：

改为：

Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]

就可以访问到：

过滤器工厂

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

路由过滤器的种类

Spring提供了31种不同的路由过滤器⼯⼚

请求头过滤器

下⾯我们以AddRequestHeader 为例来讲解。 限制请求的流量 只需要修改gateway服务的application.yml⽂件，添加路由过滤即可：

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      discovery:
        locator:
          enabled: true # 让gateway可以发现nacos中的微服务
      routes:
        - id: product_route
          uri: lb://service-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均 衡策略
          order: 1
          predicates:
            - Path=/product-serv/**
            - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
          filters:
            - StripPrefix=1
            - AddRequestHeader=msg,wake up! # 添加请求头

修改ProductController

//路由过滤器
    @RequestMapping("/productheader")
    public String productHeader(@RequestHeader(value = "msg",required = false)String msg){
        System.out.println("=====>头信息:"+msg);
        return "productHeader";
    }

访问会得到如下头信息：

默认过滤器

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

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

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      discovery:
        locator:
          enabled: true # 让gateway可以发现nacos中的微服务
      routes:
        - id: product_route
          uri: lb://service-product # lb指的是从nacos中按照名称获取微服务,并遵循负载均 衡策略
          order: 1
          predicates:
            - Path=/product-serv/**
            - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
          filters:
            - StripPrefix=1
            - AddRequestHeader=msg,wake up product_route! # 添加请求头
      default-filters: # 默认过滤器，会对所有的路由请求都⽣效
        - AddRequestHeader=msg,wake up default-filters! # 添加请求头

全局过滤器【可写自定义逻辑】

概念

**全局过滤器作用 **全局过滤器的作⽤也是处理⼀切进⼊⽹关的请求和微服务响应，与GatewayFilter的作⽤⼀样。

区别在于GatewayFilter通过配置定义，处理逻辑是固定的；

⽽GlobalFilter的逻辑需要⾃⼰写代码实现。 定义⽅式是实现GlobalFilter接⼝。

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

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

自定义全局过滤器【自定义Auth认证】

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

  • 参数中是否有authorization
  • authorization参数值是否为admin

如果同时满⾜则放⾏，否则拦截

实现：在gateway中定义⼀个过滤器：

首先在gateway中定义一个过滤规则：

package com.stringzhua.shop_gateway.filters;

import org.springframework.beans.factory.annotation.Value;
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;

/**
 * @Author Stringzhua
 * @Date 2024/10/8 15:58
 * description:
 */
@Order(-1)//设置优先级
@Component
public class AuthorizeFilter implements GlobalFilter {
    //Mono<Void> 无状态的返回值，不会立即执行
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//        System.out.println("自定义全局过滤器~");
//        return chain.filter(exchange);

        //1.获取请求参数
        String auth = exchange.getRequest().getHeaders().get("authorization").get(0);

        //2.校验
        if ("admin".equals(auth)) {
            //放行
            return chain.filter(exchange);
        }
        //3.拦截
        //3.1禁止访问
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        //3.2结束处理，返回数据
        return exchange.getResponse().setComplete();
    }
}

重启gateway项目，然后发送请求测试http://localhost:7000/product-serv/product/6?authorization=admin或者postman 测试

这里使用postman测试在Postman中访问：http://localhost:7000/product-serv/product/select/11

过滤器执行顺序

过滤器执⾏顺序

请求进⼊⽹关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter 请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到⼀个过滤器链（集合） 中，排序后依次执⾏每个过滤器

排序规则是什么？

  • 每⼀个过滤器都必须指定⼀个int类型的order值，order值越⼩，优先级越⾼，执⾏顺序越靠前。
  • GlobalFilter通过实现Ordered接⼝，或者添加@Order注解来指定order值，由我们⾃⼰指定
  • 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
  • 当过滤器的order值⼀样时，会按照 defaultFilter > 路由过滤器 >GlobalFilter的顺序执⾏。
测试优先级
package com.stringzhua.shop_gateway.filters;

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

/**
 * @Author Stringzhua
 * @Date 2024/10/8 15:58
 * description:
 */
@Order(-1)//设置优先级
@Component
public class AuthorizeFilter implements GlobalFilter {
    //Mono<Void> 无状态的返回值，不会立即执行
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("自定义全局过滤器~");
        return chain.filter(exchange);
    }
}

优先级为：默认过滤器，路由过滤器，全局过滤器【自定义】

浏览器同源策略

1995年，同源政策由 Netscape 公司引⼊浏览器。⽬前，所有浏览器都实⾏这个政策。

最初，它的含义是指，A⽹⻚设置的 Cookie，B⽹⻚不能打开，除⾮这两个⽹⻚"同源"。所谓"同源"指的 是"三个相同"。

  • 协议相同
  • 域名相同
  • 端⼝相同

举例： http://www.example.com/dir/page.html⽹址

  • 协议是http://
  • 域名是www.example.com
  • 端⼝是80（默认端⼝可以省略）

它的同源情况如下

  • http://www.example.com/dir2/other.html：同源
  • http://example.com/dir/other.html：不同源（域名不同）
  • http://v2.www.example.com/dir/other.html：不同源（域名不同）
  • http://www.example.com:81/dir/other.html：不同源（端⼝不同）

同源⽬的

同源政策的⽬的，是为了保证⽤户信息的安全，防⽌恶意的⽹站窃取数据。

设想这样⼀种情况：A⽹站是⼀家银⾏，⽤户登录以后，⼜去浏览其他⽹站。如果其他⽹站可以读取A⽹ 站的 Cookie，会发⽣什么？

很显然，如果 Cookie 包含隐私（⽐如存款总额），这些信息就会泄漏。更可怕的是，Cookie 往往⽤来保存⽤户的登录状态，如果⽤户没有退出登录，其他⽹站就可以冒充⽤户，为所欲为。因为浏览器同时还规定，提交表单不受同源政策的限制。

由此可⻅，"同源政策"是必需的，否则 Cookie 可以共享，互联⽹就毫⽆安全可⾔了。

跨域问题解决方案

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

  • 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
  • 域名相同，端⼝不同：localhost:8080和localhost8081

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

**CORS **

CORS是跨源资源分享（Cross-Origin Resource Sharing）的缩写。它是W3C标准，是跨源AJAX请求 的根本解决⽅法。相⽐JSONP只能发GET请求，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 #这次跨域检测的有效期

前后端设计：

单体架构

有状态的认证：

首先前端接收用户输入的账号和密码，通过表单的形式提交到后台，后台查询数据库是否存在该用户对象，将用户对象信息保存至session再返回给前端一个登录成功状态。

当下次登录时，检查session会话中是否有该对象，如果有就登录成功，没有则需要重定向到登录界面。

无状态的认证：【主流】

首先前端接收用户输入的账号和密码，通过前端提交到后台，后台查询到数据库中是否存在该用户对象，将该用户的对象信息转换为token串，再和登录成功信息一起返回给前端。

当下次登录时，后端检查前端发送的请求头中是否携带有效token，如果有则登录成功，没有则跳转到登录界面重新登录。

微服务架构

有状态的认证：【不推荐】

无状态的认证：【借助网关实现，推荐】

无状态Token方案是一种基于Token的认证方式，用户登录成功后，服务器会返回一个Token给客户端，客户端每次请求都需要携带这个Token。 服务器通过验证Token的有效性来判断用户的身份和权限。 由于Token是无状态的，即不包含用户的状态信息，因此服务器不需要保存Token的状态，也不需要跨域共享Session。

相关文章