Spring Cloud 使用 GateWay 作为服务网关

小咪咪 2022-11-03 00:45 108阅读 0赞

## GateWay简介 ##

Spring Cloud GateWay是Spring Cloud的⼀个全新项⽬，⽬标是取代Netflix Zuul，它基于Spring5.0+SpringBoot2.0+WebFlux（基于⾼性能的Reactor模式响应式通信框架Netty，异步⾮阻塞模型）等技术开发，性能⾼于Zuul，官⽅测试，GateWay是Zuul的1.6倍，旨在为微服务架构提供⼀种简单有效的统⼀的API路由管理⽅式。

Spring Cloud GateWay不仅提供统⼀的路由⽅式（反向代理）并且基于 Filter(定义过滤器对请求过滤，完成⼀些功能) 链的⽅式提供了⽹关基本的功能，例如：鉴权、流量控制、熔断、路径重写、⽇志监控等。

网关在架构中的位置，可以看到是请求进来由网关路由分配找到需要请求的服务，其中Nginx是用来做网管高可用的。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70]

Zuul1.x 阻塞式IO 2.x 基于Netty  
Spring Cloud GateWay天⽣就是异步⾮阻塞的，基于Reactor模型；

⼀个请求—>⽹关根据⼀定的条件匹配—匹配成功之后可以将请求转发到指定的服务  
地址；⽽在这个过程中，我们可以进⾏⼀些⽐较具体的控制（限流、⽇志、⿊⽩名  
单）

`路由（route`）： ⽹关最基础的部分，也是⽹关⽐较基础的⼯作单元。路由由⼀个ID、⼀个⽬标URL（最终路由到的地址）、⼀系列的断⾔（匹配条件判断）和Filter过滤器（精细化控制）组成。如果断⾔为true，则匹配该路由。

`断⾔（predicates）`：参考了Java8中的断⾔java.util.function.Predicate，开发⼈员可以匹配Http请求中的所有内容（包括请求头、请求参数等）（类似于nginx中的location匹配⼀样），如果断⾔与请求相匹配则路由。

`过滤器（filter）`：⼀个标准的Spring webFilter，使⽤过滤器，可以在请求之前  
或者之后执⾏业务逻辑。

Predicates断⾔就是我们的匹配条件，⽽Filter就可以理解为⼀个⽆所不能的拦截器，有了这两个元素，结合⽬标URL，就可以实现⼀个具体的路由转发。

Spring Cloud GateWay 帮我们内置了很多 Predicates功能，实现了各种路由匹配规则（通过 Header、请求参数等作为条件）匹配到对应的路由。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 1]

一般都会使用`请求路径正则匹配`

