哈喽~大家好,这篇来看看SpringCloud 网关 Gateway。
个人主页:个人主页
系列专栏:【微服务】
与这篇相关的文章:
SpringCloud Sentinel 使用 SpringCloud Sentinel 使用_程序猿追的博客-CSDN博客_springcloud使用sentinel 将Nacos注册到springboot使用以及Feign实现服务调用 将Nacos注册到springboot使用以及Feign实现服务调用_程序猿追的博客-CSDN博客_nacos springboot 服务调用 微服务介绍与 SpringCloud Eureka 微服务介绍与 SpringCloud Eureka_程序猿追的博客-CSDN博客
目录
一、前言
1、什么是网关?
二、gateway快速入门
1、基本步骤如下
2、编写启动类
3、编写基础配置和路由规则
4、启动网关服务进行测试
5、并且注释测试环境
6、总结
三、断言工厂
1、路由过滤器的种类
2、自定义全局过滤器
四、跨域问题
1、什么是跨域问题?
2、如何解决?
一、前言
1、什么是网关?
spring-cloud-gateway是一个库,可以在spring webflux之上建立一个API网关,它的目的是提供一个简单,有效的方式去路由到APIS并且提供:安全、监控和弹性。gateway构建于spring boot2.x,spring webFlux,and Project Reactor,所以,许多同步库如spring Data和spring security不适用于gateway项目中。因为gateway是异步非阻塞的。 gateway要求spring boot和spring webFlux提供Netty运行环境。它不能工作在传统的servlet容器或打成一个War包。
简称:Gateway网关是我们服务的守门神,所有微服务的统一入口。
二、gateway快速入门
1、基本步骤如下
创建SpringBoot工程gateway,引入网关依赖
org.springframework.cloud spring-cloud-starter-gateway com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery
2、编写启动类
@SpringBootApplicationpublic class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class, args); }}
3、编写基础配置和路由规则
server: port: 10010 # 网关端口spring: application: name: gateway # 服务名称 cloud: nacos: server-addr: localhost:8848 # nacos地址 gateway: routes: # 网关路由配置 - id: user-service # 路由id,自定义,只要唯一即可 # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址 uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称 predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
我们将符合Path
规则的一切请求,都代理到 uri
参数指定的地址。
例子中,我们将
/user/**
开头的请求,代理到lb://userserver
,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。
4、启动网关服务进行测试
输入网址http://localhost:10010/user/1
效果
注:gateway报There was an unexpected error (type=Service Unavailable, status=503).
新版本的nacos一定要在客户端加上spring-cloud-starter-loadbalancer,用于替换ribbon
5、并且注释测试环境
6、总结
网关搭建步骤:
创建项目,引入nacos服务发现和gateway依赖
配置application.yml,包括服务基本信息、nacos地址、路由
路由配置包括:
路由id:路由的唯一标示
路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
路由断言(predicates):判断路由的规则,
路由过滤器(filters):对请求或响应做处理
三、断言工厂
我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件
例如Path=/user/**是按照路径匹配,这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory
类来处理的,像这样的断言工厂在SpringCloudGateway还有十几个,见下表:
名称 | 说明 | 示例 |
---|---|---|
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-Id, \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 | 权重处理 |
我们只需要掌握Path这种路由工程就可以了。
过滤器工厂
GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:
1、路由过滤器的种类
Spring提供了31种不同的路由过滤器工厂。例如:
名称 | 说明 |
---|---|
AddRequestHeader | 给当前请求添加一个请求头 |
RemoveRequestHeader | 移除请求中的一个请求头 |
AddResponseHeader | 给响应结果中添加一个响应头 |
RemoveResponseHeader | 从响应结果中移除有一个响应头 |
RequestRateLimiter | 限制请求的流量 |
比如:给所有进入userservice的请求添加一个请求头:Truth=heiheihei
只需要修改gateway服务的application.yml文件,添加路由过滤即可:
spring: cloud: gateway: routes: - id: user-service uri: lb://userservice predicates: - Path=/user/** filters: # 过滤器 - AddRequestHeader=Truth, heiheihei # 添加请求头,键值对形式
当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。
如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:
spring: cloud: gateway: routes: - id: user-service uri: lb://userservice predicates: - Path=/user/** default-filters: # 默认过滤项 - AddRequestHeader=Truth, heiheihei
2、自定义全局过滤器
需求:定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:
1、参数中是否有test,
2、test参数值是否为test
如果同时满足则放行,否则拦截
代码
package com.itcast.gateway;import org.apache.http.HttpStatus;import org.springframework.cloud.gateway.filter.GatewayFilterChain;import org.springframework.cloud.gateway.filter.GlobalFilter;import org.springframework.core.annotation.Order;import org.springframework.stereotype.Component;import org.springframework.util.MultiValueMap;import org.springframework.web.server.ServerWebExchange;import reactor.core.publisher.Mono;@Order(-1)@Componentpublic class AuthorizeFilter implements GlobalFilter { @Override public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {// 1、获取请求参数 MultiValueMap params = exchange.getRequest().getQueryParams();// 2、获取test参数 String test = params.getFirst("test");// 3、校验判断 if ("test".equals(test)){// 放行 return chain.filter(exchange); }// 拦截,静止访问,设置状态码 exchange.getResponse().setStatusCode(org.springframework.http.HttpStatus.valueOf(HttpStatus.SC_UNAUTHORIZED));// 结束处理 return exchange.getResponse().setComplete(); }}
执行顺序:请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter
请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器。
排序的规则是什么呢?
1、每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。
2、GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定
3、路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。
4、当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。
详细内容,可以查看源码:
org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()
方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。
org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()
方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链
四、跨域问题
1、什么是跨域问题?
跨域:域名不一致就是跨域,主要包括:
1、域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com1、2、域名相同,端口不同:localhost:8080和localhost8081
跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题
2、如何解决?
在gateway服务的application.yml文件中,添加下面的配置:
spring: cloud: gateway: # 。。。 globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowedOrigins: # 允许哪些网站的跨域请求 - "http://localhost:8090" allowedMethods: # 允许的跨域ajax的请求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*" />
eg:
server: port: 10010spring: application: name: gateway cloud: nacos: server-addr: localhost:8848 gateway: routes: - id: userserver # 路由标识,就是你的路由名,且唯一 uri: lb://userserver # 路由的目标地址,lb就是负载均衡 predicates: #路由断言,判断路径是否以/user 开头,其实就是布尔判断 - Path=/user/**# filters: # 过滤器# - AddRequestHeader=Truth, Itxzw is freaking awesome! # 添加请求头 - id: orderserver # 路由标识,就是你的路由名,且唯一 uri: lb://orderserver # 路由的目标地址,lb就是负载均衡 predicates: #路由断言,判断路径是否以/user 开头,其实就是布尔判断 - Path=/order/** default-filters: # 默认过滤项 - AddRequestHeader=Truth, Itcast is freaking awesome! globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowedOrigins: # 允许哪些网站的跨域请求 - "http://localhost:8090" allowedMethods: # 允许的跨域ajax的请求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*" # 允许在请求中携带的头信息 allowCredentials: true # 是否允许携带cookie maxAge: 360000 # 这次跨域检测的有效期
不积跬步无以至千里,趁年轻,使劲拼,给未来的自己一个交代!向着明天更好的自己前进吧!