signed

QiShunwang

“诚信为本、客户至上”

9、GateWay⽹关组件介绍及应用

2020/12/29 22:02:18   来源:

目录

  • 一、GateWay简介
    • (一)什么是GateWay
    • (二)GateWay核⼼概念
    • (三)GateWay⼯作过程
  • 二、GateWay应⽤实例
    • (一)pom
    • (二)application.yml
    • (三)配置启动类并启动
    • (四)测试
    • (五)动态路由详解
  • 三、GateWay过滤器
    • (一)两种过滤器介绍
    • (二)Gateway Filter示例
    • (三)GlobalFilter示例:自定义全局过滤器
      • 1、自定义类并实现接口
      • 2、测试

一、GateWay简介

(一)什么是GateWay

GateWay–>Spring Cloud 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(定义过滤器对请求过滤,完成⼀些功能) 链的⽅式提供了⽹关基本的功能,例如:鉴权、流量控制、熔断、路径重写、⽇志监控等。
在这里插入图片描述

(二)GateWay核⼼概念

  1. 路由(route): ⽹关最基础的部分,也是⽹关⽐较基础的⼯作单元。路由由⼀个ID、⼀个⽬标URL(最终路由到的地址)、⼀系列的断⾔(匹配条件判断)和Filter过滤器(精细化控制)组成。如果断⾔为true,则匹配该路由。
  2. 断⾔(predicates):参考了Java8中的断⾔java.util.function.Predicate,开发⼈员可以匹配Http请求中的所有内容(包括请求头、请求参数等)(类似于nginx中的location匹配⼀样),如果断⾔与请求相匹配则路由。
  3. 过滤器(filter):⼀个标准的Spring webFilter,使⽤过滤器,可以在请求之前或者之后执⾏业务逻辑。

来⾃官⽹的⼀张图

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

(三)GateWay⼯作过程

GateWay核⼼逻辑:路由转发+执⾏过滤器链

在这里插入图片描述
在这里插入图片描述

二、GateWay应⽤实例

