Gateway服务网关

最新推荐文章于 2023-08-26 11:04:20 发布

贝壳扑鱼

最新推荐文章于 2023-08-26 11:04:20 发布

阅读量306

点赞数

分类专栏： spring cloud

本文链接：https://blog.csdn.net/lyq_cc/article/details/118572660

版权

spring cloud 专栏收录该内容

6 篇文章 1 订阅

订阅专栏

1、服务网关简介

在微服务的体系架构中，一个系统被分成许多个微服务，那么作为客户端如何去调用这些微服务呢？如果没有服务网关的存在，客户端之能记住每个微服务的ip地址，大量的微服务就对应大量的ip地址，若记住这些IP地址是不现实的事情；
在这里插入图片描述

所以这样的微服务架构存在着一些弊端：

客户端多次请求不同的微服务，增加客户端代码或配置的编写难度
认证复杂，每个服务都需要单独认证，增加了代码的冗余性
存在跨域请求，在一定场景下处理复杂

对于上述出现的问题，可以通过API网关来解决、
什么是API网关
所谓的API网关就是指一个系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一的服务，一些与业务无关的公共逻辑代码可以在这里实现，例如认证，授权，监控、路由转发等；
添加上API网关，整个项目架构的结构图如下
在这里插入图片描述

比较流行的服务网关有以下几种：

Nginx+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用；
lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本
Kong
基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。问题：
只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。
Zuul
Netflix开源的网关，功能丰富，使用JAVA开发，易于二次开发问题：缺乏管控，无法动态配置；依赖组件较多；处理Http请求依赖的是Web容器，性能不如Nginx
Spring Cloud Gateway
Spring公司为了替换Zuul而开发的网关服务，将在下面具体介绍。
注意：SpringCloud alibaba技术栈中并没有提供自己的网关，我们可以采用Spring Cloud Gateway来做网关

2、Gateway简介

Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等术开发的网关，
它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
它的目标是替代 Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

优点：

性能强劲：是第一代网关Zuul的1.6倍
功能强大：内置了很多实用的功能，例如转发、监控、限流等
设计优雅，容易扩展

缺点：

其实现依赖Netty与WebFlux，不是传统的Servlet编程模型，学习成本高
不能将其部署在Tomcat、Jetty等Servlet容器里，只能打成jar包执行 web.Jar
需要Spring Boot 2.0及以上的版本，才支持

3、Gateway快速入门

（1）创建一个api-gateway模块，并在pom文件中添加依赖

<!--加入gateway的依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

（2）创建主启动类

