1. gateWay配置路由之通过yml配置
官网:https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-starter
网关对比
-
Zuul 1.x
Netflix开源的网关,基于Servlet框架构建,功能丰富,使用JAVA开发,易于二次开发 问题:即一个线程处理一次连接请求,这种方式在内部延迟严重、设备故障较多情况下会引起存活的连接增多和线程增加的情况发生。
-
Zuul 2.x
Zuul2 采用了Netty实现异步非阻塞编程模型,每个 CPU 核一个线程,处理所有的请求和响应,请求和响应的生命周期是通过事件和回调来处理的,这种方式减少了线程数量,因此开销较小。
-
GateWay
Spring公司为了替换Zuul而开发的网关服务,底层为Netty,将在下面具体介绍。
-
Nginx+lua
使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用,lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本,问题在于:无法融入到微服务架构中
-
Kong
基于Nginx+Lua开发,性能高,稳定,有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题:只支持Http协议;二次开发,自由扩展困难;提供管理API,缺乏更易用的管控、配置方式。
GateWay
Spring Cloud Gateway 基于Spring Boot 2.x、Spring WebFlux和Project Reactor,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代Netflix Zuul,其不仅提供统一的路由方式,并且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控和限流。
特点:
- 性能强劲:是Zuul的1.6倍
- 功能强大:内置了很多实用的功能,例如转发、监控、限流等
- 设计优雅,容易扩展
基本概念:
路由(Route) 是 gateway 中最基本的组件之一,表示一个具体的路由信息载体。主要定义了下面的几个信息:
- id:路由标识、区别于其他route
- uri:路由指向的目的地uri,即客户端请求最终被转发到的微服务
- order:用于多个route之间的排序,数值越小排序越靠前,匹配优先级越高
- predicate:断言的作用是进行条件判断,只有断言都返回真,才会真正的执行路由
- filter:过滤器用于修改请求和响应信息
gateWay工作流程+GateWay搭建
核心概念
客户端向 Spring Cloud Gateway 发出请求。如果Gateway Handler Mapping确定请求与路由匹配,则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Fliter链运行请求。Fliter被虚线分隔的原因是Fliter可以在发送代理请求之前(pre)和之后(post)运行逻辑。执行所有pre过滤器逻辑。然后进行代理请求。发出代理请求后,将运行“post”过滤器逻辑。
过滤器的作用
- Filter在pre类型的过滤器可以做参数效验、权限效验、流量监控、日志输出、协议转换等。
- Filter在post类型的过滤器可以做响应内容、响应头的修改、日志输出、流量监控等
- 这两种类型的过滤器有着非常重要的作用
核心点
-
Route(路由)
路由是构建网关的基础模块,它由ID,目标URI,包括一些列的断言和过滤器组成,如果断言为true则匹配该路由
-
Predicate(断言)
参考的是Java8的java.util.function.Predicate,开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),请求与断言匹配则进行路由
-
Filter(过滤)
指的是Spring框架中GateWayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
gateWay搭建
- 新建项目 cloudAlibaba-gateway-9999
- 导入相关依赖注意版本关系
版本对应地址:https://spring.io/projects/spring-cloud
父项目引入
<!--spring cloud Hoxton.SR5-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud-gateway-varsion}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
子项目引入依赖
<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-gateway</artifactId>
</dependency>
配置yml文件
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
routes:
- id: nacos-provider
uri: http://localhost:9001/nacos-provider
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
更改9001的DemoController 加上一个入口
package com.gek.cloudalibabanacos9001;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/msb")
public class DemoController {
@Value("${server.port}")
private String serverPort;
@GetMapping("/gek")
public String getServerPort(){
return "Hello Nacos Discover"+serverPort;
}
@GetMapping(value = "/get")
public String getServerPort2(){
return "库存-1"+serverPort;
}
}
测试:
2. gateWay配置路由之通过代码配置
- 新建配置类
package com.gek.cloudalibabagateway9999.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;
@Configuration
public class GateWayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
// 构建多个routes
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
// 具体路由地址
routes.route("path_msb",r->r.path("/msb/**").uri("http://localhost:9001/nacos-provider")).build();
// 返回所有路由规则
return routes.build();
}
}
- 在9001中添加一个控制器方法
@GetMapping(value = "/custom")
public String customTest(){
return "网关配置custom测试";
}
测试:
用代码配置gateWay不太方便,一般都是yml进行配置
3. gateWay实现负债均衡
3.1 自动负载均衡
- gateway.discovery.locator.enabled: true #开启自动路由功能
- routes中的uri其实最后是不需要服务名称的,这个位置其实只需要指定的localhost:9001即可
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
discovery:
server-addr: localhost:8848
gateway:
discovery:
locator:
enabled: true #开启自动路由功能,根据服务名称自动创建routes
GateWay还提供了和Zuul类似的自动路由规则,具体配置如下:
- discovery.locator.enabled: true #这个配置默认为false,但是如果为true,就是开启了通过serviceId转发到具体的服务实例。“localhost:9999/ServiceID/msb/**”
- 在配置好这些以后,我们可以直接通过服务名称来进行访问Nacos中注册的服务和对应的接口
- 这个位置我们为了测试可以启动2个微服务9001、9002
- GateWay在开启了自动路由以后,还自带负载均衡
测试结果:
- 访问地址:
- http://localhost:9999/nacos-provider/msb/get
- http://localhost:9999/nacos-provider/msb/get
3.2 手动负载均衡
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
测试
我们现在开启9001/9002两个服务和9999网关服务,然后此时我们可以通过网关去访问:http://localhost:9999/msb/get
4. gateWay断言Predicate
断言种类
- After:匹配在指定日期时间之后发生的请求。
- Before:匹配在指定日期之前发生的请求。
- Between:需要指定两个日期参数,设定一个时间区间,匹配此时间区间内的请求。
- Cookie:需要指定两个参数,分别为name和regexp(正则表达式),也可以理解Key和Value,匹配具有给定名称且其值与正则表达式匹配的Cookie。
- Header:需要两个参数header和regexp(正则表达式),也可以理解为Key和Value,匹配请求携带信息。
- Host:匹配当前请求是否来自于设置的主机。
- Method:可以设置一个或多个参数,匹配HTTP请求,比如GET、POST
- Path:匹配指定路径下的请求,可以是多个用逗号分隔
- Query:需要指定一个或者多个参数,一个必须参数和一个可选的正则表达式,匹配请求中是否包含第一个参数,如果有两个参数,则匹配请求中第一个参数的值是否符合正则表达式。
- RemoteAddr:匹配指定IP或IP段,符合条件转发。
- Weight:需要两个参数group和weight(int),实现了路由权重功能,按照路由权重选择同一个分组中的路由
4.1 After断言
after断言配置
server:
port: 9999
spring:
application:
name: cloud-gateway-service
cloud:
nacos:
config:
server-addr: 127.0.0.1:8848
gateway:
discovery:
locator:
enabled: true #开启注册中心路由功能
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
- After=2022-07-04T17:19:49.155+08:00[Asia/Shanghai] # 在这个时间之后的请求都能通过
写一个测试类,来获取当前时间
public class TestDateTime {
public static void main(String[] args) {
ZonedDateTime zbj = ZonedDateTime.now();//默认时区
System.out.println(zbj);
}
}
测试:
4.2 before断言
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
- Before=2022-07-04T17:30:49.155+08:00[Asia/Shanghai] # 在这个时间之前的请求都能通过
测试:
4.3 Between 断言
在两个时间内的请求,能通过
配置:
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
- Between=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver] # 在这个时间点之间的请求都能通过
4.4 Cookie 断言
cookie符合给定正则则通过
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
- Cookie=username,[a-z]+. #cookie前面是key,后面是正则表达式,符合则通过
4.5 Header断言
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
-Header=X-Request-Id,\d+ #表示数字
4.5 Host断言
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
- Host=**.mashibing.com #匹配当前的主机地址发出的请求
4.6 method断言
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
-Method=GET,POST # 匹配GET请求或者POST请求
4.7Query断言
routes:
- id: nacos-provider
uri: lb://nacos-provider #实现负载均衡
predicates: # 断言
- Path=/msb/** # 断言,路径相匹配进行路由
-Query=id,.+ # 匹配请求参数,这里如果需要匹配多个参数,可以写多个Query
5. 自定义Filter
要实现GateWay自定义过滤器,那么我们需要实现两个接口
- GlobalFilter
- Ordered
演示
首先我们新建一个类MyFilter
@Component
@Slf4j
public class MyFilter implements Ordered, GlobalFilter {
/**
* @param exchange 可以拿到对应的request和response
* @param chain 过滤器链
* @return 是否放行
*/
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
String username = exchange.getRequest().getQueryParams().getFirst("username");
log.info("*************MyFilter:"+new Date());
if(username == null){
log.info("**********用户名为null,非法用户,请求被拒绝!");
//如果username为空,返回状态码为406,不可接受的请求
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
/**
* 加载过滤器的顺序
* @return 整数数字越小优先级越高
*/
@Override
public int getOrder() {
return 0;
}
}
测试,此时我们的逻辑是在访问同时要传入username参数同时不能为空,否则不会放行本次请求。