SpringCloud之Gateway(服务网关)_springcloud 查看 gateway 是否生效

说明：关于SpringCloud系列的文章中的代码都在码云上面
地址：https://gitee.com/zh_0209_java/springcloud-alibaba.git

Gateway

Gateway 是Spring 生态系统之上构建的API网关服务，基于Spring 5,Spring Boot 2 和 Project Reactor等技术。Gateway 在提供一种简单而有效的方式来对API进行路由，以及提供一些强大的过滤器功能，例如：熔断，限流，重试等。

SpringCloud Gateway 作为Spring Cloud 生态系统中的网关，目标是代替Zuul,在Spriing Cloud 2.0以上版本，没有对新版本的Zuul 2.0 以上最新高性能版本进行集成，仍然还是使用的Zuul 1.x 非Reactor 模式的老版本。而为了提升网关的性能，SpringCloud Gateway 是基于WebFlux 框架实现的，而WebFlux框架底层则使用了高性能的Reactor 模式通讯框架Netty.

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

功能

• 动态路由：能够匹配任何请求属性
• 可以对路由指定Predicate(断言)和 Filter (过滤器)
• 集成Hystrix的断路器功能
• 集成Spring Cloud 服务发现功能
• 易于编写的Predicate(断言)和Filter（过滤器）
• 请求限流功能
• 支持路径重写

三大核心概念

• Route(路由)： 路由是构建网关的基本模块，它由ID,目标URI,一系列的断言和过滤器组成，如果断言为true则匹配该路由
• Predicate(断言)：参考的是Java8 的Java.util.funcation.Predicate, 开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由。
• Filter(过滤器)：值的是Spring 框架中GatewatFilter的实例，使用过滤器，可以在请求被路由前或者之后对请求进行修改

Gateway的工作流程

客户端向Spring Cloud Gateway 发出请求。然后在Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到Gateway Web Handler.

Handler 再通过制定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

创建网关服务

新建项目 cloud-gateway-gateway9527

1. 修改pom文件

<dependencies>
		<!--	gateway 服务网关	-->
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-gateway</artifactId>
		</dependency>


		<!--引入eureka Client依赖-->
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
		</dependency>

	</dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

注意：gateway 网关不依赖 starter-web 依赖，所以要去掉这个依赖

2. 修改配置文件

server:
  port: 9527

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      routes:   # 配置路由，是一个集合
        - id: payment-routh           # 路由的ID, 没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/**        # 断言，路径相匹配的进行路由转发


# ============ eureka client ===========
eureka:
  # 设置控制台显示的服务路径
  instance:
    instance-id: gateway9527
    prefer-ip-address: true # 访问地址可以显示ip
    # Eureka客户端向服务端发送心跳的时间间隔，单位为秒（默认是30秒）
    lease-renewal-interval-in-seconds: 1
    # Eureka 服务端在收到最后一次心跳后等待时间上线，单位为秒（默认是90秒），超时将剔除服务
    lease-expiration-duration-in-seconds: 2
  client:
    # 表示是否将自己注册进eurekaServer,默认为true
    register-with-eureka: true
    # 是否从EurekaServer抓取已有的注册信息，默认为true.单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡
    fetchRegistry: true
    service-url:
      # 本机入住eurekaServer 地址
      defaultZone: http://localhost:7001/eureka  # 单机版
#      defaultZone: http://localhost:7001/eureka,http://localhost:7002/eureka # 集群版
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

3. 编写启动类

@SpringBootApplication
@EnableEurekaClient
public class Gateway9527Application {

	public static void main(String[] args) {
		SpringApplication.run(Gateway9527Application.class,args);
	}
}
1
2
3
4
5
6
7
8

4. 启动eureka, payment8001, 和网关 访问http://localhost:9527/payment/port 进行测试
   

配置网关有两种方式

1. 在yml文件中配置

  cloud:
    gateway:
      routes:   # 配置路由，是一个集合
        - id: payment-routh           # 路由的ID, 没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/**        # 断言，路径相匹配的进行路由转发
1
2
3
4
5
6
7

2. 使用java配置

@Configuration
public class GatewayConfig {

