一.Gateway服务网关介绍
Spring Cloud Gateway,它是一个基于Spring Framework 5、Project Reactor和Spring Boot 2的非阻塞(响应式编程和事件技术流)API网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。相比传统的Zuul网关,Spring Cloud Gateway具有更高的性能和更灵活的配置选项。
为什么需要网关
在微服务架构中,系统可能由多个服务组成。网关可以作为请求的入口,根据事先配置的路由规则将请求转发到相应的服务实例。
网关的核心功能特性:
- 请求路由
- 权限控制
- 限流
简单架构图:
核心功能作用:权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。
二.Gateway快速入门
接下来我们演示Gateway网关基本路由功能,步骤如下:
- 1.创建微服务gateway-cloud-server,引入网关依赖
- 2.编写网关启动类
- 3.编写基础配置和路由
- 4.启动Gateway网关进行测试
【步骤一】:创建gateway-cloud-server服务,并引入依赖
在这里需要创建一个项目进行演示,和之前的项目区别不大,可是为了区分,我还是重新创建了新的项目day32-cloud-gateway,不具体演示如何创建项目,大家可以去github地址查看
在pom.xml中引入Gateway依赖
com.alibaba.cloud
spring-cloud-starter-alibaba-nacos-discovery
org.springframework.cloud
spring-cloud-starter-gateway
org.springframework.cloud
spring-cloud-starter-loadbalancer
【步骤二】:编写Gateway网关启动类
package com.zbbmeta.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);
}
}
【步骤三】:编写基础配置和路由
在resuorces目录下创建application.yml文件,内容如下:
server:
port: 9999 # 网关端口
spring:
application:
name: gateway-service # 服务名称
cloud:
nacos:
server-addr: localhost:8848 # nacos地址
# 开启nacos负载均衡策略
loadbalancer:
nacos:
enabled: true
gateway:
routes: # 网关路由配置
- id: user-service # 路由id,自定义,只要唯一即可
#uri: http://127.0.0.1:8088 # 路由的目标地址 http就是固定地址
uri: lb://user-service # 路由的目标地址 lb就是负载均衡,后面跟服务名称
predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
- Path=/user
Mono filter(ServerWebExchange exchange, GatewayFilterChain chain);
}
在filter中编写自定义逻辑,可以实现下列功能:
- 登录状态判断
- 权限校验
- 请求限流等
5.3 自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求头中是否有满足下面条件:
- 请求头key是否有authorization,
- authorization参数值是否为admin
如果同时满足则放行,否则拦截
实现:
package com.zbbmeta.gateway.filters;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import reactor.netty.http.server.HttpServerRequest;
import java.util.List;
@Component
public class AuthorizeFilter implements GlobalFilter {
@Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
// 1.获取请求头
HttpHeaders headers = exchange.getRequest().getHeaders();
// 2.获取请求头key是authorization
List auths = headers.get("authorization");
// 3.校验
if(auths.contains("admin")){
// 放行
return chain.filter(exchange);
}
// 4.拦截
// 4.1.禁止访问,设置状态码
exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
// 4.2.结束处理
return exchange.getResponse().setComplete();
}
}
测试
使用postman访问http://localhost:9999/user/1,并在请求头添加authorizatinotallow=admin
错误展示请求头添加authorizatinotallow=admin1
5.4. 过滤器执行顺序
请求进入网关会碰到三类过滤器:
- 当前路由的过滤器
- 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排序,组织过滤器链
总结
本文针对微服务中另一重要组件:网关 进行了实战性演练,网关作为分布式架构中的重要中间件,不仅承担着路由分发(重点关注Path规则配置),同时可根据自身负载均衡策略,对多个注册服务实例进行均衡调用。我们借助GateWay实现的网关只是技术实现的方案之一,后续大家可能会接触像:Zuul、Kong等,其实现细节或有差异,但整体目标是一致的。