SpringCloud-07-Gateway网关路由

最新推荐文章于 2024-03-14 18:07:04 发布

Java战5渣

最新推荐文章于 2024-03-14 18:07:04 发布

阅读量402

点赞数

分类专栏：微服务文章标签： spring 5 spring cloud gateway

本文链接：https://blog.csdn.net/weixin_44010763/article/details/119738768

版权

微服务专栏收录该内容

8 篇文章 0 订阅

订阅专栏

SpringCloud-01-微服务的起源
 SpringCloud-02-SpringCloud入门
 SpringCloud-03-Eureka服务管理
 SpringCloud-04-Ribbon负载均衡
 SpringCloud-05-Hystrix熔断器
 SpringCloud-06-Feign声明式WebService客户端
 SpringCloud-07-Gateway网关路由

8. Gateway网关

8.1 Gateway简介

SpringCloud Gateway是Spring官网基于Spring 5.0、 Spring Boot 2.0、Project Reactor等技术开发的网关服务。

SpringCloud Gateway基于Filter链提供网关基本功能：安全、监控／埋点、限流等。
SpringCloud Gateway为微服务架构提供简单、有效且统一的API路由管理方式。
SpringCloud Gateway是替代Netflix Zuul的一套解决方案。

Netflix Zuul也是一种微服务网关技术，但是已不再更新。

SpringCloud Gateway组件的核心是一系列的过滤器，通过这些过滤器可以将客户端发送的请求转发（路由）到对应的微服务。 SpringCloud Gateway是加在整个微服务最前沿的防火墙和代理器，隐藏微服务结点IP端口信息，从而加强安全保护。SpringCloud Gateway本身也是一个微服务，需要注册到Eureka服务注册中心。

网关的核心功能是：过滤和路由。

8.2 Gateway工作原理

GateWay加入微服务之后的架构如下：

在这里插入图片描述

不管是来自于客户端（PC或移动端）的请求，还是服务内部调用。一切对服务的请求都可经过网关，然后再由网关来实现鉴权、动态路由等等操作。Gateway就是我们服务的统一入口。

8.3 Gateway核心概念

路由（route）

路由信息的组成：由一个ID、一个目的URL、一组断言工厂、一组Filter组成。

如果路由断言为真，说明请求URL和配置路由匹配。
断言（Predicate）

SpringCloud Gateway中的断言函数输入类型是Spring 5.0框架中的ServerWebExchange。

SpringCloud Gateway的断言函数允许开发者去定义匹配来自于HTTP Request中的任何信息比如请求头和参数。
过滤器（Filter）

一个标准的Spring WebFilter。 SpringCloud Gateway中的Filter分为两种类型的Filter，分别是 Gateway Filter和Global Filter。

过滤器Filter将会对请求和响应进行修改处理。

8.4 Gateway入门案例

需求：通过网关系统user-gateway将包含有 /user 的请求路由到 user-service 中的 /user 请求。

8.4.1 创建子工程

在springcloud项目的基础上搭建子工程模块，并引入Gateway依赖和Eureka客户端依赖：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<artifactId>springcloud</artifactId>
		<groupId>com.lijinghua</groupId>
		<version>0.0.1-SNAPSHOT</version>
	</parent>
	<groupId>com.lijinghua</groupId>
	<artifactId>user-gateway</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>user-gateway</name>
	<description>Demo project for Spring Boot</description>
	<properties>
		<java.version>1.8</java.version>
	</properties>
	<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>
	</dependencies>
</project>

8.4.2 编写全局配置文件

这里编写properties.yml：

#Server Config
server:
  port: 8083 #服务端口

#Spring Config
spring:
  application:
    name: user-gateway # 服务名称
  cloud:
    gateway:
      # 配置网关路由
      routes:
        # 路由id，可以随意写
        - id: user-service-route
          # 真实地址，即代理的服务地址
