【SpringCloud】（一文通） 统一服务入口-Gateway

一. 网关介绍

1.1 问题

我们通过 Eureka, Nacos 解决了服务注册, 服务发现的问题, 使用 Spring Cloud
LoadBalance 解决了负载均衡的问题, 使用 OpenFeign 解决了远程调用的问题.

但是当前所有微服务的接口都是直接对外暴露的, 可以直接通过外部访问. 为了保证对外服务的安全性,服务端实现的微服务接口通常都带有⼀定的权限校验机制. 由于使用了微服务, 原本⼀个应用的多个模块拆分成了多个应用, 我们不得不实现多次校验逻辑. 当这套逻辑需要修改时, 我们需要修改多个应用, 加重了开发人员的负担.

针对以上问题, ⼀个常用的解决方案是使用 API 网关

1.2 什么是 API 网关

API 网关(简称网关)也是⼀个服务, 通常是后端服务的唯⼀入口. 它的定义类似设计模式中的Facade模式(门面模式, 也称外观模式). 它就类似整个微服务架构的门面, 所有的外部客户端访问, 都需要经过它来进行调度和过滤

网关核心功能:

• 权限控制: 作为微服务的入口, 对用户进行权限校验, 如果校验失败则进行拦截

• 动态路由: ⼀切请求先经过网关, 但网关不处理业务, 而是根据某种规则, 把请求转发到某个微服务

• 负载均衡: 当路由的目标服务有多个时, 还需要做负载均衡

• 限流: 请求流量过高时, 按照网关中配置微服务能够接受的流量进行放行, 避免服务压力过大.

类似前台的工作

1. 权限控制: 身份验证
2. 动态路由: 根据外来客户的需求, 把客户带到指定的部门去处理
3. 负载均衡: ⼀个部门有很多人时, 前台会帮客户选择具体某个人处理
4. 限流: 公司到访客户较多时, 进行流量限制, 比如告知明天再来

1.3 常见网关实现

业界常用的网关方式有很多, 技术方案也较成熟, 其中不乏很多开源产品, 比如Nginx, Kong, Zuul,Spring Cloud Gateway等. 下面介绍两种常见的网关方案

Zuul

Zuul 是 Netflix 公司开源的⼀个 API 网关组件, 是Spring Cloud Netflix 子项目的核心组件之⼀，它可以和 Eureka、Ribbon、Hystrix 等组件配合使用.

在Spring Cloud Finchley 正式版之前, Spring Cloud 推荐的网关是 Netflix 提供的 Zuul (此处指 Zuul 1.X).然而 Netflix 在 2018 年宣布⼀部分组件进⼊维护状态, 不再进行新特性的开发. 这部分组件中就包含Zuul.

Spring Cloud Gateway

Spring Cloud Gateway 是 Spring Cloud 的⼀个全新的 API 网关项目, 基于Spring + SpringBoot 等技术开发, ⽬的是为了替换掉 Zuul. 旨在为微服务架构提供⼀种简单而有效的途径来转发请求, 并为他们提供横切关注点, 比如: 安全性, 监控/指标和弹性

在性能方面, 根据官方提供的测试报告, Spring Cloud Gateway 的 RPS(每秒请求数)是 Zuul 的1.6倍. 测试报告参考:点击跳转

二. Spring Cloud Gateway

2.1 快速上手

我们通过以下的演示, 先来了解网关的基本功能

2.1.1 创建网关项目

API 网关也是⼀个服务.

2.1.2 引入网关依赖

<!--⽹关-->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--基于nacos实现服务发现依赖-->
<dependency>
	<groupId>com.alibaba.cloud</groupId>
	<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!--负载均衡-->
<dependency>
	<groupId>org.springframework.cloud</groupId>
	<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>

2.1.3 编写启动类

package com.bite.gateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

2.1.4 添加Gateway的路由配置

创建 application.yml 文件, 添加如下配置:

server:
	port: 10030 # ⽹关端⼝
