【SpringCloud】Gateway服务网关

Gateway服务网关

Gateway网关是所有微服务的统一入口，有三大核心功能特性：请求路由、权限控制和限流

架构图：

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

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

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

一、gateway快速入门

基本步骤如下：

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

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

<!--网关-->
<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 com.example.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.编写基础配置和路由规则

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/开头就符合要求

4.启动服务进行测试

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

5.网关路由流程图

二、过滤器工厂

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

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

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

1.请求头过滤器——AddRequestHeader

给所有进入userservice的请求添加一个请求头

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=hao jiele # 添加请求头

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

2.默认过滤器

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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=hao jiale 

过滤器的作用：

①对路由的请求或响应做加工处理

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

defaultFilters的作用：

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

3.全局过滤器

对于Spring提供了31种不同的路由过滤器工厂，每一种过滤器的作用都是固定的。如果想要拦截请求，做自己的业务逻辑就没有办法实现

3.1全局过滤器的作用

全局过滤器也是处理一切进入网关的请求和微服务的响应，与GatewayFilter的作用一样。区别在于GatewayFiter通过配置定义，处理逻辑是固定的；而GlobalFilter的逻辑需要编写代码，可实现权限校验，登录状态判断等

定义方式是实现GlobalFilter接口

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

3.2自定义全局过滤器

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

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

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

在gateway中定义一个过滤器：

package com.example.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<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        MultiValueMap<String, String> 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();
    }
}

3.3过滤器的执行顺序

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

排序规则

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