gateway

1. gateway

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

2. 核心功能

网关的核心功能特性：

• 请求路由

• 权限控制

• 限流

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

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

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

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

• gateway

• zuul

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

3. 使用

（1）创建 SpringBoot 工程 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）编写基础配置和路由规则

server:
  port: 10010

spring:
  application:
    name: gateWay
  cloud:
    nacos:
      server-addr: 127.0.0.1:8848
    gateway:      #路由配置
      routes:
        - id: userService   #路由id，唯一标识，自定义
        #uri:  http://127.0.0.1:8081      #固定路由，无法负载均衡
          uri: lb://userService           #路由的目标地址，  lb （loadBalance）就是负载均衡，后面跟上服务名
          predicates:                     #路由断言，判断请求是否符合规则
            - Path=/user/**               #按路径进行匹配。只有符合/user/开头的才能被转到userService去
          filters:                        #路由过滤器
            - AddRequestHeader=Message,ZhangDaDa!            #j键值对，key和value用逗号间隔

        - id: orderService
          uri: lb://orderService
          predicates:                     #当条件全部满足时才能访问uri
            - Path=/order/**
            - Before=2023-04-13T15:41:23.433+08:00[Asia/Shanghai]   #在哪个时间之后

      default-filters:                    #默认过滤器，对所有服务都生效，在同等执行顺序中优先级最高
        - AddRequestHeader=id,3197102316!

路由配置包括：

• 路由id：路由的唯一标示

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

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

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

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

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

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

多个 predicates 的话，要同时满足规则。

（3）启动网关服务进行测试

通过访问网关端口。根据我们的访问路径，将请求转发到了指定服务中，实现业务功能。

3. 流程图

4. 断言工厂

我们在配置文件中写的断言规则只是字符串，这些字符串会被 Predicate Factory 读取并处理，转变为路由判断的条件。

官方文档：

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gateway-request-predicates-factories

5. 自定义断言工厂

自定义断言工厂的类名必须以：RoutePredicateFactory结尾

一定要继承AbstractRoutePredicateFactory<泛型>,泛型中的类是一个静态内部类Config

Config类中的属性来接收断言配置的数据。

重写apply方法，返回一个GatewayPredicate对象，重写test方法，在test方法中实现逻辑校验。

@Component
public class CheckRoutePredicateFactory extends AbstractRoutePredicateFactory<CheckRoutePredicateFactory.Config> {


    public CheckRoutePredicateFactory(){
        super(Config.class);
    }

    @Override
    public List<String> shortcutFieldOrder() {
        //和Config类中的属性进行绑定
        return Arrays.asList("name");
    }

    @Override
    public Predicate<ServerWebExchange> apply(Config config) {
        return new GatewayPredicate() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                if ("ZhangWei".equals(config.getName())){
                    return true;
                }
                return false;
            }
        };
    }


    //自定义参数args配置类,用于来接收断言配置的数据。
    @Validated
    public static class  Config{

        //参数需要有get set方法
        private String name;

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }
    }

}

6. 过滤器工厂

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

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

官方文档：

https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#gatewayfilter-factories

路由过滤器

例如：用AddRequestHeader给每个进入该服务的请求添加一共请求头，以key，value的形式。

 - id: userService   #路由id，唯一标识，自定义
        #uri:  http://127.0.0.1:8081     #固定路由，无法负载均衡
          uri: lb://userService     #路由的目标地址，  lb （loadBalance）就是负载均衡，后面跟上服务名
          predicates: #路由断言，判断请求是否符合规则
            - Path=/user/**       #按路径进行匹配。只有符合/user/开头的才能被转到userService去
          filters:  #某个过滤器
            - AddRequestHeader=Message,ZhangDaDa!            #j键值对，key和value用逗号间隔

默认过滤器

写在某个服务中就只针对该服务。如果写在gateway下，与routes同级，则是针对所以routes下的服务。

gateway:      #路由配置
  routes:
      ·······
  default-filters:    #默认过滤器，对所有服务都生效
   - AddRequestHeader=id,3197102316!

自定义全局过滤器

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

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

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

(1) 参数中是否有 authorization

(2) authorization 参数值是否为 admin

(3) 如果同时满足则放行，否则拦截。

//实现全局过滤器，对请求和响应进行过滤，适合自定义业务逻辑
@Component
//@Order(-1)
//表示执行该过滤器的顺序，越小越先执行, 除了用注解还能实现Ordered接口实现唯一的方法
public class AuthorizeFilter implements GlobalFilter , Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        //认证登录用户的身份是否为admin
        //1. 获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();

        //2. 获取参数中的authorization参数
        String auth = params.getFirst("authorization");

        //3. 判断参数值是否为admin,是就放行
        if ("admin".equals(auth)){
            return chain.filter(exchange);
        }
        //4，否则拦截,并且设置状态码，响应给客户  401:未登录
        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
        return exchange.getResponse().setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

自定义路由过滤器

实现方式：

(1) 实现gatewayFilter接口

(2) 继承AbstractGatewayFilterFactory类（推荐)

@Component
public class CheckGatewayFilterFactory extends AbstractGatewayFilterFactory<CheckGatewayFilterFactory.Config> implements Ordered {

    public CheckGatewayFilterFactory() {
        super(Config.class);
    }
//绑定config的属性和配置文件参数
    @Override
    public List<String> shortcutFieldOrder() {
        return Collections.singletonList("mVal");
    }

//过滤逻辑实现
    @Override
    public GatewayFilter apply(Config config) {
        return new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
                String mKey = params.getFirst("mKey");
                System.out.println(mKey);
                System.out.println(config.getmVal());
                //判断参数值一致,就放行
                 if (mKey.equals(config.getmVal())){
                    return chain.filter(exchange);
                }
              //不一致就返回
                return exchange.getResponse().setComplete();
            }
        };
    }


    @Override
    public int getOrder() {
        return 0;
    }
    public static class Config{

        private String mVal;


        public String getmVal() {
            return mVal;
        }

        public void setmVal(String mVal) {
            this.mVal = mVal;
        }
    }
}

过滤器顺序

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

请求路由后，会将三者合并到一个过滤器链（集合）中，排序后依次执行每个过滤器.

排序的规则

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

• GlobalFilter 通过实现 Ordered 接口，或者使用 @Order 注解来指定 order 值，由我们自己指定。

• 路由过滤器和 defaultFilter 的 order 由 Spring 指定，默认是按照声明顺序从1递增。

• 当过滤器的 order 值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter 的顺序执行。

7. 跨域解决

(1) 配置文件方式

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

(2) 配置类方式

@Configuration
public class CorsConfig {

    @Bean
    public CorsWebFilter webFilter(){
        CorsConfiguration config = new CorsConfiguration();
        config.addAllowedOrigin("*");           // 允许的来源
        config.addAllowedMethod("*");           //  允许的方法
        config.addAllowedHeader("*");           // 允许的请求头

        //允许访问的资源
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());
        source.registerCorsConfiguration("/**",config);

        return new CorsWebFilter(source);
    }
}

8. 整合sentinel

1. 添加依赖

<!--        sentinel整合 gateway-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
        </dependency>

<!--        sentinel-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
        </dependency>

2. 简单配置文件

#  配置sentinel   springAlibaba 2.1.6之后会有默认的配置Bean，只需要配置文件
    sentinel:
      transport:
        dashboard: 127.0.0.1:8060

3. 启动sentinel

由于sentinel是jar包的形式，需要在该目录下进入控制台输入命令:

//指定具体端口
java -Dserver.port=8060 -jar sentinel-dashboard-1.7.0.jar

可以通过.bat文件进行快速启动