Gateway 服务网关

Gateway 服务网关

1、gateway概述

什么是gateway

• gateway是在spring生态上构建的API网关服务，基于spring5、spring boot 2和 project reactor等技术。
• gateway旨在提供一种简单而有效的方式来对API进行路由，是的后台的服务不需暴露自己的地址，gateway提供了一些强大的功能，例如：熔断、限流、重试等。
• gateway是基于WebFlux框架实现的，而WebFlux框架的底层则使用了高性能的Reactor模式通信框架Netty。
• gateway基于异步非阻塞模型上进行开发的，高并发。
• gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关的基本功能，例如：安全、监控、日志和限流。
• 对后台服务的保护，即安全。
• 官网：Spring Cloud Gateway

**作用：**反向代理、鉴权、流量监控、熔断、日志监控等等。

架构图示：

gateway的三大核心：

• **动态路由：**地址映射

• **Predicate 【断言】：**是否符合条件

• **Filter 【过滤器】：**转发前后的过滤

gateway的工作流程：

• 客户端向gateway发出请求，然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到Gateway Web Handler。
• Handler再通过指定的过滤器来将请求发送到实际的服务执行业务逻辑，然后返回。
• 过滤器在其中进行必要的处理，在“pre”类型的过滤器有功能，如：参数校验、权限校验、流量监控等；在“post”类型的过滤器中可以做响应内容、响应头修改、日志的输出等等。
• 核心逻辑：路由转发+执行过滤器链。

2、配置gateway网关

为了方便包管理创建一个父工程

• pom

<dependencyManagement>
    <dependencies>
        <!--spring-boot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.6.5</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!--spring-cloud-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>2021.0.1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
         <!--spring-cloud-alibaba-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2021.0.1.0</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

子工程用作gateway网关

• pom

  <dependencies>
        <!--gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--eureka客户端-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <version>2.6.5</version>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

• yaml

server:
  port: 9527  #向外暴露的网关端口号，不需暴露微服务的地址，向外统一一个网关地址，通过网关来转发

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:   #网关配置
      discovery:
        locator:
          enabled: true   #开启负载均衡
      routes:
        - id: payment-routh              #微服务id，自定义保证唯一就行
          uri: http://localhost:8003  #微服务地址
          predicates:
            - Path=/payment/circuit/**    #微服务中的请求，**代表参数
  
        - id: payment-routh2
          uri: http://localhost:8003
          predicates:
            - Path=/payment/hystrix/timeout/**
            
            #用于负载均衡测试
        - id: payment-routh3
          uri: lb://CLOUD-PROVIDE-PAYMENT #负载均衡
          predicates:
            - Path=/payment/query/**
            
        - id: payment-routh3
          uri: lb://CLOUD-PROVIDE-PAYMENT   #负载均衡
          predicates:
            - Path=/payment/query/**


eureka:  #注册中心
  client:
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:7001/eureka
  instance:
    instance-id: gateway9527
    prefer-ip-address: true
    lease-renewal-interval-in-seconds: 2
    lease-expiration-duration-in-seconds: 4

• 路由映射配置代码方式 【二选一】

package com.qiumin.config;

import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.time.ZonedDateTime;

@Configuration
//路由映射配置代码方式配置
public class GateWayConfig {

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
        RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
        routes.route("path_com_qiumin",r->r.path("/guonei").uri("http://news.baidu.com/guonei")).build();
        return routes.build();
    }
}

• 全局过滤器

我们也可以在配置文件在通过filter来配置，当一般我们用我们自己的自定义路由配置,实现GlobalFilter, Ordered该两个接口，并实现方法

package com.qiumin.config;

import lombok.extern.slf4j.Slf4j;
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;

import java.util.Date;

@Component
@Slf4j
//我的全局过滤器配置类
public class MyLogGateWayGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("come in MyLogGateWayGlobalFilter："+new Date());
        String username = exchange.getRequest().getQueryParams().getFirst("username");
        if(username==null){
            log.info("用户名为null，非法用户！！！");
            exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

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

设置该过滤器后，我们的请求是处理必须要写的外还要带上username参数且不能为空，否则就会被挡

gateway过滤器生命周期两种：pre 【之前】、post 【之后】

种类两种：GatewayFilter、GlobalFilter

• 主启动类

package com.qiumin;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

@SpringBootApplication
@EnableEurekaClient  //服务注册中心
public class gatewayApplication9527 {
    public static void main(String[] args) {
        SpringApplication.run(gatewayApplication9527.class,args);
    }
}

• 启动我们的微服务，即我们通过gateway要转发到哪个服务上，在启动我们的gateway网关
• 通过访问网关发问我们的微服务
• http://localhost:9527/payment/query/1?username=qiumin

3、总结

• gateway内置了许多Route Predicate工厂，可配合使用
• 网关将内部服务包了一层，不需暴露内部微服务的地址，保证了安全
• 具体详细的配置可借鉴官网：Spring Cloud Gateway

qiumin