六：SpringCloud Gateway服务网关(GlobalFilter全局 GatewayFilter 局部配置)

晓东_1353434

已于 2023-07-25 08:41:18 修改

阅读量646

点赞数 1

分类专栏： SpringCloud 文章标签： spring cloud gateway java

于 2023-07-23 18:11:23 首次发布

本文链接：https://blog.csdn.net/qq_33878489/article/details/131881948

版权

SpringCloud 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

1.基本概念

1.1.Zuul与Gateway zuul1使用BIO,Zuul2和Gateway使用AIO异步非阻塞io模型性能更好

Zuul是Netflix的开源项目，Spring Cloud将其收纳成为自己的一个子组件。zuul用的是多线程阻塞模型，它本质上就是一个同步 Servlet，这样的模型比较简单，他都问题是多线程之间上下文切换是有开销的，线程越多开销就越大。线程池数量固定意味着能力接受的请求数固定，当后台请求变慢，面对大量的请求，线程池中的线程容易被耗尽，后续的请求会被拒绝。

在Zuul 2.0中它采用了 Netty 实现异步非阻塞编程模型，异步非阻塞模式对线程的消耗比较少，对线程上线文切换的消耗也比较小，并且可以接受更多的请求。它的问题就是线程模型比较复杂，要求深究底层原理需要花一些功夫。

Spring Cloud Gateway是Spring Cloud自己的产物，基于Spring 5 和Spring Boot 2.0 开发，Spring Cloud Gateway的出现是为了代替zuul,在Spring Cloud 高版本中没有对zuul 2.0进行集成，SpringCloud Gateway使用了高性能的Reactor模式通信框架Netty。

Spring Cloud Gateway 的目标，不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控/指标，和限流。

所以说其实Gateway和zuul 2.0差别不是特别大，都是采用Netty高性能通信框架，性能都挺不错。

1.2.Spring Cloud Gataway的特点

在Spring Cloud官方定义了SpringCloud Gateway 的如下特点：

基于 Spring 5，Project Reactor , Spring Boot 2.0
默认集成 Hystrix 断路器
默认集成 Spring Cloud DiscoveryClient
Predicates 和 Filters 作用于特定路由，易于编写的 Predicates 和 Filters
支持动态路由、限流、路径重写

1.3.Spring Cloud Gataway的核心概念

Spring Cloud Gataway有几个核心组成：

Filter（过滤器）：

Spring Cloud Gateway的Filter和Zuul的过滤器类似，可以在请求发出前后进行一些业务上的处理 ,这里分为两种类型的Filter，分别是Gateway Filter网关filter和Global Filter全局Filter, 他们的区别在后续会讲到。

Route（路由）：

网关配置的基本组成模块，和Zuul的路由配置模块类似。一个Route模块由一个 ID，一个目标 URI，一组断言和一组过滤器定义。如果断言为真，则路由匹配，目标URI会被访问。说白了就是把url请求路由到对应的资源(服务)，或者说是一个请求过来Gateway应该怎么把这个请求转发给下游的微服务，转发给谁。

Predicate（断言）：

这是一个 Java 8 的 Predicate，可以使用它来匹配来自 HTTP 请求的任何内容，例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。简单理解就是处理HTTP请求的匹配规则，在什么样的请情况下才能命中资源继续访问。

1.4.Spring Cloud Gateway的工作方式

Spring Cloud Gateway 的工作原理跟 Zuul 的差不多，最大的区别就是 Gateway 的 Filter 只有 pre 和 post 两种，下面是官方的执行流程图：

客户端向Spring Cloud Gateway发出请求。如果网关处理程序映射确定请求与路由匹配，则将其发送到网关Web处理程序。该处理程序通过特定于请求的过滤器链来运行请求。筛选器由虚线分隔的原因是，筛选器可以在发送代理请求之前和之后运行逻辑。所有“前置”过滤器逻辑均被执行。然后发出代理请求。发出代理请求后，将运行“后”过滤器逻辑。

2. Spring Cloud Gateway入门

1.导入依赖 gateway 和 eureka-client

 <dependencies>
        <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>
    </dependencies>

2. 启动类

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

3. yml

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:10010/eureka/
  instance:
    prefer-ip-address: true  #使用ip注册到Eureka
    instance-id: gateway-server  #指定客户端实例的ID
