网络常识

    Spring cloud教程Gateway服务网关

    远方灬梦想2023年11月03日
    收录于话题
    #spring29#cloud13
    Spring cloud教程|Gateway服务网关

    写在前面的话： 本笔记在参考网上视频以及博客的基础上，只做个人学习笔记，如有侵权，请联系删除，谢谢！

    Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，该项目是基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

    1、为什么需要网关

    Gateway网关是我们服务的守门神，所有微服务的统一入口。

    网关的核心功能特性：

    请求路由权限控制限流

    架构图：

    Spring cloud教程Gateway服务网关

    权限控制：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。

    路由和负载均衡：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。

    限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求，避免服务压力过大。

    在SpringCloud中网关的实现包括两种：

    gatewayzuul

    Zuul是基于Servlet的实现，属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux，属于响应式编程的实现，具备更好的性能。

    2、gateway快速入门

    下面，我们就演示下网关的基本路由功能。基本步骤如下：

    创建SpringBoot工程gateway，引入网关依赖编写启动类编写基础配置和路由规则启动网关服务进行测试

    1、引入网关依赖

    org.springframework.cloudspring-cloud-starter-gateway

    2、编写启动类

    import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class,args); } }

    3、配置路由规则

    server: port: 10010 spring: application: name: gateway cloud: nacos: discovery: server-addr: 192.168.192.128:8848 gateway: routes: # 网关路由配置 - id: nacos-consumer # 路由id，自定义，只要唯一即可 uri: lb://nacos-consumer # 路由的目标地址 lb就是负载均衡，后面跟服务名称 predicates: # 路由断言，也就是判断请求是否符合路由规则的条件 - Path=/hello/** # 这个是按照路径匹配，只要以/hello/开头就符合要求

    我们将符合Path 规则的一切请求，都代理到 uri参数指定的地址。

    本例中，我们将 /hello/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

    4、重启测试

    http://localhost:10010/hello/sayHi/zhagnsan

    访问流程如下：

    Spring cloud教程Gateway服务网关

    总结：

    网关搭建步骤：

    创建项目，引入nacos服务发现和gateway依赖

    配置application.yml，包括服务基本信息、nacos地址、路由

    路由配置包括：

    路由id：路由的唯一标示

    路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

    路由断言（predicates）：判断路由的规则，

    路由过滤器（filters）：对请求或响应做处理

    3、断言工厂

    我们在配置文件中写的断言规则只是字符串，这些字符串会被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.pHeader请求必须包含某些header- Header=X-Request-Id, \d+Host请求必须是访问某个host（域名）- Host=.somehost.org,.anotherhost.orgMethod请求方式必须是指定方式- Method=GET,POSTPath请求路径必须符合指定规则- Path=/red/{segment},/blue/**Query请求参数必须包含指定参数- Query=name, Jack或者- Query=nameRemoteAddr请求者的ip必须是指定范围- RemoteAddr=192.168.1.1/24Weight权重处理

    我们只需要掌握Path这种路由工程就可以了。

    4、过滤器工厂

    GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理：

    Spring cloud教程Gateway服务网关

    4.1.路由过滤器的种类

    Spring提供了31种不同的路由过滤器工厂。例如：

    名称说明AddRequestHeader给当前请求添加一个请求头RemoveRequestHeader移除请求中的一个请求头AddResponseHeader给响应结果中添加一个响应头RemoveResponseHeader从响应结果中移除有一个响应头RequestRateLimiter限制请求的流量

    ​ 以请求过滤头AddRequestHeader 为例：

    给所有进入nacos-consumer的请求添加一个请求头： Hello World !

    只需要修改gateway服务的application.yml文件，添加路由过滤即可：

    server: port: 10010 spring: application: name: gateway cloud: nacos: discovery: server-addr: 192.168.192.128:8848 gateway: routes: # 网关路由配置 - id: nacos-consumer # 路由id，自定义，只要唯一即可 uri: lb://nacos-consumer # 路由的目标地址 lb就是负载均衡，后面跟服务名称 predicates: # 路由断言，也就是判断请求是否符合路由规则的条件 - Path=/hello/** # 这个是按照路径匹配，只要以/hello/开头就符合要求 filters: - AddRequestHeader=Truth, Hello the World! # 添加请求头 键值对 k,v #当前过滤器写在nacos-consumer路由下，因此仅仅对访问nacos-consumer的请求有效。

    当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效

    在请求的方法参数添加@RequestHeader 注解即可获取请求头参数

    @RequestMapping("getConfig") public String getConfig(@RequestHeader(value ="truth",required = false) String truth){ System.out.println(truth); return serviceFeginClient.getConfig(); }

    如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

    spring: cloud: gateway: routes: - id: nacos-consumer uri: lb://nacos-consumer predicates: - Path=/hello/** default-filters: # 默认过滤项 - AddRequestHeader=Truth, Hello the World!

    总结

    过滤器的作用是什么？

    ① 对路由的请求或响应做加工处理，比如添加请求头

    ② 配置在路由下的过滤器只对当前路由的请求生效

    defaultFilters的作用是什么？

    ① 对所有路由都生效的过滤器

    4.2、全局过滤器

    上面列出的过滤器，网关提供了31种，但每一种过滤器的作用都是固定的。如果我们希望拦截请求，做自己的业务逻辑则没办法实现。

    ​ 全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要自己写代码实现。

    定义方式是实现GlobalFilter接口。

    public interface GlobalFilter { /** * 处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理 * * @param exchange 请求上下文，里面可以获取Request、Response等信息 * @param chain 用来把请求委托给下一个过滤器 * @return {@code Mono} 返回标示当前过滤器业务结束 */ Mono filter(ServerWebExchange exchange, GatewayFilterChain chain); }

    在filter中编写自定义逻辑，可以实现下列功能：

    登录状态判断权限校验请求限流等

    需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

    参数中是否有authorization，

    authorization参数值是否为admin

    如果同时满足则放行，否则拦截

    实现：

    在gateway中定义一个过滤器：

    package cn.itcast.gateway.filters; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.annotation.Order; import org.springframework.http.HttpStatus; import org.springframework.stereotype.Component; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; @Order(-1) //执行顺序 @Component public class AuthorizeFilter implements GlobalFilter { @Override public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 1.获取请求参数 MultiValueMap params = exchange.getRequest().getQueryParams(); // 2.获取authorization参数 String auth = params.getFirst("authorization"); // 3.校验 if ("admin".equals(auth)) { // 放行 return chain.filter(exchange); } // 4.拦截 // 4.1.禁止访问，设置状态码 exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN); // 4.2.结束处理 return exchange.getResponse().setComplete(); } }

    4.3、过滤器执行顺序

    请求进入网关会碰到三类过滤器：当前路由的过滤器、DefaultFilter、GlobalFilter

    请求路由后，会将当前路由过滤器和DefaultFilter、GlobalFilter，合并到一个过滤器链（集合）中，排序后依次执行每个过滤器

    Spring cloud教程Gateway服务网关

    排序的规则是什么呢？

    每一个过滤器都必须指定一个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排序，组织过滤器链

    4.3、跨域问题

    跨域：域名不一致就是跨域，主要包括：

    域名不同： 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.html

    在gateway服务的application.yml文件中，添加下面的配置：

    spring: cloud: gateway: # 。。。 globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowedOrigins: # 允许哪些网站的跨域请求 -"http://localhost:8090"# allowedOrigins:"*"# 跨域处理 允许所有的域 allowedMethods: # 允许的跨域ajax的请求方式 -"GET"-"POST"-"DELETE"-"PUT"-"OPTIONS"allowedHeaders:"*"# 允许在请求中携带的头信息 allowCredentials: true # 是否允许携带cookie maxAge: 360000 # 这次跨域检测的有效期

    相关信息

    你可能还喜欢

    热门推荐信息

    初识Dockerfile

    Byqq_58647543

    Dockerfile简介 从之前的学习中我们可以了解到：镜像的定制实际上就是定制每一层所添加的配置、文件。那么如果我们可以把每一层修改、安装、构建、操作的命令都写入一个脚本，用这个脚本来构建、定制镜像 ...