目录
统一网关Gateway
网关的实现
搭建网关
编写配置文件
路由断言工程
路由的过滤器
全局过滤器
网关过滤器执行顺序
网关的cors跨域配置
问题及解决
SpringCloud中存在两种网关
首先网关也属于微服务的一个模块,也需要注册到Nacos与拉去Nacos的信息,创建gateway模块并引入以下两个依赖。
com.alibaba.cloud
spring-cloud-starter-alibaba-nacos-discovery
org.springframework.cloud
spring-cloud-starter-gateway
2.2.1.RELEASE
Gateway也是一个服务,需要一个启动类
@SpringBootApplication
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class,args);
}
}
server:
port: 10010
spring:
application:
name: gateway
cloud:
nacos:
server-addr: localhost:8848 # nacos的地址
gateway:
routes: # 路由地址
- id: user-server # 路由唯一标识(自定义,只要唯一)
uri: lb://user-server #路由目标地址
predicates: # 路由断言。判断请求是否符合规则
- Path=/user/**
- id: order-service # 路由唯一标识
uri: lb://order-service #路由目标地址
predicates: # 路由断言。判断请求是否符合规则
- Path=/order/**
启动网关服务,访问网关地址观察结果
具体流程如下
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件。
例如Path=从user/**是按照路径匹配,这个规则是由org.springframework.cloud.gateway.handlerpredicate.PathRoutePredicateFactory
类来处理的。
Spring提供了11种基本的Predicate工厂
名称 |
说明 |
示例 |
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-ld,\d+ |
Host |
请求必须是访问某个host (域名) |
-Host=**.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 |
权重处理 |
Spring提供了31种不同的路由过滤器工厂,具体可以去看SpringCloud文档,下面案例实现一个最基本的添加请求头过滤器。我们向/order所有请求添加一个gateway=hello world的请求头
首先添加配置
spring:
cloud:
nacos:
server-addr: localhost:8848 # nacos的地址
gateway:
routes: # 路由地址
- id: order-service # 路由唯一标识
uri: lb://order-service #路由目标地址
predicates: # 路由断言。判断请求是否符合规则
- Path=/order/**
filters:
- AddRequestHeader=gateway,hello world
在OrderController中添加参数,并打印
@GetMapping("{orderId}")
public Order queryOrderByUserId(@PathVariable("orderId") Long orderId,@RequestHeader(value = "gateway",required = false) String str) {
System.out.println("---------"+str);
// 根据id查询订单并返回
return orderService.queryOrderById(orderId);
}
访问观察控制台输出。
成功打印信息。
刚刚是针对某个路由生效,如果想要每个路由都生效,应该选择默认过滤器配置
spring:
cloud:
nacos:
server-addr: localhost:8848 # nacos的地址
gateway:
routes: # 路由地址
- id: order-service # 路由唯一标识
uri: lb://order-service #路由目标地址
predicates: # 路由断言。判断请求是否符合规则
- Path=/order/**
default-filters:
- AddRequestHeader=gateway,hello world
与Gateway的默认过滤器一样,处理一切进入网关请求和微服务响应。区别在于GatewayFilter通过配置定义,处理逻辑固定,而全局过滤器可以自己实现处理逻辑,实现方式就是实现GlobalFilter接口。下面写一个简单的登录拦截功能
/**
* 登录认证过滤器
*/
@Order(-1)
@Component
public class authorizeFilter implements GlobalFilter {
@Override
public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
//第一步获取请求参数
ServerHttpRequest request = exchange.getRequest();
MultiValueMap params = request.getQueryParams();
//获取参数中的authorize参数
String authorize = params.getFirst("authorize");
//判断参数是否等于admin
if (authorize.equals("admin")){
//等于,放行
return chain.filter(exchange);
}
//设置状态码
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
}
启动,并不添加验证访问测试
添加验证参数再次访问
请求进入网关会碰到3种过滤器:当前路由过滤器、DefaultFilter、GlobalFilter。
请求路由后,会将这三种过滤器合并到一个过滤器链(集合)中,排序后依次执行每个过滤器
首先比较order值,越小越先执行。GlobalFilter的order由我们指定,其他两种过滤器如果没有指定则由Spring指定order值,默认根据声明顺序来从1递增,当order值相同时,会按照defaultFilter>路由过滤器>GlobalFilter的顺序执行。
跨域:是指域名不同。比如说:
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题。
解决跨域问题:配置如下信息
spring:
cloud:
gateway:
globalcors:
add-to-simple-url-handler-mapping: true #一定要配置,主要解决options请求被拦截问题
cors-configurations:
'[/**]': #拦截路径
allowedOrigins: #允许哪些网站跨域请求
- "http://localhost:5500"
- "http://www.域名.com"
allowedMethods: #允许的跨域ajax请求方式
- "GET"
- "POST"
- "DELETE"
- "PUT"
- "OPTIONS"
allowedHeaders: "*" #允许在请求中携带的头信息
allowCredentials: true #是否允许携带Cookie
maxAge: 360000 #本次跨域检测的有效期
编写一个简单的html页面
测试
使用VSCode启动该页面
如果出现此类错误
说明该请求没有被放行,可以尝试将配置文件中的localhost修改成127.0.0.1。或者修改C:\Windows\System32\drivers\etc\hosts文件添加如下信息即可
127.0.0.1 localhost