Gateway服务网关

---

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

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

网关的核心功能特性：

• 请求路由
• 权限控制
• 限流

架构图：

微服务之间通过Fegin来访问，外部的访问直接访问微服务不安全，需要通过网关来控制。

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

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

• gateway
• zuul （淘汰）

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

路由流程

使用步骤

---

1. 网关依赖
2. 编写启动类
3. 编写基础配置和路由规则
4. 启动网关服务进行测试

1）引入依赖：

<!--网关-->
<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）编写启动类

package cn.itcast.gateway;

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）编写基础配置和路由规则

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

注：routes下面的id, uri, predicates的配置在idea中没有提示

# 网关端口
server:
  port: 10010
  
# 服务名称
spring:
  application:
    name: gateway 
    
  # nacos地址  
  cloud:
    nacos:
      server-addr: localhost:80 
    
    # 网关的配置
    gateway:
      routes: # 网关路由配置
        - id: userservice # 路由id，自定义，只要唯一即可
          # 方式一：路由的目标地址 http就是固定地址
          # uri: http://127.0.0.1:8081 
          # 方式二：lb就是负载均衡(load balancing)，后面跟服务名称，表示对这个服务进行路由
          uri: lb://userservice 
          predicates: # 路由断言，也就是判断请求是否符合路由规则的条件，结果通常是真或假
            - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求，符合放行

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

本例中，我们将 /user/**开头的请求，代理到lb://userservice，lb是LoadBalanced负载均衡的缩写，根据服务名拉取服务列表，实现负载均衡。注：Path后面是等于，不是冒号，这只是一个字符串

说明：routes对应的是一个List集合，每个元素是RouteDefinition

4）测试

启动网关

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

断言工厂配置

---

在配置文件中写的断言规则只是字符串，这些字符串会被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.p
Header	请求必须包含某些header	- Header=X-Request-Id, \d+
Host	请求必须是访问某个host（域名）	- Host=.somehost.org,.anotherhost.org
Method	请求方式必须是指定方式	- Method=GET,POST
Path	请求路径必须符合指定规则	- Path=/red/{segment},/blue/**多个路径之间使用逗号分隔通过大括号获取路径的{参数}信息
Query	请求参数必须包含指定参数	- Query=name, Jack或者- Query=name
RemoteAddr	请求者的ip必须是指定范围	- RemoteAddr=192.168.1.1/24
Weight	权重处理

|

过滤器工厂配置

---

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

路由过滤器

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

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

官网文档：https://docs.spring.io/spring-cloud-gateway/docs/2.2.9.RELEASE/reference/html/#the-addrequestheader-gatewayfilter-factory (opens new window)

以AddRequestHeader 为例：

需求：给所有进入userservice的请求添加一个请求头：Truth=itcast is freaking awesome!

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

注：键和值使用逗号分隔，而不是等于号

spring:
  cloud:
    gateway:
      routes:
      - id: userservice 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头

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

2. 在userservice这个微服务中使用@RequestHeader注解在方法中获取名为Truth的请求头，为了避免没有这个请求头而报错，将它required设置为false

@GetMapping("/header")
public String header(@RequestHeader(name = "Truth",required = false) String truth){
    return truth;
}

3. 重启userservice和gateway两个服务，在浏览器上查看结果

默认过滤器

如果要对所有的路由都生效，则可以将过滤器工厂写到default-filters下，修改gateway服务的application.yml文件：

1. 把上面的局部过滤器去掉
2. 配置与routes在同一级
3. 进行以下配置，格式如下：

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

运行效果是一样的

全局过滤器

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

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

定义方式是实现GlobalFilter接口，Spring定义的接口代码如下：

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

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

• 身份认证（统一鉴权）
• 请求限流等

示例需求：

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

• 参数中是否有authorization，
• authorization参数值是否为admin

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

@Order(-1) // 执行优先级 默认从1开始 越小优先级越高
@Component
public class AuthorizeFilter implements GlobalFilter {

    @Value("${leadnews.jwt.publicKeyPath}")
    private String publicKeyPath;

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 获取请求对象
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();

        // 判断请求是否为登录
        String path = request.getURI().getPath();
        if (path.contains("login")){
            // 放行
            return chain.filter(exchange);
        }

        // 否则拦截判断是否持有token以及token是否有效
        String token = request.getHeaders().getFirst("token");
        if (StringUtils.isEmpty(token)){
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            // 响应结果但不放行
            return response.setComplete();
        }
        try {
            // 获取公钥
            PublicKey publicKey = RsaUtils.getPublicKey(publicKeyPath);
            // 解密
            Payload<ApUser> infoFromToken = JwtUtils.getInfoFromToken(token, publicKey, ApUser.class);
            // 从载荷中取出userId
            Integer userId = infoFromToken.getInfo().getId();
            // 将userId存入请求头
            request.mutate().header("userId",userId.toString());
            // 放行并在返回后清理当前线程在map的内存占用 （then为请求执行返回时会执行的后置函数）
            return chain.filter(exchange).then(Mono.fromRunnable(ThreadLocalUtil::remove));
        } catch (Exception e) {
            e.printStackTrace();
            response.setStatusCode(HttpStatus.UNAUTHORIZED);
            return response.setComplete();
        }
    }

}

注：这个类要放在启动类同级或其子包，确保被Spring容器扫描到，并且放到Spring容器中。

过滤器执行顺序

三类过滤器

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

每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。

• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定
• 路由过滤器(局部)和defaultFilter(全局)，它的执行顺序默认是按照声明顺序从1递增。
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器(局部) > GlobalFilter的顺序执行。

跨域问题

---

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

• 域名不同： www.taobao.com 和  www.jd.com
• 端口不同：localhost:8080和localhost:8081
• 协议不同：https://localhost:8080和http://localhost:8080

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

从localhost:8090访问localhost:10010，端口不同，跨域请求浏览器拦截

解决跨域问题

参数说明

因为所有的微服务都要经过网关，所以不需要每个微服务都去处理，在网关中处理就可以了。

CORS方案是浏览器向服务器询问是否允许本次请求跨域，这次询问是options请求，所以要让options请求通过。但如果每次跨域请求都询问，则会导致性能下降，于是设置一个有效期，在有效期内的请求不再每次询问，而是直接允许跨域请求。

添加配置

1. 在gateway服务的application.yml文件中
2. globalcors元素在gateway的下一级
3. 注意端口号是8090，与上面的tomcat端口号要一致

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