网关Gateway

网关Gateway,第1张

网关Gateway 1.网关简介 1.1背景

客户端可以直接向微服务发送请求,每个微服务都有一个公开的URL,该URL可以直接映射到具体的微服务,如果没有网关的存在,我们只能在客户端记录每个微服务的地址,然后分别去调用。这样的架构,会存在着诸多的问题,例如,客户端请求不同的微服务可能会增加客户端代码或配置的复杂性。还有就是每个服务,在调用时都需要独立认证。并且存在跨域请求,也在一定程度上提高了代码的复杂度。基于微服务架构中的设计及实现上的问题,为了在项目中简化前端的调用逻辑,同时也简化内部服务之间互相调用的复杂度,更好保护内部服务,提出了网关的概念。

1.2网关概述

网关本质上要提供一个各种服务访问的入口,并提供服务接收并转发所有内外部的客户端调用,还有就是权限认证,限流控制等等。
Spring Cloud Gateway优缺点分析:
优点:
性能强劲:是第一代网关Zuul的1.6倍。
功能强大:内置了很多实用的功能,例如转发、监控、限流等
设计优雅,容易扩展。
缺点:
依赖Netty与WebFlux(Spring5.0),不是传统的Servlet编程模型(Spring MVC就是基于此模型实现),学习成本高。
需要Spring Boot 2.0及以上的版本,才支持

2.快速入门 2.1添加依赖

    org.springframework.cloud
    spring-cloud-starter-gateway

添加此依赖,不能在添加spring-cloud-starter-web依赖,gateway自带web服务

2.2创建application.yml
server:
  port: 9000