创建⼯程并导⼊依赖(端口号9002
注意:GateWay不需要使⽤web(starter-web)模块,它引⼊的是WebFlux(web-flux。类似于SpringMVC)

配置了GateWay之后,我们不再需要访问具体的服务地址。而是访问GateWay应⽤的地址

// 原来的地址
> localhost:8098/autoDeliver/checkState/1545132
> localhost:8082/resume/openstate/1545132

// 配置了GateWay之后的地址(需要与application.yml中的配置相匹配)
> localhost:9002/autoDeliver/checkState/1545132
> localhost:9002/resume/openstate/1545132

(一)pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <artifactId>lagou-cloud-gateway-server-9002</artifactId>

    <!--spring boot 父启动器依赖-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <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>
        <!--GateWay 网关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--引入webflux-->
        <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>
        <!--lombok工具-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.4</version>
            <scope>provided</scope>
        </dependency>

        <!--引入Jaxb,开始-->
        <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>
        <!--引入Jaxb,结束-->

        <!-- Actuator可以帮助你监控和管理Spring Boot应用-->
        <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>

        <!--链路追踪-->
        <!--<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>-->
    </dependencies>

    <dependencyManagement>
        <!--spring cloud依赖版本管理-->
        <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>

    <build>
        <plugins>
            <!--编译插件-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>11</source>
                    <target>11</target>
                    <encoding>utf-8</encoding>
                </configuration>
            </plugin>
            <!--打包插件-->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

(二)application.yml

server:
  port: 9002
# 添加注册到eureka的配置
eureka:
  client:
    service-url:
      defaultZone: http://LagouCloudEurekaServerA:8762/eureka,http://LagouCloudEurekaServerB:8763/eureka
  instance:
    prefer-ip-address: true
    instance-id: ${spring.cloud.client.ip-address}:${spring.application.name}:${server.port}@project.version@
spring:
  application:
    name: lagou-cloud-gateway-server
  cloud:
    gateway:
      routes:  # 路由可以有多个
        - id: service-autodeliver-router # 我们自定义的路由 ID,保持唯一
          # uri: http://127.0.0.1:8096  # 目标服务地址  自动投递微服务(部署多实例)
          # 动态路由设置时,uri以 lb: //开头(lb代表从注册中⼼获取服务),后⾯是需要转发到的服务名称
          uri: lb://lagou-service-autodeliver # gateway网关从服务注册中心获取实例信息然后负载后路由
          # predicates 断言:路由条件,Predicate 接受一个输入参数,返回一个布尔值结果。该接口包含多种默 认方法来将 Predicate 组合成其他复杂的逻辑(比如:与,或,非)。
          predicates:
            - Path=/autoDeliver/**
        - id: service-resume-router
          uri: lb://lagou-service-resume
          predicates:
            - Path=/resume/**

(三)配置启动类并启动

package com.lagou.edu;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

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

(四)测试

在这里插入图片描述
在这里插入图片描述

(五)动态路由详解

GateWay⽀持⾃动从注册中⼼中获取服务列表并访问,即所谓的动态路由
实现步骤如下:

  1. pom.xml中添加注册中⼼客户端依赖(因为要获取注册中心服务列表,eureka客户端已经引⼊)
  2. 动态路由配置

uri: lb://lagou-service-autodeliver

即。uri: lb://需要转发到的服务名称。
lb代表从注册中⼼获取服务

三、GateWay过滤器

(一)两种过滤器介绍

在这里插入图片描述
在这里插入图片描述

(二)Gateway Filter示例

如Gateway Filter可以去掉url中的占位后转发路由,⽐如

application.yml中添加filters配置

- id: service-resume-router
  uri: lb://lagou-service-resume
  predicates:
    - Path=/resume/**
  filters:
    # 【1】代表【resume】,即把【http://127.0.0.1:8081/resume/openstate/1545132】 中的【resume】去掉,
    # 变成【http://127.0.0.1:8081/openstate/1545132】
    - StripPrefix=1 # 可以去掉resume之后转发

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

(三)GlobalFilter示例:自定义全局过滤器

GlobalFilter全局过滤器是程序员使⽤⽐较多的过滤器,我们主要讲解这种类型

1、自定义类并实现接口

package com.lagou.edu.filter;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.util.*;

/**
 * 定义全局过滤器,会对所有路由⽣效
 */
@Component
public class BlackListFilter implements GlobalFilter, Ordered {
    // 模拟黑名单(实际可以去数据库或者redis中查询)
    private static List<String> blackList = new ArrayList<>();

    static {
        blackList.add("0:0:0:0:0:0:0:1");  // 模拟本机地址(IPV6)
    }
    /**
     * 过滤器核心方法
     * @param exchange 封装了request和response对象的上下文
     * @param chain 网关过滤器链(包含全局过滤器和单路由过滤器)
     * @return
     */
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();

        // 从request对象中获取客户端ip
        String clientIp = request.getRemoteAddress().getHostString();
        // 拿着clientIp去黑名单中查询,存在的话就决绝访问
        if(blackList.contains(clientIp)) {
            // 决绝访问,返回提示信息
            response.setStatusCode(HttpStatus.UNAUTHORIZED);// 状态码
            System.out.println("=====>IP:" + clientIp + " 在黑名单中,将被拒绝访问!");
            String data = "Request be denied!";
            // TODO 使用response.writeWith返回提示信息
            DataBuffer wrap = response.bufferFactory().wrap(data.getBytes());
            return response.writeWith(Mono.just(wrap));
        }
        // 合法请求,放行,执行后续的过滤器
        return chain.filter(exchange);
    }

    /**
     * 返回值表示当前过滤器的顺序(优先级),数值越小,优先级越高
     * @return
     */
    @Override
    public int getOrder() {
        return 0;
    }
}

2、测试

在这里插入图片描述