spring:
      cloud:
        gateway:
          routes: # 路由可以有多个
            - id: service-xxx-router # 我们⾃定义的路由 ID，保持唯⼀
              uri: lb://server-name
              predicates: #路由条件
                - Path=/xx/xxxx/**

## GateWay⼯作过程 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 2]

客户端向Spring Cloud GateWay发出请求，然后在GateWay Handler Mapping中找到与请求相匹配的路由，将其发送到GateWay Web Handler；Handler再通过指定的过滤器链来将请求发送到我们实际的服务执⾏业务逻辑，然后返回。过滤器之  
间⽤虚线分开是因为过滤器可能会在发送代理请求之前（pre）或者之后（post）执⾏业务逻辑。

Filter在“pre”类型过滤器中可以做参数校验、权限校验、流量监控、⽇志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改、⽇志的输出、流量监控等。

从过滤器⽣命周期（影响时机点）的⻆度来说，主要有两个pre和post：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 3]

从过滤器类型的⻆度 ,Spring Cloud GateWay的过滤器分为GateWayFilter和  
GlobalFilter两种。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 4]

一般情况下`GlobalFilter`全局过滤器是程序员使⽤⽐较多的过滤器；

可以用来自定义一些黑名单校验等

⾃定义GateWay全局过滤器时，我们实现Global Filter接⼝即可，通过全局过滤器可  
以实现⿊⽩名单、限流等功能。

@Slf4j
    @Component
    public class BlackListFilter implements GlobalFilter, Ordered { 
    
    
        private static List<String> blackList = new ArrayList<>();
    
        static { 
            blackList.add("0:0:0:0:0:0:0:1"); // 模拟本机地址
        }
    
    
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { 
            // 思路：获取客户端ip，判断是否在⿊名单中，在的话就拒绝访问，不在的话就放⾏
            // 从上下⽂中取出request和response对象
            ServerHttpRequest request = exchange.getRequest();
            ServerHttpResponse response = exchange.getResponse();
            // 从request对象中获取客户端ip
            String clientIp = request.getRemoteAddress().getHostString();
            // 拿着clientIp去⿊名单中查询，存在的话就决绝访问
            if (blackList.contains(clientIp)) { 
                // 决绝访问，返回
                response.setStatusCode(HttpStatus.UNAUTHORIZED); // 状态码
                log.debug("=====>IP:" + clientIp + " 在⿊名单中，将被拒绝访 问！");
                String data = "请求被禁止!";
                DataBuffer wrap = response.bufferFactory().wrap(data.getBytes());
                return response.writeWith(Mono.just(wrap));
    
            }
    
            // 合法请求，放⾏，执⾏后续的过滤器
            return chain.filter(exchange);
        }
    
        @Override
        public int getOrder() { 
            return 0; //越小优先级越高
        }
    }

GateWay 路由转发

这儿我提供了两个微服务 端口是 8082 的feign 微服务名是 `server-pruduce-8082-feign`调用8080 微服务名是`cloud-eureka-client-8081`的微服务

其中这两个接口中是有`/api/test`,`/api2/test`接口

导入依赖

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.6.RELEASE</version>
        </parent>
    
        <artifactId>server_pruduce_9000_getWay</artifactId>
    
        
        <dependencies>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-commons</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-webflux</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-logging</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            
            <dependency>
                <groupId>com.sun.xml.bind</groupId>
                <artifactId>jaxb-core</artifactId>
                <version>2.2.11</version>
            </dependency>
            <dependency>
                <groupId>javax.xml.bind</groupId>
                <artifactId>jaxb-api</artifactId>
            </dependency>
            <dependency>
                <groupId>com.sun.xml.bind</groupId>
                <artifactId>jaxb-impl</artifactId>
                <version>2.2.11</version>
            </dependency>
            <dependency>
                <groupId>org.glassfish.jaxb</groupId>
                <artifactId>jaxb-runtime</artifactId>
                <version>2.2.10-b140310.1920</version>
            </dependency>
            <dependency>
                <groupId>javax.activation</groupId>
                <artifactId>activation</artifactId>
                <version>1.1.1</version>
            </dependency>
            
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <optional>true</optional>
            </dependency>
      
        </dependencies>
    
    
        <dependencyManagement>
            
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Greenwich.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

#eureka server服务端口
    server:
      port: 9000
    spring:
      application:
        name: server-pruduce-9000-getWay # 应用名称，应用名称会在Eureka中作为服务名称
    
      cloud:
        inetutils:
          # 指定此客户端的ip
          default-ip-address: springcloud
          #getway配置
    
          ##### 动态路由设置时，uri以 lb: //开头（lb代表从注册中⼼获取服务），后⾯是需要转发到的服务名称
        gateway:
          routes: # 路由可以有多个
            - id: service-router1 # 我们⾃定义的路由 ID，保持唯⼀
              #uri: http://127.0.0.1:8082 # ⽬标服务地址 部署多实例） 动态路由：uri配置的应该是⼀个服务名称，⽽不应该是⼀个具体的服务实例的地址
    
              uri: lb://server-pruduce-8082-feign # ⽬标服务地址 部署多实例） 动态路由：uri配置的应该是⼀个服务名称，⽽不应该是⼀个具体的服务实例的地址
              # gateway⽹关从服务注册中⼼获取实例信息然后负载后路由
    
    
              predicates: #断⾔：路由条件，Predicate 接受⼀个输⼊参数，返回⼀个布尔值结果。该接⼝包含多种默 认⽅法来将 Predicate 组合成其他复杂的逻辑（⽐如：与，或，⾮）。
                - Path=/api/**
            - id: service-router2 # 我们⾃定义的路由 ID，保持唯⼀
              uri: lb://cloud-eureka-client-8081 #服务名不要用下划线
              predicates: #断⾔：路由条件，Predicate 接受⼀个输⼊参数，返回⼀个布尔值结果。该接⼝包含多种默 认⽅法来将 Predicate 组合成其他复杂的逻辑（⽐如：与，或，⾮）。
                - Path=/api2/**
              #filters:
                #- StripPrefix=1 #可以去掉url中的占位后转发路由 可以去掉api后转发
    
    
    
    #eureka配置
    eureka:
      instance:
        hostname: springcloud  # 当前eureka实例的主机名
        ip-address: springcloud
      client:
        service-url:
          prefer-ip-address: true
          lease-renewal-interval-in-seconds: 30
          # 租约到期，服务时效时间，默认值90秒,服务超过90秒没有发⽣⼼跳，服务注册中心会将服务从列表移除
          lease-expiration-duration-in-seconds: 90
          # 配置客户端所交互的Eureka Server的地址（Eureka Server集群中每一个Server其实相对于其它Server来说都是Client）
          # 集群模式下，defaultZone应该指向其它Eureka Server，如果有更多其它Server实例，逗号拼接即可
          defaultZone: http://127.0.0.1:8761/eureka,http://127.0.0.1:8762/eureka # 注册到集群汇总，多个用,拼接
        register-with-eureka: true # 集群模式下可以改成true
        fetch-registry: true # 集群模式下可以改成true

请求调用

![在这里插入图片描述][20210225231832475.png]

## GateWay⾼可⽤ ##

⽹关作为⾮常核⼼的⼀个部件，如果挂掉，那么所有请求都可能⽆法路由处理，因此我们需要做GateWay的⾼可⽤。

GateWay的⾼可⽤很简单：可以启动多个GateWay实例来实现⾼可⽤，在GateWay的上游使⽤Nginx或者F5等负载均衡设备进⾏负载转发以达到⾼可⽤。

#配置多个GateWay实例
    upstream gateway {
    server 127.0.0.1:9000;
    server 127.0.0.1:9001;
    }
    location / {
    proxy_pass http://gateway;
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70]: /images/20221024/7d756f11c873498fa6d518298c9ebf57.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 1]: /images/20221024/70d90041172f46c8a38c24fccfdeda27.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 2]: /images/20221024/bf4a276e1ae94c2580fec4d8a4caa5db.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 3]: /images/20221024/f79b59a58cfe41db85678ed0c8b51523.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODM2MTM0Nw_size_16_color_FFFFFF_t_70 4]: /images/20221024/ec48f049367c4a55a846115e3a4beb0a.png
[20210225231832475.png]: /images/20221024/3a7ba094a7b342a7a9cb3b97519cced3.png