目录
1.🍟网关是什么
2.🍿gateway是什么
3.🥚gateway能什么
4.🌭核心概念
5.🧂工作流程
6.🧈实例
7.🥓gateway网关配置的方式
8.🍳配置动态路由
9.🧇predicate的使用
10.🥞自定义filter
1.🍟网关是什么
网关是指连接两个不同网络或网络协议的设备,主要用于连接和转发数据包。它可以实现不同网络之间的通信,并且可以对数据包进行解析、转换和过滤,以实现不同网络之间的数据交换和管理。
2.🍿gateway是什么
- SpringCloud Gateway,基于Spring 5.0+Spring Boot 2.0和Project Reactor等技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的API路由管理方式。
- SpringCloud Gateway作为Spring Cloud生态系统中的网关, SpringCloud Gateway是基于WebFlux框架l实现的,而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。
- Spring Cloud Gateway的目标提供统一的路由方式且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控/指标,和限流。
3.🥚gateway能什么
- 反向代理
- 鉴权
- 流量控制
- 熔断
- 日志监控
4.🌭核心概念
- 路由(Route):是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由
- 断言(predicate):开发人员可以匹配HTTP请求中的所有内容(例如请求头或请求参数),如果请求与断言相匹配则进行路由
- 过滤(filter):指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前或者之后对请求进行修改。
5.🧂工作流程
- 客户端向Spring Cloud Gateway发出请求。然后在Gateway Handler Mapping中找到与请求相匹配的路由,将其发送到GatewayWeb HandlerHandler再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。
- 过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前("pre" )或之后("post" )执行业务逻辑。
- 在"pre"类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等在"post"类型的过滤器中可以做响应内容、响应头的修改,日志的输出,流量监控等
6.🧈实例
1.建模块
在父工程下创建模块,注意jdk和maven版本
2.添pom
1.一定不要加springboot的web依赖,不然会报错
2.通用依赖
3.eureka依赖
4.gatewayt依赖
<dependencies>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.example</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</version>
</dependency>
<!--eureka的Client端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
</dependencies>
3.改yml
1.服务端口
2.服务名称
3.路由信息
4.入住eureka信息
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #路由的ID,没有固定当必须唯一
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/selectById/** #断言,路径匹配则进行断言
- id: payment_routh2
uri: http://localhost:8001
predicates:
- Path=/payment/lb/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7003.com:7003/eureka
4.主启动
@SpringBootApplication
@EnableEurekaClient
public class GateWayMain9527 {
public static void main(String[] args) {
SpringApplication.run(GateWayMain9527.class);
}
}
5.测试
访问9527时,能路由到8001
7.🥓gateway网关配置的方式
- 1.在yml文件中配置(如上)
- 2.代码中注入RouteLocator的Bean
当访问地址http://localhost:9527/board时会自动转发到地址:https://top.baidu.com/board
@Configuration
public class GateWayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
routes.route("path_route_xz1",
r -> r.path("/board").uri("https://top.baidu.com/board")).build();
return routes.build();
}
}
8.🍳配置动态路由
启动两台服务器,8001和8002;访问localhost:9527/lb查看是否负载均衡
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定当必须唯一
uri: lb://COULD-PAYMENT-SERVICE #匹配后提供服务的路由地址
predicates:
- Path=/payment/selectById/** #断言,路径匹配则进行断言
- id: payment_routh2
uri: lb://COULD-PAYMENT-SERVICE
predicates:
- Path=/payment/lb/**
eureka:
instance:
hostname: cloud-gateway-service
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7003.com:7003/eureka
9.🧇predicate的使用
1.After | Before | Between
- - After="区域时间" #在这个时间后才会生效
- - Before="区域时间" #在这个时间之前才会生效
- - Between="区域时间" #在这个时间段才会生效
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定当必须唯一
uri: lb://COULD-PAYMENT-SERVICE #匹配后提供服务的路由地址
predicates:
- Path=/payment/selectById/** #断言,路径匹配则进行断言
- After=2023-12-23T18:40:04.099+08:00[Asia/Shanghai] #在这个时间后才会生效
- Before=2023-12-23T18:40:04.099+08:00[Asia/Shanghai] #在这个时间之前才会生效
- Between=2023-12-23T18:40:04.099+08:00[Asia/Shanghai],2023-12-23T18:40:04.099+08:00[Asia/Shanghai] #在这个时间段才会生效
2.cookie
访问时必须携带cookie
spring:
application:
name: cloud-gateway
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由功能,利用微服务名进行路由
routes:
- id: payment_routh #路由的ID,没有固定当必须唯一
uri: lb://COULD-PAYMENT-SERVICE #匹配后提供服务的路由地址
predicates:
- Path=/payment/selectById/** #断言,路径匹配则进行断言
- Cookie=username,xz #访问时必须需携带cookie
10.🥞自定义filter
1.添加@Component创建bean对象
2.实现接口 GlobalFilter和 Ordered
@Component
@Slf4j
public class MyLogGateWayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("com in MyLogGateWayFilter:"+new Date());
String uname = exchange.getRequest().getQueryParams().getFirst("uname");
if (uname==null){
log.info("用户名为null,非法");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
return exchange.getResponse().setComplete();
}
log.info("uname="+uname);
return chain.filter(exchange);
}
@Override
public int getOrder() {
return 0;
}
}
访问时必须添加uname,否则报错