Gateway网关的使用

Gateway服务网关

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

1、为什么需要网关

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

网关的核心功能特性：

• 请求路由

• 权限控制

• 限流

架构图：

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

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

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

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

• gateway

• zuul

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

2、gateway快速入门

网关的基本路由功能。基本步骤如下：

1. 创建SpringBoot工程gateway，引入网关依赖

2. 编写启动类

3. 编写基础配置和路由规则

4. 启动网关服务进行测试

1）创建gateway服务，引入依赖

创建服务：

引入依赖：

1.  
   <!--网关-->
2.  
   <dependency>
3.  
   <groupId>org.springframework.cloud</groupId>
4.  
   <artifactId>spring-cloud-starter-gateway</artifactId>
5.  
   </dependency>
6.  
   <!--nacos服务发现依赖-->
7.  
   <dependency>
8.  
   <groupId>com.alibaba.cloud</groupId>
9.  
   <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
10.  
    </dependency>

2）编写启动类

1.  
   package cn.lcu.gateway;
2.  
    
3.  
   import org.springframework.boot.SpringApplication;
4.  
   import org.springframework.boot.autoconfigure.SpringBootApplication;
5.  
    
6.  
   @SpringBootApplication
7.  
   public class GatewayApplication {
8.  
    
9.  
   public static void main(String[] args) {
10.  
    SpringApplication.run(GatewayApplication.class, args);
11.  
    }
12.  
    }

3）编写基础配置和路由规则

创建application.yml文件，内容如下：

1.  
   server:
2.  
   port: 10010 # 网关端口
3.  
   spring:
4.  
   application:
5.  
   name: gateway # 服务名称
6.  
   cloud:
7.  
   nacos:
8.  
   server-addr: localhost:8848 # nacos地址
9.  
   gateway:
10.  
    routes: # 网关路由配置
11.  
    - id: user-service # 路由id，自定义，只要唯一即可
12.  
    # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
13.  
    uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
14.  
    predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
15.  
    - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

将符合Path 规则的一切请求，都代理到 uri参数指定的地址。将 /user/**开头的请求，代理到lb://userservice，lb是负载均衡，根据服务名拉取服务列表，实现负载均衡。

4）重启测试

重启网关，访问http://localhost:10010/user/1时，符合/user/**规则，请求转发到uri：http://userservice/user/1，得到了结果：

5）网关路由的流程图

整个访问的流程如下：

总结：

网关搭建步骤：

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

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

路由配置包括：

1. 路由id：路由的唯一标示

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

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

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

3、断言工厂

在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件。例如Path=/user/**是按照路径匹配，这个规则是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来

处理的，像这样的断言工厂在SpringCloudGateway还有十几个:

4、过滤器工厂

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

4.1、路由过滤器的种类

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

3.4.2.请求头过滤器

以AddRequestHeader 为例来讲解。

需求：给所有进入userservice的请求添加一个请求头：Truth=lalallalalalalala!

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

1.  
   spring:
2.  
   cloud:
3.  
   gateway:
4.  
   routes:
5.  
   - id: user-service
6.  
   uri: lb://userservice
7.  
   predicates:
8.  
   - Path=/user/**
9.  
   filters: # 过滤器
10.  
    - AddRequestHeader=Truth, lalallalalalalala! # 添加请求头

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

4.3、默认过滤器

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

1.  
   spring:
2.  
   cloud:
3.  
   gateway:
4.  
   routes:
5.  
   - id: user-service
6.  
   uri: lb://userservice
7.  
   predicates:
8.  
   - Path=/user/**
9.  
   default-filters: # 默认过滤项
10.  
    - AddRequestHeader=Truth, lalallalalalalala!!

4.4、总结

过滤器的作用是什么？

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

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

defaultFilters的作用是什么？

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

5、全局过滤器

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

5.1、全局过滤器作用

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

定义方式是实现GlobalFilter接口。

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

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

• 登录状态判断

• 权限校验

• 请求限流等

5.2、自定义全局过滤器

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

• 参数中是否有authorization，

• authorization参数值是否为admin

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

实现：

在gateway中定义一个过滤器：

1.  
   package cn.lcu.gateway;
2.  
    
3.  
   import org.springframework.cloud.gateway.filter.GatewayFilterChain;
4.  
   import org.springframework.cloud.gateway.filter.GlobalFilter;
5.  
   import org.springframework.core.annotation.Order;
6.  
   import org.springframework.http.HttpStatus;
7.  
   import org.springframework.http.server.reactive.ServerHttpRequest;
8.  
   import org.springframework.http.server.reactive.ServerHttpResponse;
9.  
   import org.springframework.stereotype.Component;
10.  
    import org.springframework.util.MultiValueMap;
11.  
    import org.springframework.web.server.ServerWebExchange;
12.  
    import reactor.core.publisher.Mono;
13.  
     
14.  
    /**
15.  
    * 需求：自定义全局过滤器，拦截请求，判断请求参数是否满足下面条件1.参数中是否含有authorization，authorization值是否为admin
16.  
    *
17.  
    * @Order(-1) 值越低，优先级越高
18.  
    *
19.  
    */
