GateWay网关
介绍
SpringCloud的网关组件GateWay是一款开源的API网关,它旨在提供一个统一的入口来访问服务架构中的所有服务。它支持路由功能,可以将多个服务的请求发送到不同的微服务实例上,它还可以提供服务的智能路由、过滤器、限流和安全保护等功能。
概念
Route(路由):路由是构建网关的基本模块,它由ID,目标URI,一系列的断言和过滤器组成,如果断言为true则匹配该路由;
Predicate(断言):指的是Java 8 的 Function Predicate。 输入类型是Spring框架中的ServerWebExchange。 这使开发人员可以匹配HTTP请求中的所有内容,例如请求头或请求参数。如果请求与断言相匹配,则进行路由;
Filter(过滤器):指的是Spring框架中GatewayFilter的实例,使用过滤器,可以在请求被路由前后对请求进行修改。
项目搭建
在maven项目中创建commerce-gateway模块,引入和gateway相关的依赖;
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
注意事项:
由于gatweay是通过webflux进行编写的注意在依赖的时候不要引入web相关的jar否则会项目启动会报错
项目启动
编写springboot启动类 将gateway注册在nacos的网关中进行路由的转发
@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class,args);
}
}
网关主要在配置文件中进行配置
spring:
application:
name: commerce-gateway
cloud:
gateway:
discovery:
locator:
enabled: true
lower-case-service-id: true #使用小写service-id
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Path=/commerce-shop/**
filters:
- StripPrefix=1
- id: commerce-oauth2Auth
uri: lb://commerce-oauth2Auth
predicates:
- Path=/auth/**
filters:
- StripPrefix=1
- ’id–表示服务的标识
- uri–访问的地址 可以直接通过url地址进行访问 lb表示注册中心的访问
- predicates 断言,路径相匹配的进行路由
Route Predicate 的详细使用
After Route Predicate->在指定时间之后的请求会匹配该路由。
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- After=2023-03-2T16:30:00+08:00[Asia/Shanghai]
Before Route Predicate ->在指定时间之前的请求会匹配该路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Before =2023-03-2T16:30:00+08:00[Asia/Shanghai]
Between Route Predicate->在指定的时间区间内请求会匹配该路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Between=2023-01-24T16:30:00+08:00[Asia/Shanghai], 2023-03-2T16:30:00+08:00[Asia/Shanghai]
.Cookie Route Predicate->带着指定cookie的请求会匹配该路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Cookie=token,/d # 后面跟两个参数,相当于键值对,第一个参数为key,第二个参数为value,第二个参数可以是字符串或者是正则表达式
Header Route Predicate-> 带着header的指定请求会匹配该路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Cookie=id,\d+ # 后面跟两个参数,相当于键值对,第二个参数可以是字符串或者正则表达式
Host Route Predicate->带着指定的Host请求会匹配该路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Host=**.0.0.1 #访问的地址
Method Route Predicate->指定的方法请求匹配路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Method=GET
Path Route Predicate->指定的路径请求匹配路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Path=/shop/{id}
Query Route Predicate->带着指定的查询参数的请求可以匹配该路由
routes: #配置路由路径
- id: commerce-shop
uri: lb://commerce-shop
predicates:
- Query=username