目录
统一网关Gateway
网关的实现
搭建网关
编写配置文件
路由断言工程
路由的过滤器
全局过滤器
网关过滤器执行顺序
网关的cors跨域配置
问题及解决
统一网关Gateway
网关的实现
SpringCloud中存在两种网关
- gateway:基于Spring5中提供的WebFlux实现,属于响应式编程,性能更好
- zuul:基于Servlet实现,阻塞式编程
搭建网关
首先网关也属于微服务的一个模块,也需要注册到Nacos与拉去Nacos的信息,创建gateway模块并引入以下两个依赖。
<dependencies><!--nacos服务发现依赖--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId></dependency><!--网关依赖--><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId><version>2.2.1.RELEASE</version></dependency></dependencies>
Gateway也是一个服务,需要一个启动类
@SpringBootApplication
public class GatewayApplication {public static void main(String[] args) {SpringApplication.run(GatewayApplication.class,args);}
}
编写配置文件
server:port: 10010
spring:application:name: gatewaycloud: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 {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {//第一步获取请求参数ServerHttpRequest request = exchange.getRequest();MultiValueMap<String, String> params = request.getQueryParams();//获取参数中的authorize参数String authorize = params.getFirst("authorize");//判断参数是否等于adminif (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的顺序执行。
网关的cors跨域配置
跨域:是指域名不同。比如说:
- 域名不同: www.taobao.com 和 www.taobao.org 与 www.jd.com 和 miaosha.jd.com
- 域名相同,端口不同: localhost:8080和localhost:8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域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 #是否允许携带CookiemaxAge: 360000 #本次跨域检测的有效期
编写一个简单的html页面
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>测试</title>
</head>
<body>
</body>
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
<script>axios.get("http://localhost:10010/user/1?authorize=admin").then(res=> console.log(res.data)).catch(err=>console.log(err))
</script>
</html>
使用VSCode启动该页面
问题及解决
如果出现此类错误
说明该请求没有被放行,可以尝试将配置文件中的localhost修改成127.0.0.1。或者修改C:\Windows\System32\drivers\etc\hosts文件添加如下信息即可
127.0.0.1 localhost