	@Bean
	public RouteLocator getRouteLocator(RouteLocatorBuilder builder){
		// 相当于yml文件中的 routes
		RouteLocatorBuilder.Builder routes = builder.routes();
		// payment-routh 相当于 yml文件中的 id
		// /payment/** 相当于yml文件中的 predicates 断言
		// http://lcoalhost:8001 相当于yml文件中的 uri
		routes.route("payment-routh", route -> route.path("/payment/**").uri("http://localhost:8001")).build();
		return routes.build();
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

两种配置方式达到的效果是一样的！

根据服务名实现动态路由

默认情况下Gateway 会根据注册中心注册的服务列表，以注册中心上微服务名为路径创建 动态路由转发，从而实现动态路由的功能。
修改yml配置文件

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true  # 开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:   # 配置路由，是一个集合
        - id: payment-routh           # 路由的ID, 没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          uri: lb://cloud-payment-service  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/**        # 断言，路径相匹配的进行路由转发
1
2
3
4
5
6
7
8
9
10
11
12
13
14

启动8001和8002 来测试负载均衡

Gateway 常用的Predicates

Predicates断言是gateway的route 匹配规则
它的使用方法有很多种，path只是一种，通过启动服务时查看日志发现

常用的Predicates

1. After Route Predicates : 在什么时间之后 断言匹配的规则才能生效
2. Before Route Predicates ：在什么时间之前 断言匹配的规则才能生效
3. Between Route Predicates：在什么时间之间 断言匹配的规则才能生效
4. Cookie Route Predicates
5. Header Route Predicates
6. Host Route Predicates
7. Method Route Predicates
8. Path Route Predicates
9. Query Route Predicates

示例：

spring:
  application:
    name: cloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true  # 开启从注册中心动态创建路由的功能，利用微服务名进行路由
      routes:   # 配置路由，是一个集合
        - id: payment-routh           # 路由的ID, 没有固定规则但要求唯一，建议配合服务名
#          uri: http://localhost:8001  # 匹配后提供服务的路由地址
          uri: lb://cloud-payment-service  # 匹配后提供服务的路由地址
          predicates:
            - Path=/payment/**        # 断言，路径相匹配的进行路由转发
            - After=2021-07-12T14:11:02.633+08:00[Asia/Shanghai] # 在指定之间之后接口才会生效
            - Before=2021-07-12T15:11:02.633+08:00[Asia/Shanghai] # 在指定时间之前接口才会生效
            - Between=2021-07-12T14:11:02.633+08:00[Asia/Shanghai],2021-07-12T15:11:02.633+08:00[Asia/Shanghai] # 在指定时间之间才会生效

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

GatewayFilter

路由过滤器用于修改进入的HTTP请求和返回的HTTP响应，路由过滤器只能指定路由进行使用。

Spring Cloud Gateway 内置了多种路由过滤器，他们都由GatewayFilter的工厂类来产生。

Spring Cloud Gateway 的Filter 生命周期为两种，一个是Pre(前置)，post(后置)。

Spring Cloud Gateway 的Filter的种类有两种，一：GatewayFilter (单一的过滤器)。二：GlobalFilter(全局过滤器)

自定义过滤器

自定义全局GlobalFilter

1. 自定义配置类实现 GlobalFilter, Ordered两个接口

@Component
public class MyLogGlobalFilter implements GlobalFilter, Ordered {
	/**
	 * description: 自定义过滤条件
	 * 例如：我们这个过滤器指定访问参数必须带有 uname 参数，否则不允许访问
	 */
	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
		System.out.println("***********come in MyLogGlobalFilter: "+ new Date());
		String uname = exchange.getRequest().getQueryParams().getFirst("uname");
		if (null == uname){
			System.out.println("*********用户名为null,非法用户****");
			exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
			return exchange.getResponse().setComplete();
		}
		// 将exchange 传入到下一个过滤器
		return chain.filter(exchange);
	}

	/**
	 * description: 设置加载过滤器的顺序，数值越小，优先级越高
	 * date: 2021年-07月-12日 14:47
	 * author: zhanghang
	 * 
	 * @param 
	 * @return int
	 */ 
	@Override
	public int getOrder() {
		return 0;
	}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

2. 启动服务访问 http://localhost:9527/payment/port
   
   发现不能访问，加上参数uname在进行测试
   
   访问正常。