20.  
    @Order(-1)
21.  
    @Component
22.  
    public class AuthorizeFilter implements GlobalFilter {
23.  
    @Override
24.  
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
25.  
    //1.获取请求参数
26.  
    ServerHttpRequest request = exchange.getRequest();
27.  
    MultiValueMap<String, String> queryParams = request.getQueryParams();
28.  
    //2.获取参数中的authorization 参数
29.  
    String auth = queryParams.getFirst("authorization");
30.  
    //3.判断参数是否等于admin
31.  
    if ("admin".equals(auth)) {
32.  
    //4.是，放行
33.  
    return chain.filter(exchange);
34.  
    }
35.  
    //5.否，拦截
36.  
    //5.1 设置状态码
37.  
    exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
38.  
    //5.2 拦截请求
39.  
    return exchange.getResponse().setComplete();
40.  
    }
41.  
    }

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排序，组织过滤器链。

6、跨域问题

6.1、什么是跨域问题

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

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

• 域名相同，端口不同：localhost:8080和localhost8081

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：https://www.ruanyifeng.com/blog/2016/04/cors.html

3.6.2.模拟跨域问题

自己定义一个前端页面发起axios请求

1.  
   <!DOCTYPE html>
2.  
   <html lang="en">
3.  
   <head>
4.  
   <meta charset="UTF-8">
5.  
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
6.  
   <meta http-equiv="X-UA-Compatible" content="ie=edge">
7.  
   <title>Document</title>
8.  
   </head>
9.  
   <body>
10.  
    <pre>
11.  
    spring:
12.  
    cloud:
13.  
    gateway:
14.  
    globalcors: # 全局的跨域处理
15.  
    add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
16.  
    corsConfigurations:
17.  
    '[/**]':
18.  
    allowedOrigins: # 允许哪些网站的跨域请求
19.  
    - "http://localhost:8090"
20.  
    - "http://www.leyou.com"
21.  
    allowedMethods: # 允许的跨域ajax的请求方式
22.  
    - "GET"
23.  
    - "POST"
24.  
    - "DELETE"
25.  
    - "PUT"
26.  
    - "OPTIONS"
27.  
    allowedHeaders: "*" # 允许在请求中携带的头信息
28.  
    allowCredentials: true # 是否允许携带cookie
29.  
    maxAge: 360000 # 这次跨域检测的有效期
30.  
    </pre>
31.  
    </body>
32.  
    <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
33.  
    <script>
34.  
    axios.get("http://localhost:10010/user/1?authorization=admin")
35.  
    .then(resp => console.log(resp.data))
36.  
    .catch(err => console.log(err))
37.  
    </script>
38.  
    </html>

放入tomcat或者nginx这样的web服务器中，启动并访问。

可以在浏览器控制台看到下面的错误：

从localhost:8090访问localhost:10010，端口不同，显然是跨域的请求。

3.6.3.解决跨域问题

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

1.  
   spring:
2.  
   cloud:
3.  
   gateway:
4.  
   # 。。。
5.  
   globalcors: # 全局的跨域处理
6.  
   add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
7.  
   corsConfigurations:
8.  
   '[/**]':
9.  
   allowedOrigins: # 允许哪些网站的跨域请求
10.  
    - "http://127.0.0.1:8090"
11.  
    allowedMethods: # 允许的跨域ajax的请求方式
12.  
    - "GET"
13.  
    - "POST"
14.  
    - "DELETE"
15.  
    - "PUT"
16.  
    - "OPTIONS"
17.  
    allowedHeaders: "*" # 允许在请求中携带的头信息
18.  
    allowCredentials: true # 是否允许携带cookie
19.  
    maxAge: 360000 # 这次跨域检测的有效期