spring:
	application:
		name: gateway # 服务名称
	cloud:
		nacos:
			discovery:
				server-addr: 110.41.51.65:10020
		gateway:
			routes: # ⽹关路由配置
				- id: product-service #路由ID, ⾃定义, 唯⼀即可
				  uri: lb://product-service #⽬标服务地址
				  predicates: #路由条件
					- Path=/product/**
				- id: order-service
				  uri: lb://order-service
				  predicates:
					- Path=/order/**

配置字段说明：

• id : 自定义路由ID, 保持唯⼀
• uri: 目标服务地址, 支持普通URI 及 lb://应用注册服务名称 . lb表示负载均衡, 使用 lb:// 方式表示从注册中心获取服务地址.
• predicates: 路由条件, 根据匹配结果决定是否执行该请求路由, 上述代码中, 我们把符合Path规则的⼀切请求, 都代理到 uri 参数指定的地址.

2.1.5 测试

启动 API 网关服务

1. 通过网关服务访问product-service：http://127.0.0.1:10030/product/1001

url 符合 yml 文件中配置的 /product/** 规则, 路由转发到 product-service: http://product-service/product/1001

访问时, 观察网关⽇志, 可以看到网关服务从Nacos时获取服务列表

2. 通过网关服务访问 order-service：http://127.0.0.1:10030/order/1

url 符合 yml 文件中配置的 /order/** 规则, 路由转发到 product-service: http://order-service/product/1001

2.2 Route Predicate Factories

2.2.1 Predicate

Predicate 是 Java 8 提供的⼀个函数式编程接口, 它接收⼀个参数并返回⼀个布尔值, 用于条件过滤, 请求参数的校验

@FunctionalInterface
public interface Predicate<T> {
	boolean test(T t);
	//...
}

代码演示:

1. 定义⼀个Predicate

class StringPredicate implements Predicate<String>{
	@Override
	public boolean test(String str) {
		return str.isEmpty();
	}
}

2. 使用这个 Predicate

public class PredictTest {
	public static void main(String[] args) {
		Predicate<String> predicate = new StringPredicate();
		System.out.println(predicate.test(""));
		System.out.println(predicate.test("bite666"));
	}
}

3. 运行结果

4. Predicate 的其他写法

1. 内置函数

public class PredictTest {
	public static void main(String[] args) {
		Predicate<String> predicate = new Predicate<String>(){
			@Override
			public boolean test(String s) {
				return s.isEmpty();
			}
		};
		System.out.println(predicate.test(""));
		System.out.println(predicate.test("bite666"));
	}
}

2. lambda写法

public class PredictTest {
	public static void main(String[] args) {
		Predicate<String> predicate = s -> s.isEmpty();
		System.out.println(predicate.test(""));
		System.out.println(predicate.test("bite666"));
	}
}

Predicate predicate = s -> s.isEmpty(); 也可以写成
Predicate isEmpty = String::isEmpty;

5. Predicate 的其他方法

• isEqual(Object targetRef) : 比较两个对象是否相等,参数可以为Null
• and(Predicate other): 短路与操作,返回⼀个组成Predicate
• or(Predicate other) : 短路或操作,返回⼀个组成Predicate
• test(T t) : 传入⼀个Predicate参数,用来做判断
• negate() ：返回表示此Predicate逻辑否定的Predicate

2.2.2 Route Predicate Factories

Route Predicate Factories (路由断言工厂, 也称为路由谓词工厂, 此处谓词表示⼀个函数), 在 SpringCloud Gateway 中, Predicate 提供了路由规则的匹配机制

我们在配置文件中写的断言规则只是字符串, 这些字符串会被 Route Predicate Factory 读取并处理, 转变为路由判断的条件.

比如前面章节配置的 Path=/product/** , 就是通过 Path 属性来匹配 URL 前缀是 /product 的请求.

这个规则是由 org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateF
actory 来实现的.

Spring Cloud Gateway 默认提供了很多 Route Predicate Factory, 这些Predicate 会分别匹配 HTTP 请求的不同属性, 并且多个 Predicate 可以通过 and 逻辑进行组合.

2.2.3 代码演示

1. 添加 Predicate 规则

在 application.yml 中添加如下规则

spring:
 cloud:
  gateway:
   routes: # ⽹关路由配置
     - id: product-service #路由ID, ⾃定义, 唯⼀即可
 	   uri: lb://product-service #⽬标服务地址
       predicates: #路由条件
		 - Path=/product/**
		 - After=2025-01-01T00:00:00.000+08:00[Asia/Shanghai]

增加限制路由规则: 请求时间为2025年1月1日之后

2. 测试

访问: http://127.0.0.1:10030/product/1001

返回 404

3. 修改时间为2024-01-01, 再次访问

- After=2024-01-01T00:00:00.000+08:00[Asia/Shanghai]

访问: http://127.0.0.1:10030/product/1001

2.3 Gateway Filter Factories(网关过滤器工厂)

Predicate 决定了请求由哪⼀个路由处理, 如果在请求处理前后需要加⼀些逻辑, 这就是 Filter (过滤器)的作用范围了.

Filter 分为两种类型: Pre 类型和 Post 类型

Pre 类型过滤器: 路由处理之前执行(请求转发到后端服务之前执行), 在 Pre 类型过滤器中可以做鉴权, 限流等.

Post 类型过滤器: 请求执行完成后, 将结果返回给客户端之前执行

⽐如去景区玩

1. 进景区之前需要先安检, 验票(鉴权), 如果今日进景区的人超过了规定的人数, 就会进行限流
2. 接下来进景区游玩
3. 游玩之后, 对景区服务进行评价
    
   1 就类似Pre类型过滤器, 3就类似Post类型过滤器, 过滤器可有可⽆

Spring Cloud Gateway 中内置了很多 Filter, 用于拦截和链式处理web请求. 比如权限校验, 访问超时等设定.

Spring Cloud Gateway 从作用范围上, 把 Filter 可分为 GatewayFilter 和GlobalFilter.

GatewayFilter: 应用到单个路由或者⼀个分组的路由上.

GlobalFilter: 应用到所有的路由上, 也就是对所有的请求生效.

2.3.1 GatewayFilter

GatewayFilter 同 Predicate 类似, 都是在配置文件 application.yml 中配置，每个过滤器的逻辑都是固定的. 比如 AddRequestParameterGatewayFilterFactory 只需要在配置文件中写 AddRequestParameter , 就可以为所有的请求添加⼀个参数, 我们先通过⼀个例子来演示 GatewayFilter 如何使用.

快速上手

1. 在 application.yml 中添加 filter

server:
  port: 10030 # ⽹关端⼝
spring:
  application:
    name: gateway # 服务名称
  cloud:
    nacos:
      discovery:
        server-addr: 110.41.51.65:10020
    gateway:
	  routes: # ⽹关路由配置
        - id: product-service #路由ID, ⾃定义, 唯⼀即可
          uri: lb://product-service #⽬标服务地址
          predicates: #路由条件
		    - Path=/product/**
			- After=2024-01-01T00:00:00.000+08:00[Asia/Shanghai]
		  filters:
			- AddRequestParameter=userName, bite
		- id: order-service
          uri: lb://order-service
		  predicates:
			- Path=/order/**

该 filter 只添加在了 product-service 路由下, 因此只对 product-service 路由生效, 也就是对 /product/** 的请求生效

2. 接收参数并打印

在 product-service 服务中接收请求的参数,并打印出来

@RequestMapping("/product")
@RestController
public class ProductController {
	@Autowired
	private ProductService productService;
	
	@RequestMapping("/{productId}")
	public ProductInfo getProductById(@PathVariable("productId") Integer productId, String userName){
		System.out.println("收到请求,Id:"+productId);
		System.out.println("userName:"+userName);
		return productService.selectProductById(productId);
	}
}

3. 测试

重启 gateway 和 product-service 服务,访问请求, 观察日志：http://127.0.0.1:10030/product/1001

控制台打印日志:

 收到请求,Id:1001
 userName:bite

GatewayFilter 说明

Spring Cloud Gateway 提供了的 Filter 非常多, 下面列出⼀些常见过滤器的说明

Default Filters

前面的 filter 添加在指定路由下, 所以只对当前路由生效, 若需要对全部路由生效, 可以使用 spring.cloud.gateway.default-filters 这个属性需要⼀个 filter 的列表.

配置举例:

spring:
  cloud:
    gateway:
      default-filters:
 	  - AddResponseHeader=X-Response-Default-Red, Default-Blue
 	  - PrefixPath=/httpbin

2.3.2 GlobalFilter

GlobalFilter 是 Spring Cloud Gateway 中的全局过滤器, 它和 GatewayFilter 的作用是相同的.

GlobalFilter 会应用到所有的路由请求上, 全局过滤器通常用于实现与安全性, 性能监控和日志记录等相关的全局功能

Spring Cloud Gateway 内置的全局过滤器也有很多, 比如:

• Gateway Metrics Filter: 网关指标, 提供监控指标
• Forward Routing Filter: 用于本地 forword, 请求不转发到下游服务器
• LoadBalancer Client Filter: 针对下游服务, 实现负载均衡.
• …

快速上手

1. 添加依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

2. 添加配置

spring:
  cloud:
    gateway:
	  metrics:
		enabled: true
management:
  endpoints:
	web:
	  exposure:
		include: "*"
  endpoint:
	health:
	  show-details: always
	shutdown:
	  enabled: true

3. 测试

http://127.0.0.1:10030/actuator, 显示所有监控的信息链接

2.4 过滤器执行顺序

⼀个项目中, 既有 GatewayFilter, 又有 GlobalFilter 时, 执行的先后顺序是什么呢?

请求路由后, 网关会把当前项目中的 GatewayFilter 和 GlobalFilter 合并到⼀个过滤器链(集合)中, 并进行排序, 依次执行过滤器.

每⼀个过滤器都必须指定⼀个 int 类型的 order 值, 默认值为 0, 表示该过滤的优先级. order 值越小，优先级越高，执行顺序越靠前

• Filter 通过实现 Order 接口或者添加 @Order 注解来指定 order 值.
• Spring Cloud Gateway提供的 Filter 由 Spring 指定. 用户也可以自定义 Filter, 由用户指定.
• 当过滤器的 order 值⼀样时, 会按照 defaultFilter > GatewayFilter > GlobalFilter 的顺序执⾏

2.5 自定义过滤器

Spring Cloud Gateway 提供了过滤器的扩展功能, 开发者可以根据实际业务来自定义过滤器, 同样⾃定义过滤器也支持 GatewayFilter 和 GlobalFilter 两种.

2.5.1 自定义 GatewayFilter

自定义 GatewayFilter, 需要去实现对应的接口 GatewayFilterFactory , Spring Boot 默认帮我们实现的抽象类是 AbstractGatewayFilterFactory , 我们可以直接使用.

2.5.1.1 定义 GatewayFilter

import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import
org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Service;
import reactor.core.publisher.Mono;

@Slf4j
@Service
public class CustomGatewayFilterFactory extends AbstractGatewayFilterFactory<CustomGatewayFilterFactory.CustomConfig> implements Ordered {
	public CustomGatewayFilterFactory() {
		super(CustomConfig.class);
	}

	@Override
	public GatewayFilter apply(CustomConfig config) {
	/**
	* Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain 
	chain)
	* ServerWebExchange: HTTP请求-响应交互的契约, 提供对HTTP请求和响应的访问, 服
	务器端请求属性, 请求实例,响应实例等, 类似Context⻆⾊
	* GatewayFilterChain: 过滤器链
	* Mono: Reactor核⼼类, 数据流发布者, Mono最多只触发⼀个事件, 所以可以把
	Mono ⽤于在异步任务完成时发出通知.
	* Mono.fromRunnable: 创建⼀个包含Runnable元素的数据流
	*/
		return ((exchange, chain) -> {
			log.info("[Pre] Filter Request, name:"+config.getName());
			return chain.filter(exchange).then(Mono.fromRunnable(()->{
				log.info("[Post] Response Filter");
			}));
		});
	}
	
	@Override
	public int getOrder() {
		return Ordered.LOWEST_PRECEDENCE; //配置优先级, order越⼤, 优先级越低
	}
}