@SpringBootApplication
public class ApiGateWayMain {

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

（3）创建配置文件

# 端口号
server.port=80

# 在注册中心的微服务名
spring.application.name=api-gateway
# 注册中心得ip地址
spring.cloud.nacos.discovery.server-addr=localhost:8848

# 微服务路由的唯一标识，要求唯一
spring.cloud.gateway.routes[0].id=shop-product
# 微服务的地址
spring.cloud.gateway.routes[0].uri=http://localhost:8081/
# 断言（条件判断，可以有多个断言，当所有的断言都为true时，进行放行） Path是请求的路径前缀必须是/product
spring.cloud.gateway.routes[0].predicates[0]= Path=/product/**

spring.cloud.gateway.routes[1].id=shop-order
spring.cloud.gateway.routes[1].uri=http://localhost:8091/
spring.cloud.gateway.routes[1].predicates[0]= Path=/order/**

（4）通过服务网关访问微服务

启动项目，并通过网关访问微服务
在这里插入图片描述

（5）增强版

我们在配置文件中，写死了转发路径的地址，这样就是硬编码；为了避免这个问题，我们可以从注册中心中获取此地址

①在pom文件添加依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-nacos-discovery</artifactId>
</dependency>

②在主启动类上添加注解

这一步，@EnableDiscoveryClient可加可不加

@SpringBootApplication
@EnableDiscoveryClient
public class ApiGateWayMain {

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

③修改properties配置文件

# 端口号
server.port=80

# 在注册中心的微服务名
spring.application.name=api-gateway
# 注册中心得ip地址
spring.cloud.nacos.discovery.server-addr=localhost:8848

# 微服务路由的唯一标识，要求唯一
spring.cloud.gateway.routes[0].id=shop-product
# 修改路径，从注册中心上获取
spring.cloud.gateway.routes[0].uri=lb://shop-product
# 断言（条件判断，可以有多个断言，当所有的断言都为true时，进行放行） Path是请求的路径前缀必须是/product
spring.cloud.gateway.routes[0].predicates[0]= Path=/product/**

spring.cloud.gateway.routes[1].id=shop-order
spring.cloud.gateway.routes[1].uri=lb://shop-order
spring.cloud.gateway.routes[1].predicates[0]= Path=/order/**

（6）简易版

①在配置文件中去掉关于路由的配置

# 端口号
server.port=80

# 在注册中心的微服务名
spring.application.name=api-gateway
# 注册中心得ip地址
spring.cloud.nacos.discovery.server-addr=localhost:8848

# 开启网关发现定位器
spring.cloud.gateway.discovery.locator.enabled=true

②启动项目，通过网关访问微服务

在这里插入图片描述

注意：
按照 网关地址/微服务/接口 的格式去访问
访问路径一定要加上微服务的注册名

4、Gateway核心架构

（1）基本概念

路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。
主要定义了下面的几个信息:

id，路由标识符，区别于其他 Route。
uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。
order，用于多个 Route 之间的排序，数值越小排序越靠前，匹配优先级越高。
predicates，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。
filter，过滤器用于修改请求和响应信息。

（2）执行流程

在这里插入图片描述

执行流程大体如下：

Gateway Client向Gateway Server发送请求
请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文
然后网关的上下文会传递到DispatcherHandler，它负责将请求分发给 RoutePredicateHandlerMapping
RoutePredicateHandlerMapping负责路由查找，并根据路由断言判断路由是否可用
如果过断言成功，由FilteringWebHandler创建过滤器链并调用
请求会一次经过PreFilter–微服务–PostFilter的方法，最终返回响应

（3）断言（Predicate）

断言用于条件判断，是一个数组。所以断言中可以存在多个条件，当所有的条件全部都满足的时候，才会真正的执行路由。
断言都为真，才会执行路由

（4）内置的路由断言工厂

SpringCloud Gateway包括许多内置的断言工厂，所有这些断言都与HTTP请求的不同属性匹配体如下：

基于Datetime类型的断言工厂
此类型的断言根据时间做判断，主要有三个：
AfterRoutePredicateFactory：接收一个日期参数，判断请求日期是否晚于指定日期
BeforeRoutePredicateFactory：接收一个日期参数，判断请求日期是否早于指定日期
BetweenRoutePredicateFactory：接收两个日期参数，判断请求日期是否在指定时间段内

例：-After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]

基于远程地址的断言工厂

RemoteAddrRoutePredicateFactory：接收一个IP地址段，判断请求主机地址是否在地址段中

例：-RemoteAddr=192.168.1.1/24

基于Cookie的断言工厂
CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。判断请求
cookie是否具有给定名称且值与正则表达式匹配。

-Cookie=chocolate, ch.

基于Header的断言工厂

HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。

-Host=**.testhost.org

基于Method请求方法的断言工厂

MethodRoutePredicateFactory：接收一个参数，判断请求类型是否跟指定的类型匹配。

-Method=GET

基于Path请求路径的断言工厂
PathRoutePredicateFactory：接收一个参数，判断请求的URI部分是否满足路径规则。

-Path=/foo/{segment}  基于Query请求参数的断言工厂

QueryRoutePredicateFactory ：接收两个参数，请求param和正则表达式，判断请求参数是否具有给定名称且值与正则表达式匹配。

-Query=baz, ba.

基于路由权重的断言工厂
WeightRoutePredicateFactory：接收一个[组名,权重], 然后对于同一个组内的路由按照权重转发
内置断言工厂的示例使用

在配置文件中指定Method请求方法的断言，请求类型指定为POST
在这里插入图片描述
测试：

使用GET方式请求，传递参数
断言判断为假，拒绝请求转发

（5）自定义路由断言工厂

设定一个场景: 假设我们的应用仅仅让age在(min,max)之间的人来访问。
实现步骤：
1、创建一个自定义断言工厂类

package com.lyq.apigateway.predicate;

import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.cloud.gateway.handler.predicate.GatewayPredicate;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import javax.validation.constraints.NotNull;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

/**
 * @program: springcloud-nacos-077
 * @description: 自定义年龄断言工厂
 * @author: Lv Yongqi
 * @create: 2021-07-08 16:25
 **/
@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> {

    public AgeRoutePredicateFactory() {
        super(AgeRoutePredicateFactory.Config.class);
    }

    /**
     * 读取配置文件中定义的值，按照顺序
     * @return
     */
    @Override
    public List<String> shortcutFieldOrder() {
        // 要与Config类中定义的属性保持一致
        return Arrays.asList("minAge","maxAge");
    }
    
    @Override
    public Predicate<ServerWebExchange> apply(AgeRoutePredicateFactory.Config config) {
        return new GatewayPredicate() {
            /**
             * 判断请求传递的参数值是否符合配置文件中定义的断言规则
             * @param serverWebExchange
             * @return
             */
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                String age = serverWebExchange.getRequest().getQueryParams().getFirst("age");
                // 判断字符串是否为空
                if (!age.isEmpty()){
                    // 将String转换成int
                    int i = Integer.parseInt(age);
                    return i >= config.minAge && i <= config.maxAge;
                }
                return false;
            }
        };
    }

