微服务技术栈-Gateway服务网关

文章目录

前言
一、为什么需要网关
[二、Spring Cloud Gateway](#二、Spring Cloud Gateway)
三、断言工厂和过滤器
四、跨域问题
总结

前言

在之前的文章中我们已经介绍了微服务技术中eureka、nacos、ribbon、Feign这几个组件，接下来将介绍另外一个组件SpringCloud-Gateway，Gateway网关是我们服务的守门神，所有微服务的统一入口。

一、为什么需要网关

试着思考一下，我们后台的微服务是任何人都可以访问的吗？是否每个用户都有资格访问某个微服务？当微服务的数量越来越多时，我们该如何优雅的把每个请求转发到具体的某个微服务上？当请求的流量过大时，我们该如何泄洪？

因此我们需要一个网关服务，来帮助我们解决上述问题。

网关的核心功能特性：

请求路由 ：一切请求都必须先经过gateway，但网关不处理业务，而是根据某种规则 ，把请求转发到某个微服务，这个过程叫做路由。当然路由的目标服务有多个时，还需要做负载均衡。
权限控制 ：网关作为微服务入口，需要校验用户是是否有请求资格，如果没有则进行拦截。
限流：当请求流量过高时，在网关中按照下流的微服务能够接受的速度来放行请求 ，避免服务压力过大。

二、Spring Cloud Gateway

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式，基于响应式编程的实现，具备更好的性能。。

下面，我们就来搭建一下Spring Cloud Gateway，其基本步骤如下：
1.创建SpringBoot工程gateway，引入网关依赖。

xml 复制代码

<!--网关-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

2.编写gateway启动类。

java 复制代码

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

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

yaml 复制代码

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: # 路由断言，也就是判断请求是否符合路由规则的条件
          #  - After=2037-01-20T17:42:47.789-07:00[America/Denver]
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

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

三、断言工厂和过滤器

1.断言工厂

xml 复制代码

predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
          #  - After=2037-01-20T17:42:47.789-07:00[America/Denver]
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件,例如Path=/user/**是按照路径匹配，这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的，像这样的断言工厂在SpringCloudGateway还有十几个,有兴趣的可以自己在SpringCloudGateway的文档中学习。

2.过滤器

介绍完断言的概念之后，接下来我们来介绍一下过滤器的概念。GatewayFilter是网关中提供的一种过滤器，可以对进入网关的请求和微服务返回的响应做处理。

下面我们以请求头过滤器为例，给所有进入userservice的请求添加一个请求头。

yaml 复制代码

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: # 路由断言，也就是判断请求是否符合路由规则的条件
          #  - After=2037-01-20T17:42:47.789-07:00[America/Denver]
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
          filters: # 过滤器
            - AddRequestHeader=Truth, jinzihao is freaking awesome! # 添加请求头

注意：当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。接下来在方法中添加请求头参数，即可获取Truth的值。

java 复制代码

@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth",required = false)String truth) {
    System.out.println(truth);
    return userService.queryById(id);
}

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

yaml 复制代码

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=Truth, jinzihao is freaking awesome!

总结：过滤器对路由的请求或响应做加工处理，配置在路由下的过滤器只对当前路由的请求生效，defaultFilters是对所有路由都生效的过滤器。

3.全局过滤器

SpringCloud-Gateway中提供了很多种过滤器，但每一种过滤器的作用都是固定的，如果我们希望拦截请求并做自己的业务逻辑，则可以使用全局过滤器。
全局过滤器的定义方式是实现GlobalFilter接口，并且重写里面的filter接口。

java 复制代码

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

4.过滤器执行顺序

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

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

每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

四、跨域问题

跨域：域名不一致就是跨域，主要包括以下两种情况：

域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
域名相同，端口不同：localhost:8080和localhost:8081

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题。有关跨域问题的详情可以参考这篇文章跨域资源共享 CORS 详解

SpringCloud-Gateway解决跨域问题：在gateway服务的application.yml文件中，添加下面的配置。

yaml 复制代码

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: # 路由断言，也就是判断请求是否符合路由规则的条件
          #  - After=2037-01-20T17:42:47.789-07:00[America/Denver]
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求
          filters: # 过滤器
            - AddRequestHeader=Truth, jinzihao is freaking awesome! # 添加请求头
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求
              - "http://localhost:8090"
              - "http://www.leyou.com"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

总结

在本篇文章中，我们又介绍了微服务技术栈的另外一个技术SpringCloud-Gateway，网关具有限流、路由、权限控制等作用，其重要性不言而喻，可以在更多实践中体会网关的魅力。