陕西省建设网站查询证件相片,建设协会网站,微信推广软件首选帝搜软件,免费wordpress页面编辑器转载自 Spring Cloud 终于按捺不住推出了自己的服务网关 Gateway
Spring 官方最终还是按捺不住推出了自己的网关组件#xff1a;Spring Cloud Gateway #xff0c;相比之前我们使用的 Zuul#xff08;1.x#xff09; 它有哪些优势呢#xff1f;Zuul#xff08;1.x…转载自 Spring Cloud 终于按捺不住推出了自己的服务网关 Gateway
Spring 官方最终还是按捺不住推出了自己的网关组件Spring Cloud Gateway 相比之前我们使用的 Zuul1.x 它有哪些优势呢Zuul1.x 基于 Servlet使用阻塞 API它不支持任何长连接如 WebSocketsSpring Cloud Gateway 使用非阻塞 API支持 WebSockets支持限流等新特性
Spring Cloud Gateway
Spring Cloud Gateway 是 Spring Cloud 的一个全新项目该项目是基于 Spring 5.0Spring Boot 2.0 和 Project Reactor 等技术开发的网关它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
Spring Cloud Gateway 作为 Spring Cloud 生态系统中的网关目标是替代 Netflix Zuul其不仅提供统一的路由方式并且基于 Filter 链的方式提供了网关基本的功能例如安全监控/指标和限流。
相关概念: Route路由这是网关的基本构建块。它由一个 ID一个目标 URI一组断言和一组过滤器定义。如果断言为真则路由匹配。 Predicate断言这是一个 Java 8 的 Predicate。输入类型是一个 ServerWebExchange。我们可以使用它来匹配来自 HTTP 请求的任何内容例如 headers 或参数。 Filter过滤器这是org.springframework.cloud.gateway.filter.GatewayFilter的实例我们可以使用它修改请求和响应。
工作流程 客户端向 Spring Cloud Gateway 发出请求。如果 Gateway Handler Mapping 中找到与请求相匹配的路由将其发送到 Gateway Web Handler。Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑然后返回。 过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前“pre”或之后“post”执行业务逻辑。
Spring Cloud Gateway 的特征 基于 Spring Framework 5Project Reactor 和 Spring Boot 2.0 动态路由 Predicates 和 Filters 作用于特定路由 集成 Hystrix 断路器 集成 Spring Cloud DiscoveryClient 易于编写的 Predicates 和 Filters 限流 路径重写
快速上手
Spring Cloud Gateway 网关路由有两种配置方式 在配置文件 yml 中配置 通过Bean自定义 RouteLocator在启动主类 Application 中配置
这两种方式是等价的建议使用 yml 方式进配置。
使用 Spring Cloud Finchley 版本Finchley 版本依赖于 Spring Boot 2.0.6.RELEASE。
parentgroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-parent/artifactIdversion2.0.6.RELEASE/versionrelativePath/ !-- lookup parent from repository --
/parentdependencyManagementdependenciesdependencygroupIdorg.springframework.cloud/groupIdartifactIdspring-cloud-dependencies/artifactIdversionFinchley.SR2/versiontypepom/typescopeimport/scope/dependency/dependencies
/dependencyManagement经测试 Finchley.RELEASE 有 bug 多次请求会报空指针异常SR2 是 Spring Cloud 的最新版本。 添加项目需要使用的依赖包
dependencygroupIdorg.springframework.cloud/groupIdartifactIdspring-cloud-starter-gateway/artifactId
/dependencySpring Cloud Gateway 是使用 nettywebflux 实现因此不需要再引入 web 模块。
我们先来测试一个最简单的请求转发。
server:port: 8080
spring:cloud:gateway:routes:- id: neo_routeuri: http://www.ityouknow.compredicates:- Path/spring-cloud各字段含义如下 id我们自定义的路由 ID保持唯一 uri目标服务地址 predicates路由条件Predicate 接受一个输入参数返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑比如与或非。 filters过滤规则本示例暂时没用。
上面这段配置的意思是配置了一个 id 为 neo_route 的路由规则当访问地址 http://localhost:8080/spring-cloud时会自动转发到地址http://www.ityouknow.com/spring-cloud。配置完成启动项目即可在浏览器访问进行测试当我们访问地址http://localhost:8080/spring-cloud 时会展示页面展示如下 明页面转发成功。
转发功能同样可以通过代码来实现我们可以在启动类 GateWayApplication 中添加方法 customRouteLocator() 来定制转发规则。
SpringBootApplication
public class GateWayApplication {public static void main(String[] args) {SpringApplication.run(GateWayApplication.class, args);}Beanpublic RouteLocator customRouteLocator(RouteLocatorBuilder builder) {return builder.routes().route(path_route, r - r.path(/about).uri(http://ityouknow.com)).build();}}上面配置了一个 id 为 path_route 的路由当访问地址http://localhost:8080/about时会自动转发到地址http://www.ityouknow.com/about和上面的转发效果一样只是这里转发的是以项目地址/about格式的请求地址。
上面两个示例中 uri 都是指向了我的个人网站在实际项目使用中可以将 uri 指向对外提供服务的项目地址统一对外输出接口。
以上便是 Spring Cloud Gateway 最简单的两个请求示例Spring Cloud Gateway 还有更多实用的功能接下来我们一一介绍。
路由规则
Spring Cloud Gateway 的功能很强大我们仅仅通过 Predicates 的设计就可以看出来前面我们只是使用了 predicates 进行了简单的条件匹配其实 Spring Cloud Gataway 帮我们内置了很多 Predicates 功能。
Spring Cloud Gateway 是通过 Spring WebFlux 的 HandlerMapping 做为底层支持来匹配到转发路由Spring Cloud Gateway 内置了很多 Predicates 工厂这些 Predicates 工厂通过不同的 HTTP 请求参数来匹配多个 Predicates 工厂可以组合使用。
Predicate 介绍
Predicate 来源于 Java 8是 Java 8 中引入的一个函数Predicate 接受一个输入参数返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑比如与或非。可以用于接口请求参数校验、判断新老数据是否有变化需要进行更新操作。and--与、or--或、negate--非
在 Spring Cloud Gateway 中 Spring 利用 Predicate 的特性实现了各种路由匹配规则有通过 Header、请求参数等不同的条件来进行作为条件匹配到对应的路由。网上有一张图总结了 Spring Cloud 内置的几种 Predicate 的实现。 说白了 Predicate 就是为了实现一组匹配规则方便让请求过来找到对应的 Route 进行处理接下来我们接下 Spring Cloud GateWay 内置几种 Predicate 的使用。
通过时间匹配
Predicate 支持设置一个时间在请求进行转发的时候可以通过判断在这个时间之前或者之后进行转发。比如我们现在设置只有在2019年1月1日才会转发到我的网站在这之前不进行转发我就可以这样配置
spring:cloud:gateway:routes:- id: time_routeuri: http://ityouknow.compredicates:- After2018-01-20T06:06:0608:00[Asia/Shanghai]Spring 是通过 ZonedDateTime 来对时间进行的对比ZonedDateTime 是 Java 8 中日期时间功能里用于表示带时区的日期与时间信息的类ZonedDateTime 支持通过时区来设置时间中国的时区是Asia/Shanghai。
After Route Predicate 是指在这个时间之后的请求都转发到目标地址。上面的示例是指请求时间在 2018年1月20日6点6分6秒之后的所有请求都转发到地址http://ityouknow.com。08:00是指时间和UTC时间相差八个小时时间地区为Asia/Shanghai。
添加完路由规则之后访问地址http://localhost:8080会自动转发到http://ityouknow.com。
Before Route Predicate 刚好相反在某个时间之前的请求的请求都进行转发。我们把上面路由规则中的 After 改为 Before如下
spring:cloud:gateway:routes:- id: after_routeuri: http://ityouknow.compredicates:- Before2018-01-20T06:06:0608:00[Asia/Shanghai]就表示在这个时间之前可以进行路由在这时间之后停止路由修改完之后重启项目再次访问地址http://localhost:8080页面会报 404 没有找到地址。
除过在时间之前或者之后外Gateway 还支持限制路由请求在某一个时间段范围内可以使用 Between Route Predicate 来实现。
spring:cloud:gateway:routes:- id: after_routeuri: http://ityouknow.compredicates:- Between2018-01-20T06:06:0608:00[Asia/Shanghai], 2019-01-20T06:06:0608:00[Asia/Shanghai]这样设置就意味着在这个时间段内可以匹配到此路由超过这个时间段范围则不会进行匹配。通过时间匹配路由的功能很酷可以用在限时抢购的一些场景中。
通过 Cookie 匹配
Cookie Route Predicate 可以接收两个参数一个是 Cookie name ,一个是正则表达式路由规则会通过获取对应的 Cookie name 值和正则表达式去匹配如果匹配上就会执行路由如果没有匹配上则不执行。
spring:cloud:gateway:routes:- id: cookie_routeuri: http://ityouknow.compredicates:- Cookieityouknow, kee.e使用 curl 测试命令行输入:
curl http://localhost:8080 --cookie ityouknowkee.e则会返回页面代码如果去掉--cookie ityouknowkee.e后台汇报 404 错误。
通过 Header 属性匹配
Header Route Predicate 和 Cookie Route Predicate 一样也是接收 2 个参数一个 header 中属性名称和一个正则表达式这个属性值和正则表达式匹配则执行。
spring:cloud:gateway:routes:- id: header_routeuri: http://ityouknow.compredicates:- HeaderX-Request-Id, \d使用 curl 测试命令行输入:
curl http://localhost:8080 -H X-Request-Id:666666 则返回页面代码证明匹配成功。将参数-H X-Request-Id:666666改为-H X-Request-Id:neo再次执行时返回404证明没有匹配。
通过 Host 匹配
Host Route Predicate 接收一组参数一组匹配的域名列表这个模板是一个 ant 分隔的模板用.号作为分隔符。它通过参数中的主机地址作为匹配规则。
spring:cloud:gateway:routes:- id: host_routeuri: http://ityouknow.compredicates:- Host**.ityouknow.com使用 curl 测试命令行输入:
curl http://localhost:8080 -H Host: www.ityouknow.com
curl http://localhost:8080 -H Host: md.ityouknow.com 经测试以上两种 host 均可匹配到 host_route 路由去掉 host 参数则会报 404 错误。
通过请求方式匹配
可以通过是 POST、GET、PUT、DELETE 等不同的请求方式来进行路由。
spring:cloud:gateway:routes:- id: method_routeuri: http://ityouknow.compredicates:- MethodGET使用 curl 测试命令行输入:
# curl 默认是以 GET 的方式去请求
curl http://localhost:8080测试返回页面代码证明匹配到路由我们再以 POST 的方式请求测试。
# curl 默认是以 GET 的方式去请求
curl -X POST http://localhost:8080返回 404 没有找到证明没有匹配上路由
通过请求路径匹配
Path Route Predicate 接收一个匹配路径的参数来判断是否走路由。
spring:cloud:gateway:routes:- id: host_routeuri: http://ityouknow.compredicates:- Path/foo/{segment}如果请求路径符合要求则此路由将匹配例如/foo/1 或者 /foo/bar。
使用 curl 测试命令行输入:
curl http://localhost:8080/foo/1
curl http://localhost:8080/foo/xx
curl http://localhost:8080/boo/xx经过测试第一和第二条命令可以正常获取到页面返回值最后一个命令报404证明路由是通过指定路由来匹配。
通过请求参数匹配
Query Route Predicate 支持传入两个参数一个是属性名一个为属性值属性值可以是正则表达式。
spring:cloud:gateway:routes:- id: query_routeuri: http://ityouknow.compredicates:- Querysmile这样配置只要请求中包含 smile 属性的参数即可匹配路由。
使用 curl 测试命令行输入:
curl localhost:8080?smilexid2经过测试发现只要请求汇总带有 smile 参数即会匹配路由不带 smile 参数则不会匹配。
还可以将 Query 的值以键值对的方式进行配置这样在请求过来时会对属性值和正则进行匹配匹配上才会走路由。
spring:cloud:gateway:routes:- id: query_routeuri: http://ityouknow.compredicates:- Querykeep, pu.这样只要当请求中包含 keep 属性并且参数值是以 pu 开头的长度为三位的字符串才会进行匹配和路由。
使用 curl 测试命令行输入:
curl localhost:8080?keeppub测试可以返回页面代码将 keep 的属性值改为 pubx 再次访问就会报 404,证明路由需要匹配正则表达式才会进行路由。
通过请求 ip 地址进行匹配
Predicate 也支持通过设置某个 ip 区间号段的请求才会路由RemoteAddr Route Predicate 接受 cidr 符号(IPv4 或 IPv6 )字符串的列表(最小大小为1)例如 192.168.0.1/16 (其中 192.168.0.1 是 IP 地址16 是子网掩码)。
spring:cloud:gateway:routes:- id: remoteaddr_routeuri: http://ityouknow.compredicates:- RemoteAddr192.168.1.1/24可以将此地址设置为本机的 ip 地址进行测试。
curl localhost:8080果请求的远程地址是 192.168.1.10则此路由将匹配。
组合使用
上面为了演示各个 Predicate 的使用我们是单个单个进行配置测试其实可以将各种 Predicate 组合起来一起使用。
例如
spring:cloud:gateway:routes:- id: host_foo_path_headers_to_httpbinuri: http://ityouknow.compredicates:- Host**.foo.org- Path/headers- MethodGET- HeaderX-Request-Id, \d- Queryfoo, ba.- Querybaz- Cookiechocolate, ch.p- After2018-01-20T06:06:0608:00[Asia/Shanghai]各种 Predicates 同时存在于同一个路由时请求必须同时满足所有的条件才被这个路由匹配。 一个请求满足多个路由的谓词条件时请求只会被首个成功匹配的路由转发 总结
通过今天的学习发现 Spring Cloud Gateway 使用非常的灵活可以根据不同的情况来进行路由分发在实际项目中可以自由组合使用。同时 Spring Cloud Gateway 还有更多很酷的功能比如 Filter 、熔断和限流等下次我们继续学习 Spring Cloud Gateway 的高级功能。
所有代码都在这里https://github.com/ityouknow/spring-cloud-examples