spring:
  application:
    name: gateway-server
  cloud:
    gateway:
      discovery:
        locator:
          enabled: false #开放服务名访问方式 -禁用服务名访问
          lower-case-service-id: true #服务名小写
      routes:
        - id : user-server #指定服务名
          uri: lb://user-server #去注册中心找这个服务名 -LoadBalanced负载均衡
          predicates:    #断言，匹配访问的路径
            - Path=/services/user/**	#服务访问路径
          filters:
            - StripPrefix=2	#请求转发的时候会去掉 /user访问路径
server:
  port: 10060

4.测试访问gateway网关服务去掉两层路径后最终访问到UserController的（"user"/1）

http://localhost:10060/services/user/user/1

3. Predicate断言工厂 - 断言工厂就是用来判断http请求的匹配方式

Spring Cloud Gateway将路由作为Spring WebFlux HandlerMapping基础架构的一部分进行匹配。Spring Cloud Gateway包括许多内置的路由断言工厂。所有这些断言都与HTTP请求的不同属性匹配。您可以将多个路由断言工厂与逻辑and语句结合使用。

在Spring Cloud Gateway中，针对不同的场景内置的路由断言工厂，比如

根据path断言-Path Route Predicate Factory(重要)

spring:
  application:
    name: gateway-server
  cloud:
    gateway:
      discovery:
        locator:
          enabled: false #开放服务名访问方式 -禁用服务名访问
          lower-case-service-id: true #服务名小写
      routes:
        - id : user-server #指定服务名
          uri: lb://user-server #去注册中心找这个服务名 -LoadBalanced负载均衡
          predicates:    #断言，匹配访问的路径
            - Path=/services/user/**	#服务访问路径
          filters:
            - StripPrefix=2	#请求转发的时候会去掉 /user访问路径

4. Gateway 的 Filter 过滤器

GatewayFilter 配置某一些 | GlobalFilter 配置全局

1. GatewayFilter

内置GatewayFilter配置

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue

自定义Gateway Filter ---获取每一次请求的耗时

1. RequestTimeFilter实现GatewayFilter过滤接口, Ordered排序接口重写filter和getOrder()方法

public class RequestTimeFilter implements GatewayFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //开始时间
        long startTime = System.currentTimeMillis();
        return chain.filter(exchange).then(
                Mono.fromRunnable(() -> {
                    //结束时间
                    Long endTime = System.currentTimeMillis();
                    long diff = endTime - startTime;
                    System.out.println("当前请求"+exchange.getRequest().getURI().getPath()+"，耗时"+ diff);
                })
        );
    }
    @Override
    public int getOrder() {
        return 0;
    }
}

2. 配置类配置对哪一个路径要经过过滤器

@Configuration
public class FilterConfig {
    //配置Filter作用于那个访问规则上
    @Bean
    public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes().route(r -> r.path("/services/user/**")
            //去掉2个前缀
            .filters(f -> f.stripPrefix(2)
            .filter(new RequestTimeFilter())
            .addResponseHeader("X-Response-test", "test"))
            .uri("lb://user-server")
            .order(1)
            .id("test-RequestTimeFilter")
        ).build();
    }
}

2. GlobalFilter 配置全局-> 登录检查

定义LoginCheckGlobalFilter类实现GlobalFilter接口，Ordered接口 交给spring管理

/**
 * 登录检查
 */
@Component
public class LoginCheckGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        List<String> token = request.getHeaders().get("token");
        if (token == null || token.size() <=0){
            ServerHttpResponse response = exchange.getResponse();
            DataBuffer buffer = null;
            try {
                byte[] bytes = "请先登录".getBytes("utf-8");
                buffer = response.bufferFactory().wrap(bytes);

                //设置完成相应，不会继续执行后面的filter
                //response.setComplete();
                response.setStatusCode(HttpStatus.UNAUTHORIZED);
                response.getHeaders().add("Content-Type","application/json;charset=UTF-8");
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            }
            //把结果写给客户端
            return response.writeWith(Mono.just(buffer));
        }
        return chain.filter(exchange); // 否则继续执行
    }

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

5.Gateway跨域配置

spring:
  cloud:
    globalcors: #跨域配置
            cors-configurations:
              '[/**]':
                allowedOrigins: "https://docs.spring.io" #允许的站点
                allowedMethods:	#允许的请求方式
                  - GET
                  - POST
                  - DELETE
                  - PUT
                  - HEAD
                  - CONNECT
                  - TRACE
                  - OPTIONS
                allowHeaders:	#允许的请求头
                  - Content-Type

6.Gateway超时

Gateway中的全局超时设置

spring:
  cloud:
    gateway:
      httpclient:
        connect-timeout: 1000
        response-timeout: 5s

指定路由超时配置：一般不用用全局

spring:
  cloud:
    gateway:
      routes:
      - id: per_route_timeouts
        uri: https://example.org
        predicates:
          - name: Path
            args:
              pattern: /delay/{timeout}
        metadata:
          response-timeout: 200
          connect-timeout: 200

晓东_1353434

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
六：SpringCloud Gateway服务网关(GlobalFilter全局 GatewayFilter 局部配置)

Spring Cloud Gateway是Spring Cloud自己的产物，基于Spring 5 和Spring Boot 2.0 开发，Spring Cloud Gateway的出现是为了代替zuul,在Spring Cloud 高版本中没有对zuul 2.0进行集成，SpringCloud Gateway使用了高性能的Reactor模式通信框架Netty。线程池数量固定意味着能力接受的请求数固定，当后台请求变慢，面对大量的请求，线程池中的线程容易被耗尽，后续的请求会被拒绝。
复制链接

扫一扫