#          uri: lb://user-service
          uri: http://127.0.0.1:8080
          # 路由断言，可以配置映射路径，当我们断言为真，就会去映射到配置的uri下去访问
          # 这里是： http://127.0.0.1:8083/user/2 -> http://127.0.0.1:8080/user/2
          predicates:
            - Path=/user/**

#Eureka Config
eureka:
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    # 续约间隔，默认30秒
    lease-renewal-interval-in-seconds: 5
    # 服务失效时间，默认90秒
    lease-expiration-duration-in-seconds: 5
  client:
    # EurekaServer的地址
    service-url:
      defaultZone: http://127.0.0.1:10000/eureka/,http://127.0.0.1:10001/eureka/,http://127.0.0.1:10002/eureka/

8.4.3 启动类开启服务自动注册

添加 @EnableDiscoveryClient 注解：

@SpringBootApplication //标注启动类
@EnableDiscoveryClient //标注eureka客户端，开启eureka自动注册发现功能
public class UserGatewayApplication {

	public static void main(String[] args) {
		SpringApplication.run(UserGatewayApplication.class, args);
	}

}

br/>

8.4.4 测试

在这里插入图片描述

8.5 面向服务的路由

在刚才的路由规则中，我们写死了路径对应的服务地址，如果同一服务有多个实例的话，这样做显然不合理。应该根据服务的名称，去Eureka注册中心查找服务对应的所有实例列表，然后进行动态路由！

#Server Config
server:
  port: 8083 #服务端口

#Spring Config
spring:
  application:
    name: user-gateway # 服务名称
  cloud:
    gateway:
      # 配置网关路由
      routes:
        # 路由id，可以随意写
        - id: user-service-route
          # 真实地址，即代理的服务地址
          uri: lb://user-service
#          uri: http://127.0.0.1:8080
          # 路由断言，可以配置映射路径，当我们断言为真，就会去映射到配置的uri下去访问
          predicates:
            - Path=/user/**

#Eureka Config
eureka:
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    # 续约间隔，默认30秒
    lease-renewal-interval-in-seconds: 5
    # 服务失效时间，默认90秒
    lease-expiration-duration-in-seconds: 5
  client:
    # EurekaServer的地址
    service-url:
      defaultZone: http://127.0.0.1:10000/eureka/,http://127.0.0.1:10001/eureka/,http://127.0.0.1:10002/eureka/

路由配置中uri所用的协议为lb时（以uri: lb://user-service为例），gateway将使用 LoadBalancerClient把user-service通过Eureka解析为实际的主机和端口，并进行ribbon负载均衡。

在这里插入图片描述

8.6 路由前缀

客户端的请求地址与微服务的服务地址如果不一致的时候，可以通过配置路径过滤器实现路径前缀的添加和去除。

8.6.1 添加前缀

例如，http://127.0.0.1:8083/2 --> http://127.0.0.1:8080/user/2 ，添加了前缀路径 /user 。

在gateway中可以通过配置路由的过滤器PrefixPath，实现映射路径中地址的添加：

#Server Config
server:
  port: 8083 #服务端口

#Spring Config
spring:
  application:
    name: user-gateway # 服务名称
  cloud:
    gateway:
      # 配置网关路由
      routes:
        # 路由id，可以随意写
        - id: user-service-route
          # 真实地址，即代理的服务地址
          uri: lb://user-service
#          uri: http://127.0.0.1:8080
          # 路由断言，可以配置映射路径，当我们断言为真，就会去映射到配置的uri下去访问
          predicates:
            - Path=/**
          filters:
            # 添加请求路径的前缀
            - PrefixPath=/user

#Eureka Config
eureka:
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    # 续约间隔，默认30秒
    lease-renewal-interval-in-seconds: 5
    # 服务失效时间，默认90秒
    lease-expiration-duration-in-seconds: 5
  client:
    # EurekaServer的地址
    service-url:
      defaultZone: http://127.0.0.1:10000/eureka/,http://127.0.0.1:10001/eureka/,http://127.0.0.1:10002/eureka/

在这里插入图片描述

8.6.2 去除前缀

例如，http://127.0.0.1:8083/pre/1 --> http://127.0.0.1:8080/user/1 ，去除了前缀路径 /pre，再加上/user。

#Server Config
server:
  port: 8083 #服务端口

#Spring Config
spring:
  application:
    name: user-gateway # 服务名称
  cloud:
    gateway:
      # 配置网关路由
      routes:
        # 路由id，可以随意写
        - id: user-service-route
          # 真实地址，即代理的服务地址
          uri: lb://user-service
#          uri: http://127.0.0.1:8080
          # 路由断言，可以配置映射路径，当我们断言为真，就会去转发到配置的uri下去访问
          predicates:
            - Path=/pre/**
          filters:
            # 添加请求路径的前缀
            - StripPrefix=1 # 过滤掉第一个路径：/pre，如果有多个可以指定过滤第几个
            - PrefixPath=/user


#Eureka Config
eureka:
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    # 续约间隔，默认30秒
    lease-renewal-interval-in-seconds: 5
    # 服务失效时间，默认90秒
    lease-expiration-duration-in-seconds: 5
  client:
    # EurekaServer的地址
    service-url:
      defaultZone: http://127.0.0.1:10000/eureka/,http://127.0.0.1:10001/eureka/,http://127.0.0.1:10002/eureka/

注意：需要管理过滤器的顺序，先去除了/pre，再添加/user，才可以。

在这里插入图片描述

8.7 Gateway的过滤器

接口GatewayFilterFactory有个实现了它的抽象类AbstarctGatewayFilterFactory，这个类由很多个实现类：

在这里插入图片描述

8.7.1 Gateway的常见过滤器

Gateway作为网关的其中一个重要功能，就是实现请求的鉴权。而这个动作往往是通过网关提供的过滤器来实现的。前面的路由前缀中的功能也是使用过滤器实现的。

Gateway自带过滤器有几十个，常见自带过滤器有：

这些自带的过滤器可以和8.6小节中路由前缀的用法类似。

上述图片来源于参考的文章：Gateway过滤器

8.7.2 生命周期

SpringCloud Gateway 的 Filter 的生命周期也类似Spring MVC的拦截器有两个：“pre” 和 “post”。

“pre”和 “post”分别会在请求被执行前调用和被执行后调用：

在这里插入图片描述

8.7.3 使用场景

请求鉴权：一般 GatewayFilterChain 执行filter方法前，如果发现没有访问权限，直接就返回空。
异常处理：一般 GatewayFilterChain 执行filter方法后，记录异常并返回。
服务调用时长统计： GatewayFilterChain 执行filter方法前后根据时间统计。

8.7.4 全局默认过滤器

局部过滤器

通过 spring.cloud.gateway.routes.filters 配置在具体路由下，只作用在当前路由上。
全局过滤器
- 方式一：实现 GlobalFilter 接口
  
  不需要在配置文件中配置，作用在所有的路由上。
- 方式二：配置spring.cloud.gateway.default-filters
  
  如果配置spring.cloud.gateway.default-filters 上会对所有路由生效也算是全局的过滤器，但是这些过滤器的实现上和局部过滤器是一样的，都是要实现GatewayFilterFactory接口。

这些自带的过滤器可以和8.6小节中路由前缀的用法类似，但是之前只是针对某个路由过滤的，我们也可以将这些过滤器配置成全局过滤器(这里以方式一为例)，即可以对所有路由生效：

#Server Config
server:
  port: 8083 #服务端口

#Spring Config
spring:
  application:
    name: user-gateway # 服务名称
  cloud:
    gateway:
      # 配置网关路由
      routes:
        # 路由id，可以随意写
        - id: user-service-route
          # 真实地址，即代理的服务地址
          uri: lb://user-service
#          uri: http://127.0.0.1:8080
          # 路由断言，可以配置映射路径，当我们断言为真，就会去映射到配置的uri下去访问
          predicates:
            - Path=/pre/**
          filters:
            # 添加请求路径的前缀
            - StripPrefix=1 # 过滤掉第一个路径：/pre
            - PrefixPath=/user
      # 全局过滤器，对所有路由都生效
      default-filters:
        - AddResponseHeader=X-Response-Foo, Bar
        - AddResponseHeader=myname,lijinghua

#Eureka Config
eureka:
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    # 续约间隔，默认30秒
    lease-renewal-interval-in-seconds: 5
    # 服务失效时间，默认90秒
    lease-expiration-duration-in-seconds: 5
  client:
    # EurekaServer的地址
    service-url:
      defaultZone: http://127.0.0.1:10000/eureka/,http://127.0.0.1:10001/eureka/,http://127.0.0.1:10002/eureka/

在这里插入图片描述

8.7.5 自定义过滤器

8.7.5.1 自定义局部过滤器

例如，在我们自定义的局部过滤器（MyDefineGatewayFilterFactory）中，将http://localhost:8083/pre/3?name=lijinghua中的参数name的值获取到并输出到控制台。并且参数名是可变的，需要可以通过配置过滤器的时候指定参数名。在application.yml中对某个路由配置过滤器，该过滤器可以在控制台输出配置文件中指定名称的请求参数的值。

8.7.5.1.1 编写自定义Filter

@Component
public class MyDefineGatewayFilterFactory extends
        AbstractGatewayFilterFactory<MyDefineGatewayFilterFactory.Config> {

    private static final String PARAM_NAME = "param";

    public MyDefineGatewayFilterFactory() {
        super(Config.class);
    }

    @Override
    public GatewayFilter apply(Config config) {
        return (exchange, chain) -> {
            // http://localhost:8083/user/3?name=lijinghua config.param ==> name
            // 获取请求参数中param对应的参数名 的参数值
            ServerHttpRequest request = exchange.getRequest();
            if (request.getQueryParams().containsKey(config.param)) {
                request.getQueryParams().get(config.param).
                        forEach(value -> System.out.printf("------------局部过滤器--------%s = %s----- - ", config.param, value));
            }
            return chain.filter(exchange);
        };
    }

        @Override
        public List<String> shortcutFieldOrder () {
            return Arrays.asList("param");
        }

        //读取过滤器配置的参数
        public static class Config {
            //对应在配置过滤器的时候指定的参数名
            private String param;

            public String getParam() {
                return param;
            }

            public void setParam(String param) {
                this.param = param;
            }
        }
    }

注意：自定义过滤器的命名应该为：***GatewayFilterFactory，可以参考Gateway常见的过滤器实现源码。

8.7.5.1.2 修改application.yml

#Server Config
server:
  port: 8083 #服务端口

#Spring Config
spring:
  application:
    name: user-gateway # 服务名称
  cloud:
    gateway:
      # 配置网关路由
      routes:
        # 路由id，可以随意写
        - id: user-service-route
          # 真实地址，即代理的服务地址
          uri: lb://user-service
#          uri: http://127.0.0.1:8080
          # 路由断言，可以配置映射路径，当我们断言为真，就会去映射到配置的uri下去访问
          predicates:
            - Path=/pre/**
          filters:
            # 添加请求路径的前缀
            - StripPrefix=1 # 过滤掉第一个路径：/pre
            - PrefixPath=/user
            - MyDefine=name # 自定义局部过滤器
      # 全局过滤器，对所有路由都生效
      default-filters:
        - AddResponseHeader=X-Response-Foo, Bar
        - AddResponseHeader=myname,lijinghua

#Eureka Config
eureka:
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1
    # 续约间隔，默认30秒
    lease-renewal-interval-in-seconds: 5
    # 服务失效时间，默认90秒
    lease-expiration-duration-in-seconds: 5
  client:
    # EurekaServer的地址
    service-url:
      defaultZone: http://127.0.0.1:10000/eureka/,http://127.0.0.1:10001/eureka/,http://127.0.0.1:10002/eureka/

8.7.5.1.3 测试

在这里插入图片描述

8.7.5.2 自定义全局过滤器

例如，在编写的全局过滤器（MyDefiGlobalFilter）中，检查请求中是否携带token请求头。如果token请求头存在则放行；如果token为空或者不存在则设置返回的状态码为401，即未授权，也不再执行下去。

8.7.5.2.1 编写自定义Filter

@Component
public class MyDefineGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        System.out.println("--------------全局过滤器MyGlobalFilter------------------");
        String token = exchange.getRequest().getHeaders().getFirst("token");
        if (StringUtils.isBlank(token)) {
            //设置响应状态码为未授权
            exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
            return exchange.getResponse().setComplete();
        }
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {//值越小越先执行
        return 1;
    }
}

这种方式无需配置。

8.7.5.2.2 测试

在这里插入图片描述

8.8 负载均衡与熔断

Gateway中默认就已经集成了Ribbon负载均衡和Hystrix熔断机制。但是所有的超时策略都是走的默认值，比如熔断超时时间只有1S，很容易就触发了，因此建议手动进行配置。

这里的使用和之前的配置使用没有什么区别，忘记了的话可参考本系列的前三篇文章：
（1）SpringCloud-04-Ribbon负载均衡、
（2）SpringCloud-05-Hystrix熔断器、
（3）SpringCloud-06-Feign声明式WebService客户端

常见问题：

当服务出现了问题时（线程池已满？超时？），我们需要进行服务降级与服务熔断；

服务熔断的相关配置就不在这里多说了，参考上面给出的文章链接，这里只给出了如何在Gateway中调用回调函数。
当某个服务有多个实例时，某个实例宕机后，有时候 Gateway 因为还没有收到 Eureka Server 的通知，不知道这个实例访问失败是因为出现了什么问题（线程池已满？超时？宕机？）。这时，我们可以设置服务的重试：

# 全局过滤器
default-filters:
  - name: Hystrix # 服务熔断
    args:
      name: default
      fallbackUri: forward:/defaultFallback #服务降级时转发到“/defaultFallback”这个请求去处理，我们可以在一个controller中设置这么一个处理方法
  - name: Retry # 服务重试
    args:
      retries: 1 #默认3次，注意Hystrix的超时时间>ribbon的读取超时时间和建立连接的超时时间，不然就没机会重试了
      series:
        - SERVER_ERROR #哪些状态码才会进行重试，默认值是 SERVER_ERROR，取值参考：org.springframework.http.HttpStatus.Series
      methods:
        - GET
      exceptions:
        - java.io.IOException #默认值是 java.io.IOException

8.9 Gateway跨域问题

一般网关都是所有微服务的统一入口，必然在被调用的时候会出现跨域问题。

在js请求访问中，如果访问的地址与当前服务器的域名、ip或者端口号不一致则称为跨域请求。若不解决则不能获取到对应地址的返回结果。在访问SpringCloud Gateway网关服务器的时候，如果出现跨域问题，可以在网关服务器中通过配置解决，允许哪些服务是可以跨域请求的。

具体配置如下：

spring:
  cloud:
	gateway:
	  #跨域配置
	  globalcors: 
		corsConfigurations:
		  # 配置生效的路径
		  '[/**]':
			#allowedOrigins允许请求的源路径: *或者下面的都可以，*表示全部
			allowedOrigins:
			  - "http://docs.spring.io"
			#允许请求的方式
			allowedMethods:
			  - GET

上述配置表示：可以允许来自 http://docs.spring.io 的get请求方式获取服务数据。点击可以参考官方文档的具体说明。

8.10 Gateway的高可用（了解）

启动多个Gateway服务，自动注册到Eureka，形成集群。如果是服务内部访问，访问Gateway，自动负载均衡，没问题。
但是，Gateway更多是外部访问，PC端、移动端等。它们无法通过Eureka进行负载均衡，那么该怎么办？此时，可以使用其它的服务网关，来对Gateway进行代理。比如：Nginx 。

8.11 Gateway与Feign的区别

Gateway 作为整个应用的流量入口，接收所有的请求，如PC、移动端等，并且将不同的请求转发至不同的处理微服务模块，其作用可视为Nginx；大部分情况下用作权限鉴定、服务端流量控制等等。
Feign 则是将当前微服务的部分服务接口暴露出来，并且主要用于各个微服务之间的服务调用。

Java战5渣

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
SpringCloud-07-Gateway网关路由

SpringCloud-01-微服务的起源SpringCloud-02-SpringCloud入门SpringCloud-03-Eureka服务管理SpringCloud-04-Ribbon负载均衡SpringCloud-05-Hystrix熔断器SpringCloud-06-Feign声明式WebService客户端文章目录8. Gateway网关8.1 Gateway简介8.2 Gateway工作原理8.3 Gateway核心概念8.4 Gateway入门案例8.4.1 创建子工程8.4.2
复制链接

扫一扫