一、初识Gateway服务网关
为什么需要网关?
在微服务中,各个模块之间的调用,也可以称其为远程调用!但是,如果是外部(用户)对微服务进行访问时,发的请求能不加处理的直接访问微服务吗???
答案肯定是不能的!!!
例如,不是所有的业务都是对外公开的,如果"放任"任何用户都能对其进行访问,那么这是不安全的!
所以,需要一个安全组件——网关!
Gateway网关是我们服务的守门神,所有微服务的统一入口。
图解微服务架构
Zuul与Gateway对比
在SpringCloud中网关的实现有两种——Zuul和Gateway
Zuul是基于Servlet实现的,属于阻塞式编程。
而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具有更好的性能!!!
Gateway网关的作用
权限控制
网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
路由和负载均衡
一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流
当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
二、Gateway快速入门
我们这里先体验一下Gateway的使用,以Gateway的路由功能为例,大致可以分为4个步骤
(1)创建SpringBoot工程gateway模块,引入 网关依赖
(2)编写 启动类
(3)编写 基础配置和 路由规则
(4) 启动网关服务进行测试
1.创建SpringBoot工程gateway模块,引入网关依赖
创建一个新的服务模块
cloud-demo项目各个模块结构
引入依赖
这里也是需要nacos的注册发现依赖,Gateway本身也是一个服务,也需要注册到nacos或者从nacos上拉取服务!
<!--网关-->
<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>
2.编写启动类
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
3.编写基础配置和路由规则
创建application.yml文件,配置gateway服务和路由规则
server:
port: 10010
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848 # nacos 地址
gateway:
routes:
- id: user-service # 路由标识,必须唯一
# uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
uri: lb://userservice # 路由目标地址 lb就是负载均衡,后面跟服务名称
predicates: # 路由断言,判断路由是否符合规则
- Path=/user/** # 路径断言,判断路径是否是以/user开头,如果是,则符合规则。
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
- Before=2031-01-20T17:42:47.789-07:00[America/Denver] # 在这个时间之前的!
我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。
本例中,我们将 /user/**开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
4.重启服务测试
重启网关,访问localhost:10010/user/1,符合/user/**规则,请求转发到uri:userservice/user/1
同理,访问order-service服务也是这样!
网关路由的流程图
当我们有了网关开始,所有的请求都会经过网关,然后由网关路由到相应的服务中去。
小结
网关搭建步骤:
创建项目,引入nacos服务发现和gateway依赖
配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
路由id:路由的唯一标示
路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
路由断言(predicates):判断路由的规则,
路由过滤器(filters):对请求或响应做处理
三、断言工厂(Predicate Factory)
我们在配置文件中写的断言规则只是字符串,这些字符串会被断言工厂(Predicate Factory)读取并解析,转变为路由判断的条件
Predicate Factory的作用:读取用户定义的断言规则"字符串",对其进行解析,并对收到的请求做出判断!!!
这里面的Path=/user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来
处理的,像这样的断言工厂在SpringCloudGateway还有十几个
Spring中提供的11种断言工厂:Spring Cloud Gateway
名称 | 说明 | 示例 |
After | 是某个时间点后的请求 | - After=2037-01-20T17:42:47.789-07:00[America/Denver] |
Before | 是某个时间点之前的请求 | - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] |
Between | 是某两个时间点之间的请求 | - Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver] |
Cookie | 请求必须包含某些cookie | - Cookie=chocolate, ch.p |
Header | 请求必须包含某些header | - Header=X-Request-Id, \d+ |
Host | 请求必须是访问某个host(域名) | - Host=.somehost.org.somehost.org,.anotherhost.org |
Method | 请求方式必须是指定方式 | - Method=GET,POST |
Path | 请求路径必须符合指定规则 | - Path=/red/{segment},/blue/** |
Query | 请求参数必须包含指定参数 | - Query=name, Jack或者- Query=name |
RemoteAddr | 请求者的ip必须是指定范围 | - RemoteAddr=192.168.1.1/24 |
Weight | 权重处理 |
我们再拿其中的一个来举例子:时间(After)
现在是2023年,而这里order-service服务被访问的前提是2031.1.20之后,所以我们去访问localhost:10010/order/101 肯定是失败的!
四、过滤器工厂
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理。
路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂,我们只需要记住几种常见的,其余的有用到查官方文档即可,地址如下:Spring Cloud Gateway
名称 | 说明 |
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
...... | ...... |
我们现在就用请求头过滤器来做一个演示。
请求头过滤器(AddRequestHeader )
【案例需求】给所有进入userservice的请求添加一个请求头
对于这个需求其实很简单,只要修改gateway服务的application.yml文件,添加路由过滤即可
如下,我们给userservice添加请求头:Truth=Harmony is freaking awesome!
server:
port: 10010
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848 # nacos 地址
gateway:
routes:
- id: user-service # 路由标识,必须唯一
uri: lb://userservice # 路由目标地址
predicates: # 路由断言,判断路由是否符合规则
- Path=/user/** # 路径断言,判断路径是否是以/user开头,如果是,则符合规则。
# 局部过滤器
filters:
- AddRequestHeader=Truth,Harmony is freaking awesome! #添加请求头
- id: order-service
uri: lb://orderservice
predicates:
- Path=/order/**
- After=2031-01-20T17:42:47.789-07:00[America/Denver]
我们想要看看刚刚添加的请求头,可以通过在UserController中使用@RequestHeader注解获取请求头并打印
@Slf4j
@RestController
@RequestMapping("/user")
//@RefreshScope // 开启 nacos 属性刷新
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth", required = false) String truth) {
System.out.println("truth: " + truth);
return userService.queryById(id);
}
......
}
访问localhost:10010/user/1,在控制台上就会出现如下情况:
注意:当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效
默认过滤器
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。
格式如下:
注意:局部过滤器是在routes下的,而default-filters(默认过滤器)是和routes平级的!
spring:
cloud:
gateway:
routes:
- id: user-service
uri: lb://userservice
predicates:
- Path=/user/**
default-filters: # 默认过滤项
- AddRequestHeader=Truth,huawei is freaking awesome!
小结
过滤器的作用是什么?
① 对路由的请求或响应做加工处理,比如添加请求头
② 配置在路由下的过滤器只对当前路由的请求生效
default-Filters的作用是什么?
① 对所有路由都生效的过滤器
五、全局过滤器
上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。
更直白一个说,就是之前提到的default-Filters,我们只能通过application.yml文件来配置其参数,具体的业务逻辑是Spring实现的,我们无从干涉!!!
而当我们想要自己编写过滤器的逻辑呢?
显然仅仅default-Filters是不够的!!!这时候就需要全局过滤器(GlobalFilter)
1.全局过滤器作用
全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。
区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。
如何实现GlobalFilter呢?
仅需一步即可——定义方式是实现GlobalFilter接口
GlobalFilter接口如下所示:
public interface GlobalFilter {
/**
* 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
*
* @param exchange 请求上下文,里面可以获取Request、Response等信息
* @param chain 用来把请求委托给下一个过滤器
* @return {@code Mono<Void>} 返回标示当前过滤器业务结束
*/
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
exchange:请求上下文,即当请求进入网关开始,一直到结束,整个过程中exchange对象一直都是可见的!
chain:用于放行的,将信息交给下一个过滤器来处理。
2.自定义全局过滤器(GlobalFilter)
需求分析
定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
参数中是否有 authorization
authorization参数值是否为 admin
如果同时满足则放行,否则拦截!
代码实现
在gateway模块中定义一个过滤器
//@Ordered(-1)
@Component
public class AuthorizeFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1. 获取请求参数
ServerHttpRequest request = exchange.getRequest();
MultiValueMap<String, String> params = request.getQueryParams();
// 2. 获取参数中的 authorizeFilter 参数
String auth = params.getFirst("authorization");
// 3. 判断参数中是否有admin
if ("admin".equals(auth)) {
// 4. 是,放行
return chain.filter(exchange);
}
// 5. 否,拦截
// HttpStatus 是 org.springframework.http
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); // 未登入
return exchange.getResponse().setComplete();
}
// 顺序-过滤器的优先级,越小越高!!!
@Override
public int getOrder() {
return -1;
}
}
运行结果
当我们访问的路径中存在authorization参数,且其值为admin时,可以获取到正确的结果
反之,就会报错,即我们上述代码中设定的HttpStatus.UNAUTHORIZED(401)
3.过滤器执行顺序
请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器
【问】这三种过滤器类型都不一样为什么可以放到同一个集合中呢?
..............................
排序的规则
每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链