ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

Spring Cloud Gateway开发手册

Spring Cloud Gateway开发手册 3.Gateway服务网关Spring Cloud Gateway 是 Spring Cloud 的一个全新项目该项目是基于 Spring 5.0Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。3.1.为什么需要网关Gateway网关是我们服务的守门神所有微服务的统一入口。网关的核心功能特性请求路由权限控制限流架构图权限控制网关作为微服务入口需要校验用户是是否有请求资格如果没有则进行拦截。路由和负载均衡一切请求都必须先经过gateway但网关不处理业务而是根据某种规则把请求转发到某个微服务这个过程叫做路由。当然路由的目标服务有多个时还需要做负载均衡。限流当请求流量过高时在网关中按照下流的微服务能够接受的速度来放行请求避免服务压力过大。在SpringCloud中网关的实现包括两种gatewayzuulZuul是基于Servlet的实现属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux属于响应式编程的实现具备更好的性能。3.2.gateway快速入门下面我们就演示下网关的基本路由功能。基本步骤如下创建SpringBoot工程gateway引入网关依赖编写启动类编写基础配置和路由规则启动网关服务进行测试1创建gateway服务引入依赖创建服务引入依赖!--网关--dependencygroupIdorg.springframework.cloud/groupIdartifactIdspring-cloud-starter-gateway/artifactId/dependency!--nacos服务发现依赖--dependencygroupIdcom.alibaba.cloud/groupIdartifactIdspring-cloud-starter-alibaba-nacos-discovery/artifactId/dependency2编写启动类packagecn.itcast.gateway;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;SpringBootApplicationpublicclassGatewayApplication{publicstaticvoidmain(String[]args){SpringApplication.run(GatewayApplication.class,args);}}3编写基础配置和路由规则创建application.yml文件内容如下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://userservicelb是负载均衡根据服务名拉取服务列表实现负载均衡。4重启测试重启网关访问http://localhost:10010/user/1时符合/user/**规则请求转发到urihttp://userservice/user/1得到了结果5网关路由的流程图整个访问的流程如下总结网关搭建步骤创建项目引入nacos服务发现和gateway依赖配置application.yml包括服务基本信息、nacos地址、路由路由配置包括路由id路由的唯一标示路由目标uri路由的目标地址http代表固定地址lb代表根据服务名负载均衡路由断言predicates判断路由的规则路由过滤器filters对请求或响应做处理接下来就重点来学习路由断言和路由过滤器的详细知识3.3.断言工厂我们在配置文件中写的断言规则只是字符串这些字符串会被Predicate Factory读取并处理转变为路由判断的条件例如Path/user/**是按照路径匹配这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的像这样的断言工厂在SpringCloudGateway还有十几个:名称说明示例After是某个时间点后的请求- After2037-01-20T17:42:47.789-07:00[America/Denver]Before是某个时间点之前的请求- Before2031-04-13T15:14:47.43308:00[Asia/Shanghai]Between是某两个时间点之前的请求- Between2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]Cookie请求必须包含某些cookie- Cookiechocolate, ch.pHeader请求必须包含某些header- HeaderX-Request-Id, \dHost请求必须是访问某个host域名- Host.somehost.org,.anotherhost.orgMethod请求方式必须是指定方式- MethodGET,POSTPath请求路径必须符合指定规则- Path/red/{segment},/blue/**Query请求参数必须包含指定参数- Queryname, Jack或者- QuerynameRemoteAddr请求者的ip必须是指定范围- RemoteAddr192.168.1.1/24Weight权重处理我们只需要掌握Path这种路由工程就可以了。3.4.过滤器工厂GatewayFilter是网关中提供的一种过滤器可以对进入网关的请求和微服务返回的响应做处理3.4.1.路由过滤器的种类Spring提供了31种不同的路由过滤器工厂。例如名称说明AddRequestHeader给当前请求添加一个请求头RemoveRequestHeader移除请求中的一个请求头AddResponseHeader给响应结果中添加一个响应头RemoveResponseHeader从响应结果中移除有一个响应头RequestRateLimiter限制请求的流量3.4.2.请求头过滤器下面我们以AddRequestHeader 为例来讲解。需求给所有进入userservice的请求添加一个请求头Truthitcast is freaking awesome!只需要修改gateway服务的application.yml文件添加路由过滤即可spring:cloud:gateway:routes:-id:user-serviceuri:lb://userservicepredicates:-Path/user/**filters:# 过滤器-AddRequestHeaderTruth,Itcast is freaking awesome!# 添加请求头当前过滤器写在userservice路由下因此仅仅对访问userservice的请求有效。3.4.3.默认过滤器如果要对所有的路由都生效则可以将过滤器工厂写到default下。格式如下spring:cloud:gateway:routes:-id:user-serviceuri:lb://userservicepredicates:-Path/user/**default-filters:# 默认过滤项-AddRequestHeaderTruth,Itcast is freaking awesome!3.4.4.总结过滤器的作用是什么① 对路由的请求或响应做加工处理比如添加请求头② 配置在路由下的过滤器只对当前路由的请求生效defaultFilters的作用是什么① 对所有路由都生效的过滤器3.5.全局过滤器上一节学习的过滤器网关提供了31种但每一种过滤器的作用都是固定的。如果我们希望拦截请求做自己的业务逻辑则没办法实现。3.5.1.全局过滤器作用全局过滤器的作用也是处理一切进入网关的请求和微服务响应与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义处理逻辑是固定的而GlobalFilter的逻辑需要自己写代码实现。定义方式是实现GlobalFilter接口。publicinterfaceGlobalFilter{/** * 处理当前请求有必要的话通过{link GatewayFilterChain}将请求交给下一个过滤器处理 * * param exchange 请求上下文里面可以获取Request、Response等信息 * param chain 用来把请求委托给下一个过滤器 * return {code MonoVoid} 返回标示当前过滤器业务结束 */MonoVoidfilter(ServerWebExchangeexchange,GatewayFilterChainchain);}在filter中编写自定义逻辑可以实现下列功能登录状态判断权限校验请求限流等3.5.2.自定义全局过滤器需求定义全局过滤器拦截请求判断请求的参数是否满足下面条件参数中是否有authorizationauthorization参数值是否为admin如果同时满足则放行否则拦截实现在gateway中定义一个过滤器packagecn.itcast.gateway.filters;importorg.springframework.cloud.gateway.filter.GatewayFilterChain;importorg.springframework.cloud.gateway.filter.GlobalFilter;importorg.springframework.core.annotation.Order;importorg.springframework.http.HttpStatus;importorg.springframework.stereotype.Component;importorg.springframework.web.server.ServerWebExchange;importreactor.core.publisher.Mono;Order(-1)ComponentpublicclassAuthorizeFilterimplementsGlobalFilter{OverridepublicMonoVoidfilter(ServerWebExchangeexchange,GatewayFilterChainchain){// 1.获取请求参数MultiValueMapString,Stringparamsexchange.getRequest().getQueryParams();// 2.获取authorization参数Stringauthparams.getFirst(authorization);// 3.校验if(admin.equals(auth)){// 放行returnchain.filter(exchange);}// 4.拦截// 4.1.禁止访问设置状态码exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);// 4.2.结束处理returnexchange.getResponse().setComplete();}}3.5.3.过滤器执行顺序请求进入网关会碰到三类过滤器当前路由的过滤器、DefaultFilter、GlobalFilter请求路由后会将当前路由过滤器和DefaultFilter、GlobalFilter合并到一个过滤器链集合中排序后依次执行每个过滤器排序的规则是什么呢每一个过滤器都必须指定一个int类型的order值order值越小优先级越高执行顺序越靠前。GlobalFilter通过实现Ordered接口或者添加Order注解来指定order值由我们自己指定路由过滤器和defaultFilter的order由Spring指定默认是按照声明顺序从1递增。当过滤器的order值一样时会按照 defaultFilter 路由过滤器 GlobalFilter的顺序执行。详细内容可以查看源码org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters然后再加载某个route的filters然后合并。org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器与前面的过滤器合并后根据order排序组织过滤器链3.6.跨域问题3.6.1.什么是跨域问题跨域域名不一致就是跨域主要包括域名不同 www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com域名相同端口不同localhost:8080和localhost8081跨域问题浏览器禁止请求的发起者与服务端发生跨域ajax请求请求被浏览器拦截的问题解决方案CORS这个以前应该学习过这里不再赘述了。不知道的小伙伴可以查看https://www.ruanyifeng.com/blog/2016/04/cors.html3.6.2.模拟跨域问题找到课前资料的页面文件放入tomcat或者nginx这样的web服务器中启动并访问。可以在浏览器控制台看到下面的错误从localhost:8090访问localhost:10010端口不同显然是跨域的请求。3.6.3.解决跨域问题在gateway服务的application.yml文件中添加下面的配置spring:cloud:gateway:# 。。。globalcors:# 全局的跨域处理add-to-simple-url-handler-mapping:true# 解决options请求被拦截问题corsConfigurations:[/**]:allowedOrigins:# 允许哪些网站的跨域请求-http://localhost:8090allowedMethods:# 允许的跨域ajax的请求方式-GET-POST-DELETE-PUT-OPTIONSallowedHeaders:*# 允许在请求中携带的头信息allowCredentials:true# 是否允许携带cookiemaxAge:360000# 这次跨域检测的有效期
返回列表