针对这个 Filter 的配置, 使用 CustomConfig 定义

@Data
public static class CustomConfig {
	private String name;
}

代码说明:

1. 类名统⼀以 GatewayFilterFactory 结尾, 因为默认情况下, 过滤器的 name 会采用该定义类的前缀. 这里的name=Custom(yml配置中使用)
2. apply 方法中, 同时包含 Pre 和 Post 过滤, then 方法中是请求执行结束之后处理的
3. CustomConfig 是⼀个配置类, 该类只有⼀个属性 name, 和 yml 的配置对应
4. 该类需要交给 Spring 管理, 所以需要加 @Service 注解
5. getOrder 表示该过滤器的优先级, 值越大, 优先级越低.

2.5.1.2 配置过滤器

spring:
  cloud:
	gateway:
	  routes: # ⽹关路由配置
		- id: product-service #路由ID, ⾃定义, 唯⼀即可
		  uri: lb://product-service #⽬标服务地址
		  predicates: #路由条件
			- Path=/product/**
		  filters:
			- name: Custom
			  args:
				name: custom filter

2.5.1.3 测试

重启服务, 访问接口, 观察日志：http://127.0.0.1:10030/product/1001

1 2024-01-06T14:34:10.374+08:00 INFO 21260 --- [ctor-http-nio-2] 
c.b.g.filter.CustomGatewayFilterFactory : [Pre] Filter Request, name:customfilter
2 2024-01-06T14:34:10.385+08:00 INFO 21260 --- [ctor-http-nio-5] 
c.b.g.filter.CustomGatewayFilterFactory : [Post] Response Filter

2.5.2 自定义 GlobalFilter

GlobalFilter 的实现比较简单, 它不需要额外的配置, 只需要实现 GlobalFilter 接口, 自动会过滤所有的 Filter

2.5.2.1 定义GlobalFilter

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.stereotype.Service;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Slf4j
@Service
public class CustomGlobalFilter implements GlobalFilter, Ordered {
	@Override
	public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
		log.info("[Pre] CustomGlobalFilter enter...");
		return chain.filter(exchange).then(Mono.fromRunnable(()->{
			log.info("[Post] CustomGlobalFilter return...");
		}));
	}
	
	@Override
	public int getOrder() {
		return Ordered.LOWEST_PRECEDENCE;//配置优先级, order越⼤, 优先级越低
	}
}

2.5.2.2 测试

重启服务, 访问接口, 观察日志：http://127.0.0.1:10030/product/1001

1 2024-01-06T14:58:55.869+08:00 INFO 37832 --- [ctor-http-nio-2] 
c.b.g.filter.CustomGatewayFilterFactory : [Pre] Filter Request, name:custom filter
2 2024-01-06T14:58:55.870+08:00 INFO 37832 --- [ctor-http-nio-2] 
c.b.gateway.filter.CustomGlobalFilter : [Pre] CustomGlobalFilter enter...
3 2024-01-06T14:58:55.933+08:00 INFO 37832 --- [ctor-http-nio-5] 
c.b.gateway.filter.CustomGlobalFilter : [Post] CustomGlobalFilter return...
4 2024-01-06T14:58:55.934+08:00 INFO 37832 --- [ctor-http-nio-5] 
c.b.g.filter.CustomGatewayFilterFactory : [Post] Response Filter

从日志中,也可以看出来, 当 GatewayFilter 和 GlobalFilter 过滤器 order ⼀样时, 会先执行 GatewayFilter

三. 服务部署

1. 修改数据库, Nacos 等相关配置
2. 对三个服务进行打包: product-service, order-service, gateway
3. 上传 jar 到 Linux 服务器
4. 启动 Nacos

启动前最好把 data数据删除掉.

5. 启动服务

#后台启动order-service, 并设置输出⽇志到logs/order.log
nohup java -jar order-service.jar >logs/order.log &

#后台启动product-service, 并设置输出⽇志到logs/order.log
nohup java -jar product-service.jar >logs/product-9090.log &

#启动⽹关
nohup java -jar gateway.jar >logs/gateway.log &

观察 Nacos 控制台

6. 测试

访问接口: http://110.41.51.65:10030/product/1001

观察远程调用的结果:

观察日志:

1 2024-01-06T16:09:39.321+08:00 INFO 888001 --- [or-http-epoll-2] 
c.b.g.filter.CustomGatewayFilterFactory : [Pre] Filter Request, 
name:custom filter
2 2024-01-06T16:09:39.322+08:00 INFO 888001 --- [oundedElastic-1] 
c.b.gateway.filter.CustomGlobalFilter : [Pre] CustomGlobalFilter enter...
3 2024-01-06T16:09:39.338+08:00 INFO 888001 --- [or-http-epoll-3] 
c.b.gateway.filter.CustomGlobalFilter : [Post] CustomGlobalFilter 
return...
4 2024-01-06T16:09:39.338+08:00 INFO 888001 --- [or-http-epoll-3] 
c.b.g.filter.CustomGatewayFilterFactory : [Post] Response Filter