【SpringCloud】Gateway服务网关的基本使用

news2024/11/17 13:47:45

一、初识Gateway服务网关

为什么需要网关?

在微服务中,各个模块之间的调用,也可以称其为远程调用!但是,如果是外部(用户)对微服务进行访问时,发的请求能不加处理的直接访问微服务吗???

答案肯定是不能的!!!

例如,不是所有的业务都是对外公开的,如果"放任"任何用户能对其进行访问,那么这是不安全的!

所以,需要一个安全组件——网关

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

图解微服务架构

Zuul与Gateway对比

在SpringCloud中网关的实现有两种——ZuulGateway

Zuul是基于Servlet实现的,属于阻塞式编程

而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具有更好的性能!!!

Gateway网关的作用

权限控制

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

路由和负载均衡

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

限流

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

二、Gateway快速入门

我们这里先体验一下Gateway的使用,以Gateway的路由功能为例,大致可以分为4个步骤

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

1.创建SpringBoot工程gateway模块,引入网关依赖

创建一个新的服务模块

cloud-demo项目各个模块结构

引入依赖

这里也是需要nacos的注册发现依赖,Gateway本身也是一个服务,也需要注册到nacos或者从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>

2.编写启动类

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

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

创建application.yml文件,配置gateway服务路由规则

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: localhost:8848  # nacos 地址
    gateway:
      routes:
        - id: user-service  # 路由标识,必须唯一
          # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
          uri: lb://userservice  # 路由目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,判断路由是否符合规则
            - Path=/user/**  # 路径断言,判断路径是否是以/user开头,如果是,则符合规则。

        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
            - Before=2031-01-20T17:42:47.789-07:00[America/Denver] # 在这个时间之前的!      

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

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

4.重启服务测试

重启网关,访问localhost:10010/user/1,符合/user/**规则,请求转发到uri:userservice/user/1

同理,访问order-service服务也是这样!

网关路由的流程图

当我们有了网关开始,所有的请求都会经过网关,然后由网关路由到相应的服务中去。

小结

网关搭建步骤:

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

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

路由配置包括:

  • 路由id:路由的唯一标示

  • 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡

  • 路由断言(predicates):判断路由的规则,

  • 路由过滤器(filters):对请求或响应做处理

三、断言工厂(Predicate Factory)

我们在配置文件中写的断言规则只是字符串,这些字符串会断言工厂(Predicate Factory)读取并解析,转变为路由判断的条件

Predicate Factory的作用:读取用户定义的断言规则"字符串",对其进行解析,并对收到的请求做出判断!!!

这里面的Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

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

Spring中提供的11种断言工厂:Spring Cloud Gateway

名称

说明

示例

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.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

权重处理

我们再拿其中的一个来举例子:时间(After)

现在是2023年,而这里order-service服务被访问的前提是2031.1.20之后,所以我们去访问localhost:10010/order/101 肯定是失败的!

四、过滤器工厂

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

路由过滤器的种类

Spring提供了31种不同的路由过滤器工厂,我们只需要记住几种常见的,其余的有用到查官方文档即可,地址如下:Spring Cloud Gateway

名称

说明

AddRequestHeader

给当前请求添加一个请求头

RemoveRequestHeader

移除请求中的一个请求头

AddResponseHeader

响应结果中添加一个响应头

RemoveResponseHeader

响应结果中移除有一个响应头

RequestRateLimiter

限制请求的流量

......

......

我们现在就用请求头过滤器来做一个演示。

请求头过滤器(AddRequestHeader )

【案例需求】给所有进入userservice的请求添加一个请求头

对于这个需求其实很简单,只要修改gateway服务application.yml文件,添加路由过滤即可

如下,我们给userservice添加请求头:Truth=Harmony is freaking awesome!

server:
  port: 10010
spring:
  application:
    name: gateway
  cloud:
    nacos:
      server-addr: localhost:8848  # nacos 地址
    gateway:
      routes:
        - id: user-service  # 路由标识,必须唯一
          uri: lb://userservice  # 路由目标地址
          predicates: # 路由断言,判断路由是否符合规则
            - Path=/user/**  # 路径断言,判断路径是否是以/user开头,如果是,则符合规则。
          # 局部过滤器
          filters:
            - AddRequestHeader=Truth,Harmony is freaking awesome!  #添加请求头
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
            - After=2031-01-20T17:42:47.789-07:00[America/Denver]

我们想要看看刚刚添加的请求头,可以通过在UserController中使用@RequestHeader注解获取请求头并打印

@Slf4j
@RestController
@RequestMapping("/user")
//@RefreshScope // 开启 nacos 属性刷新
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth", required = false) String truth) {
        System.out.println("truth: " + truth);
        return userService.queryById(id);
    }
    ......
}

访问localhost:10010/user/1,在控制台上就会出现如下情况:

注意:当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效

默认过滤器

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

格式如下:

注意:局部过滤器是在routes下的,而default-filters(默认过滤器)是和routes平级的!

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

小结

过滤器的作用是什么?

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

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

default-Filters的作用是什么?

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

五、全局过滤器

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

更直白一个说,就是之前提到的default-Filters,我们只能通过application.yml文件来配置其参数,具体的业务逻辑是Spring实现的,我们无从干涉!!!

而当我们想要自己编写过滤器的逻辑呢?

显然仅仅default-Filters是不够的!!!这时候就需要全局过滤器(GlobalFilter)

1.全局过滤器作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。

区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。

如何实现GlobalFilter呢?

仅需一步即可——定义方式是实现GlobalFilter接口

GlobalFilter接口如下所示:

public interface GlobalFilter {
    /**
     *  处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文,里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
  • exchange:请求上下文,即当请求进入网关开始,一直到结束,整个过程中exchange对象一直都是可见的!

  • chain:用于放行的,将信息交给下一个过滤器来处理。

2.自定义全局过滤器(GlobalFilter)

需求分析

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

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

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

代码实现

gateway模块中定义一个过滤器

//@Ordered(-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. 获取参数中的 authorizeFilter 参数
        String auth = params.getFirst("authorization");

        // 3. 判断参数中是否有admin
        if ("admin".equals(auth)) {
            // 4. 是,放行
            return chain.filter(exchange);
        }

        // 5. 否,拦截
        // HttpStatus 是 org.springframework.http
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); // 未登入
        return exchange.getResponse().setComplete();
    }

    // 顺序-过滤器的优先级,越小越高!!!
    @Override
    public int getOrder() {
        return -1;
    }
}

运行结果

当我们访问的路径中存在authorization参数,且其值为admin时,可以获取到正确的结果

反之,就会报错,即我们上述代码中设定的HttpStatus.UNAUTHORIZED(401)

3.过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器DefaultFilterGlobalFilter

请求路由后,会将当前路由过滤器和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排序,组织过滤器链

六、跨域问题

什么是跨域问题

模拟跨域问题

解决跨域问题

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/184340.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

使用Client Java构建Exporter程序

一、client_java client_java是Prometheus针对JVM类开发语言的client library库&#xff0c;我们可以直接基于client_java用户可以快速实现独立运行的Exporter程序&#xff0c;也可以在我们的项目源码中集成client_java以支持Prometheus。注意&#xff1a;Prometheus 提供的cl…

WordPress默认数据库中的12个数据表

WordPress 安装的时候数据库会有 12 张默认的数据表&#xff0c;每张表的数据都包含了 WordPress 不同的功能。看看这些表的结构&#xff0c;你能很容易的了解网站不同的部分都是存在哪里的。目前&#xff0c;默认的 WordPress 安装会创建如下12个数据表。表名描述wp_users您的…

大数据在5G应用场景下有哪些示范项目?

近期&#xff0c;贵州省2022年5G应用场景示范观摩会在贵阳召开&#xff0c;此次观摩会由贵州省大数据发展管理局、贵州省通信管理局主办。数据宝“基于5G技术的交通国有大数据治理多元应用”获得贵州省5G应用场景示范项目&#xff08;五星&#xff09;称号。 据悉&#xff0c;…

二叉树(二)

前言本章我们继续了解二叉树。上文我们对树和二叉树有了简单的了解&#xff0c;详见二叉树&#xff08;一&#xff09;这里我要解释一下为什么我们不对树进行增删查改呢&#xff1f;答案是&#xff1a;没有意义。我们更应该把有限的精力用作有意的地方&#xff0c;那么我们今天…

TLS协议。

IPSec通过安全关联实现IP分组安全关联两端之间的安全传输过程&#xff0c;TLS通过建立安全连接实现数据在两个应用进程之间的安全传输过程。TLS建立安全连接时&#xff0c;实现安全连接两端应用进程之间的双向身份鉴别过程&#xff0c;保证经过安全连接传输的数据的保密性和完整…

【GPLT 二阶题目集】L2-017 人以群分

社交网络中我们给每个人定义了一个“活跃度”&#xff0c;现希望根据这个指标把人群分为两大类&#xff0c;即外向型&#xff08;outgoing&#xff0c;即活跃度高的&#xff09;和内向型&#xff08;introverted&#xff0c;即活跃度低的&#xff09;。要求两类人群的规模尽可能…

时间序列模型

一、季节分解 1、概念 时间序列也称为动态序列&#xff0c;是指将某种现象的指标数值按照时间顺序排列而成的数值序列。主要由时间要素和数值要素构成。时期序列中&#xff0c;数值要素反映现象在一定时期内发展的结果&#xff1b;时点序列中&#xff0c;数值要素反映现象在一…

如何在FreeBSD中安装Nginx,MySQL,PHP(FEMP)

本文介绍如何在FreeBSD 13系统中安装Nginx、MySQL、和PHP服务。系统环境FreeBSD 13.0-RELEASE更新系统在安装任何软件之前更新系统是一个好习惯&#xff0c;以便检查系统更新&#xff1a;rootfreebsd:~ # freebsd-update fetchrootfreebsd:~ # freebsd-update install安装Nginx…

在线教育-谷粒学院学习笔记(九)

文章目录1 内容介绍2 搭建项目前台环境NUXT3 整合项目首页4 nuxt路由5 首页数据banner显示—初始配置6 首页数据banner显示—接口7 首页数据banner显示—前端实现8 首页数据显示—热门课程和名师9 Redis复习10 首页数据添加Redis缓存1 内容介绍 搭建项目前台系统环境 NUXT 整合…

【PHP 随记】—— Composer 安装及镜像配置

&#x1f449;总目录&#x1f448;\large\colorbox{skyblue}{&#x1f449;总目录&#x1f448;}&#x1f449;总目录&#x1f448;​ 文章目录1、Composer 安装2、配置镜像Composer 是 PHP 用来管理依赖&#xff08;dependency&#xff09;关系的工具&#xff1b;简单来说&…

等级保护介绍

等保流程 等级保护 等保发展历程 。1994 首次国家提出等级保护概念 。1999 针对信息系统保护有法律依据 。2007 等保1.0措施。 。2017 立法了《网络安全法》 。2019年 等保2.0 颁布 等保2.0和1.0有什么特点和区别 1.名称变了信息安全技术信息等级保护要求 改为 信息安全基础网络…

1、测试用例通用模板

一、针对大版本需求的测试用例模板 1、测试用例模板说明 1.1、表头说明 项目版本号V1.0--测试用例&#xff08;示例标题&#xff09;(xxxxx有限公司测试组/ONLY FOR INTERNAL USE ONLY)Confidentiality level 密级(xxxxxx测试组/仅供内部使用) Internal 内部公开 修订记录版…

软件设计(二)

软件设计&#xff08;一&#xff09;https://blog.csdn.net/ke1ying/article/details/128779601 11、windows系统当双击.jpg文件的时候&#xff0c;系统会通过建立的 文件关联 来决定使用什么程序来打开该图像文件。 &#xff08;双击.jpg文件&#xff0c;系统会建立‘window…

【哈希表】leetcode349. 两个数组的交集(C/C++/Java/Python/Js)

leetcode349. 两个数组的交集1 题目2 思路--set2.1 拓展/后记3 代码3.1 C版本3.2 C版本3.3 Java版本3.4 Python 版本3.5 JavaScript版本4 总结1 题目 题源链接 给定两个数组 nums1 和 nums2 &#xff0c;返回 它们的交集 。输出结果中的每个元素一定是 唯一 的。我们可以 不考…

分享150个ASP源码,总有一款适合您

ASP源码 分享150个ASP源码&#xff0c;总有一款适合您 下面是文件的名字&#xff0c;我放了一些图片&#xff0c;文章里不是所有的图主要是放不下...&#xff0c; 150个ASP源码下载链接&#xff1a;https://pan.baidu.com/s/1DpxbFxdGCl9eWEe3AaD1eA?pwdecqi 提取码&#x…

echarts数据可视化项目搭建(二)

目录主题设置默认主题重点示例自定义主题调色盘主题全局局部颜色渐变可视化图表自适应重点示例实现简单的加载动画重点示例增量动画实现重点示例简单动画配置项关于全局echarts对象和echartsInstance对象echarts.connect()其他echarts实例对象方法本博客内容参考黑马课程&#…

系统编程中的进程的概念No.2

引言&#xff1a; 今天是个好日子&#xff0c;日更动态养成习惯&#xff0c;日更博客你我他&#xff0c;北京时间 2023/1/29/10:09&#xff0c;今天阳光明媚&#xff0c;但是还是很冷&#xff0c;起床时间8:55&#xff0c;可以看出又早了那么一点点&#xff0c;今天为什么能起…

VSCode调试Python文件并指定虚拟环境

记录在使用VSCode调试py文件时遇到的一些问题&#xff1a;1.启用Debug模式进行调试2.调试带参数的python文件3. 调试时指定服务器虚拟环境4. 相对路径出错首先给出VScode 官方调试说明&#xff1a;https://code.visualstudio.com/docs/python/debugging#_set-configuration-opt…

法律常识(六)《最高人民法院婚姻法司法解释精释精解》例子

目录 一、婚约财产&#xff08;彩礼&#xff09;纠纷 二、夫妻共同债务中违法债务的审查认定 三、夫妻之间也可以成立借贷关系 四、一方未经另一方同意出售夫妻共同共有的房屋 五、夫妻一方婚前财产投资所得的归属 六、夫妻间房产赠与协议的效力认定 七、婚内财产分割的…

拉新、留存、转化、提频、裂变

任何一家创业公司从启动到成功&#xff0c;都会把一件事情当作核心&#xff0c;那就是增长。什么是增长&#xff1f;有人说是收入&#xff0c;有人说是利润&#xff0c;还有人说是市场份额&#xff0c;实际上都对&#xff0c;但这些都建立在一个基础要素之上&#xff0c;那就是…