• 微服务网关Gateway使用


    为什么需要网关?

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

    网关的核心功能特性

    • 请求路由和负载均衡
      • 一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
    • 权限控制
      • 网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
    • 限流
      • 当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。

    架构图

    image

    gateway快速入门

    基本步骤如下:

    1、创建SpringBoot工程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>
    

    2、编写启动类

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

    我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
    本例中,我们将 /user/** 开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。

    4、启动网关服务进行测试

    重启网关,访问 http://localhost:10010/user/1 时,符合/user/**规则,请求转发到uri:http://userservice/user/1
    得到了结果:
    image

    5、网关路由的流程图

    image

    总结

    网关搭建步骤

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

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

    路由配置包括

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

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

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

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


    路由断言和路由过滤器

    断言工厂

    名称说明示例
    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,.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权重处理

    过滤器工厂

    GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
    image
    Spring提供了31种不同的路由过滤器工厂。例如:

    名称说明
    AddRequestHeader给当前请求添加一个请求头
    RemoveRequestHeader移除请求中的一个请求头
    AddResponseHeader给响应结果中添加一个响应头
    RemoveResponseHeader从响应结果中移除有一个响应头
    RequestRateLimiter限制请求的流量

    请求头过滤器

    下面我们以AddRequestHeader 为例来讲解。

    需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!

    只需要修改gateway服务的application.yml文件,添加路由过滤即可:

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

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

    默认过滤器

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

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

    过滤器的作用是什么?

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

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

    defaultFilters的作用是什么?

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

    全局过滤器

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

    定义方式是实现GlobalFilter接口。

    自定义全局过滤器

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

    1. 参数中是否有authorization
    2. authorization参数值是否为admin

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

    实现:在gateway中定义一个过滤器:

    package com.cn.gateway.filters;
    
    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;
    
    @Order(-1)
    @Component
    public class AuthorizeFilter implements GlobalFilter {
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
            // 1.获取请求参数
            MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
            // 2.获取authorization参数
            String auth = params.getFirst("authorization");
            // 3.校验
            if ("admin".equals(auth)) {
                // 放行
                return chain.filter(exchange);
            }
            // 4.拦截
            // 4.1.禁止访问,设置状态码
            exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
            // 4.2.结束处理
            return exchange.getResponse().setComplete();
        }
    }
    

    过滤器执行顺序

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

    请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:
    image
    排序的规则是什么呢?

    • 每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前

    • GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定

    • 路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。

    • 当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter 的顺序执行。

  • 相关阅读:
    SVN
    git
    电商架构
    django
    linux单项目发布流程
    pandas的基本功能(一)
    Swift 添加自定义响应事件
    Swfit中视图跳转
    移动设备默认不播放媒体文件间接解决办法
    HTML5 使用sessionStorage实现页面返回刷新
  • 原文地址:https://www.cnblogs.com/zhaojinhui/p/16707672.html
Copyright © 2020-2023  润新知