spring:
  application:
    name: sca-gateway #没有添加nacos依赖,可不写
  cloud:
    gateway:
      routes: #配置网关路由规则
        - id: route01 #路由id,自己指定
          uri: http://localhost:8081/ #网关帮转发的url
          predicates: #断言(谓词):匹配请求规则
            - Path=/nacos/provider/echo/** #请求路径定义,此路径对应url中资源
          filter: ##网关过滤器,用于对为此中的内容进行判断分析及处理
            - StripPrefix=1 #转发之前去掉path中第一层路径,例如nacos

503异常:访问请稍等
其中:路由(Route) 是 gateway 中最基本的组件之一,表示一个具体的路由信息载体。主要定义了下面的几个信息:

  1. id,路由标识符,区别于其他 Route。
  2. uri,路由指向的目的地 uri,即客户端请求最终被转发到的微服务。
  3. predicate,断言(谓词)的作用是进行条件判断,只有断言都返回真,才会执行路由。
  4. filter,过滤器用于修改请求和响应信息
2.3创建启动类
package com.cy;

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

测试:

3.负载均衡设计

网关才是服务访问的入口,所有服务都会在网关层面进行底层映射,所以在访问服务时,要基于服务serivce id(服务名)去查找对应的服务,让请求从网关层进行均衡转发,以平衡服务实例的处理能力。

3.1项目中添加服务发现依赖

    com.alibaba.cloud
    spring-cloud-starter-alibaba-nacos-discovery

3.2修改配置文件


lb指的是从nacos中按照名称获取微服务,并遵循负载均衡策略。同时建议开发阶段打开gateway日志:

logging:
  level:
    org.springframework.cloud.gateway: debug
3.3启动服务,进行访问测试,并反复刷新分析



4.执行流程分析(重点)



客户端向Spring Cloud Gateway发出请求,如果Gateway Handler Mapping通过谓词predicates的集合确定请求与路由匹配,则将其发送到Gateway Web Handler。Gateway Web Handler 基于路由配置调用过滤链中的过滤器(也就是所谓的责任链模式)进一步的处理请求。 Filter由虚线分隔的原因是, Filter可以在发送请求之前和之后执行拓展逻辑。

5.断言(Predicate)增强分析 5.1Predicate 简介

Predicate(断言)又称谓词,用于条件判断,只有断言结果都为真,才会真正的执行路由。断言其本质就是定义路由转发的条件。

5.2Predicate 内置工厂

SpringCloud Gateway包括一些内置的断言工厂(所有工厂都直接或间接的实现了RoutePredicateFactory接口),这些断言或谓词工程负责创建谓词对象,并通过这些谓词对象判断http请求的合法性。

5.2.1基于Datetime类型的断言工厂

1) AfterRoutePredicateFactory:判断请求日期是否晚于指定日期
2) BeforeRoutePredicateFactory:判断请求日期是否早于指定日期
3) BetweenRoutePredicateFactory:判断请求日期是否在指定时间段内

- After=2020-12-31T23:59:59.789+08:00[Asia/Shanghai]
当且仅当请求时的时间After配置的时间时,才转发该请求,若请求时的时间不是After配置的时间时,则会返回404 not found。时间值可通过ZonedDateTime.now()获取。

5.2.2基于header的断言工厂HeaderRoutePredicateFactory

判断请求Header是否具有给定名称且值与正则表达式匹配。
- Header=X-Request-Id, d+

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

MethodRoutePredicateFactory接收一个参数,判断请求类型是否跟指定的类型匹配。
- Method=GET

5.2.4基于Query请求参数的断言工厂,QueryRoutePredicateFactory

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

- Query=pageSize,d+

5.2.5Predicate 应用案例实践
server:
  port: 9000
spring:
  application:
    name: sca-gateway #没有添加nacos依赖,可不写
  cloud:
    nacos:
      discovery:  #服务的注册
        server-addr: localhost:8848
    gateway:  #网关配置
      routes: #配置网关路由规则,routes下可有多个路由,id标识
        - id: route01 #路由id,自己指定
          #uri: http://localhost:8081/ #请求转发的url
          uri: lb://sca-provider #lb为服务前缀(负载均衡英文缩写)
          predicates: #谓词判断逻辑:定义请求转发条件,谓词所有条件都满足才会执行请求转发
            - Path=/nacos/provider/echo/** #请求路径定义,此路径对应url中资源
            - After=2021-12-10T23:59:59.789+08:00[Asia/Shanghai]
            #- Between=2021-12-28T23:59:59.789+08:00[Asia/Shanghai],2021-12-30T23:59:59.789+08:00[Asia/Shanghai]
            #- Header=X-Request-Id, d+
            #- Method=Post
            #- Query=pageSize,d+
          filters: ##网关过滤器,针对于当前路由进行设计,谓词逻辑返回值都为true则执行过滤器
            - StripPrefix=1 #转发之前去掉path中第一层目录,例如nacos
6.过滤器(Filter)增强分析 6.1概述

过滤器(Filter)就是在请求传递过程中,对请求和响应做一个处理。Gateway 的Filter从作用范围可分为两种:GatewayFilter与GlobalFilter。其中:

1.GatewayFilter:应用到单个路由或者一个分组的路由上。
2.GlobalFilter:应用到所有的路由上。
6.2局部过滤器设计及实现 6.2.1基于AddRequestHeaderGatewayFilterFactory,为原始请求添加Header

为原始请求添加名为 X-Request-Foo ,值为 Bar 的请求头:

spring:
  cloud:
    gateway:
      routes:
        - id: add_request_header_route
          uri: https://example.org
          filters:
            - AddRequestHeader=X-Request-Foo, Bar
6.2.2基于AddRequestParameterGatewayFilterFactory,为原始请求添加请求参数及值

为原始请求添加名为foo,值为bar的参数,即:foo=bar

spring:
  cloud:
    gateway:
      routes:
        - id: add_request_parameter_route
          uri: https://example.org
          filters:
            - AddRequestParameter=foo, bar
6.2.3基于PrefixPathGatewayFilterFactory,为原始的请求路径添加一个前缀路径

该配置使访问${GATEWAY_URL}/hello 会转发到uri/mypath/hello

spring:
  cloud:
    gateway:
      routes:
        - id: prefixpath_route
          uri: https://example.org
          filters:
            - PrefixPath=/mypath
6.2.4基于RequestSizeGatewayFilterFactory,设置允许接收最大请求包的大小
spring:
  cloud:
    gateway:
      routes:
        - id: request_size_route
      uri: http://localhost:8080/upload
      predicates:
        - Path=/upload
      filters:
        - name: RequestSize
          args:
            # 单位为字节
            maxSize: 5000000

如果请求包大小超过设置的值,则会返回 413 Payload Too Large以及一个errorMessage

6.3全局过滤器设计及实现

全局过滤器(GlobalFilter)作用于所有路由, 无需配置。在系统初始化时加载,并作用在每个路由上。通过全局过滤器可以实现对权限的统一校验,安全性验证等功能。一般内置的全局过滤器已经可以完成大部分的功能,但是对于企业开发的一些业务功能处理,还是需要我们 自己编写过滤器来实现的,那么我们一起通过代码的形式自定义一个过滤器,去完成统一的权限校验。 例如,当客户端第一次请求服务时,服务端对用户进行信息认证(登录), 认证通过,将用户信息进行加密形成token,返回给客户端,作为登录凭证 以后每次请求,客户端都携带认证的token 服务端对token进行解密,判断是否有效。

@Component //将过滤器交给spring管理,需注释,否则都需要指定参数
public class AuthGlobalFilter implements GlobalFilter , Ordered {
    @Override
    public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //1.获取请求对象
        ServerHttpRequest request = exchange.getRequest();
        //2.获取请求数据
        String username = request.getQueryParams().getFirst("username");
        //3.进行认证分析
        //3.1认证失败则拒绝请求继续传递
        if (!"admin".equals(username)){
            ServerHttpResponse response = exchange.getResponse();
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            return response.setComplete();
        }
        //3.2认证成功继续传递
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

启动Gateway服务,假如在访问的url中不带“user=admin”这个参数,可能会出现异常

7.限流设计及实现 7.1限流快速入门

第一步:添加依赖在原有spring-cloud-starter-gateway依赖的基础上再添加如下两个依赖:


    com.alibaba.cloud
    spring-cloud-starter-alibaba-sentinel


    com.alibaba.cloud
    spring-cloud-alibaba-sentinel-gateway

第二步:添加sentinel:

sentinel:
  transport:
    dashboard: localhost:8180 #Sentinel 控制台地址
  eager: true  #取消Sentinel控制台懒加载,即项目启动即连接

第三步:启动网关项目,检测sentinel控制台的网关菜单。
启动时,添加sentinel的jvm参数,通过此菜单可以让网关服务在sentinel控制台显示不一样的菜单:

-Dcsp.sentinel.app.type=1



第四步:在sentinel面板中设置限流策略:

7.2基于请求属性限流

参数属性:Header请求头 设置为token,匹配串1000
URL参数 设置为id,匹配串100,在地址栏输入参数
Client IP 设置为127.0.0.1,5秒内输入,localhost会自动解析成127.0.0.1

5秒内访问

7.3自定义API维度限流(重点)

第一步:新建API分组:

第二步:新建分组流控规则

第三步:进行访问测试

7.4定制流控网关返回值
@Configuration
public class GatewayConfig {
    public GatewayConfig(){
        GatewayCallbackManager.setBlockHandler( new BlockRequestHandler() {
            @Override
            public Mono handleRequest(ServerWebExchange serverWebExchange, Throwable throwable) {
                Map map=new HashMap<>();
                map.put("state",429);
                map.put("message","two many request");
                String jsonStr=JSON.toJSONString(map);
                return ServerResponse.ok().body(Mono.just(jsonStr),String.class);
            }
        });
    }
}
8.微服务架构下ajax请求响应处理 8.1第一步:业务描述

通过sca-ui工程向网关工程发送ajax请求,并进行响应处理

8.2创建sca-ui工程,父工程为01-sca 8.2.1配置pom文件

    org.springframework.boot
    spring-boot-starter-web

8.2.2在sca-ui工程中启动类
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
8.2.3在sca-ui工程创建static目录,在此目录下添加js文件,html文件




    
    
    
    



    按钮
    

{{msg}}

欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/zaji/5684546.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-12-17
下一篇 2022-12-17

发表评论

登录后才能评论

评论列表(0条)

保存