    @Data
    @NoArgsConstructor
    public static class Config {

        @NotNull
        private Integer minAge;
        @NotNull
        private Integer maxAge;

    }
}

2、配置文件中添加自定义断言

# 自定年龄断言，大于18 ，小于60
spring.cloud.gateway.routes[0].predicates[1]= Age=18,60

3、测试
在这里插入图片描述

5、过滤器

作用: 过滤器就是在请求的传递过程中,对请求和响应做一些手脚
生命周期: Pre Post
分类: 局部过滤器(作用在某一个路由上) 全局过滤器(作用全部路由上)

在Gateway中，Filter的生命周期只有两个 pre 和 post

PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

在这里插入图片描述

Gateway 的Filter从作用范围可分为两种: GatewayFilter 与 GlobalFilter。

GatewayFilter：应用到单个路由或者一个分组的路由上。
GlobalFilter：应用到所有的路由上。

（1）内置局部过滤器

在springCloudGateway中内置了许多不同类型的网关路由过滤器

在这里插入图片描述

①简单使用

在配置文件中设置局部过滤器
将原本的状态响应码改为250
通过浏览器访问，发现此时的的状态响应码变为了250

在这里插入图片描述

（2）全局过滤器

全局过滤器作用于所有路由, 无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。

①内置全局过滤器

SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下：
在这里插入图片描述

②自定义全局过滤器

内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。

开发中的鉴权逻辑：

当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
认证通过，将用户的信息进行加密形成token，返回给客户端aaa，作为登录凭证
以后每次登录，客户端都携带认证的token
服务端对token进行解密，判断是否有效

在这里插入图片描述
如上图，对于验证用户是否已经登录鉴权的过程可以在网关统一检验。
检验的标准就是请求中是否携带token凭证以及token的正确性。
下面的我们自定义一个GlobalFilter，去校验所有请求的请求参数中是否包含“token”，如何不包含请求参数“token”则不转发路由，否则执行正常的逻辑
自定义全局过滤器要求： 必须实现GlobalFilter,Order接口

package com.lyq.apigateway.filter;

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

/**
 * @program: springcloud-nacos-077
 * @description: 全局过滤器
 * @author: Lv Yongqi
 * @create: 2021-07-08 19:10
 **/
@Component
public class AuthGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        String token = exchange.getRequest().getQueryParams().getFirst("token");
        if (!token.isEmpty() && "admin".equals(token)) {
            return chain.filter(exchange);
        }
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        return exchange.getResponse().setComplete();
    }

    /**
     * 权重，值越小优先级越高
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

测试结果：
在这里插入图片描述

贝壳扑鱼

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Gateway服务网关

1、服务网关简介在微服务的体系架构中，一个系统被分成许多个微服务，那么作为客户端如何去调用这些微服务呢？如果没有服务网关的存在，客户端之能记住每个微服务的ip地址，大量的微服务就对应大量的ip地址，若记住这些IP地址是不现实的事情；所以这样的微服务架构存在着一些弊端：客户端多次请求不同的微服务，增加客户端代码或配置的编写难度认证复杂，每个服务都需要单独认证，增加了代码的冗余性存在跨域请求，在一定场景下处理复杂对于上述出现的问题，可以通过API网关来解决、什么是API网关所谓的API网关
复制链接

扫一扫