SpringCloud常用组件（四）服务网关SpringCloudGateway

一.基本概念

Gateway和zuul 2.0差别不是特别大，都是采用Netty高性能通信框架，实现NIO异步非阻塞编程模型
zuul1.0使用的是BIO多线程阻塞模型，它本质上就是一个同步 Servlet，这样的模型比较简单，他都问题是多线程之间上下文切换是有开销的，线程越多开销就越大。

1.特点

• 基于 Spring 5，Project Reactor , Spring Boot 2.0
• 默认集成 Hystrix 断路器
• 默认集成 Spring Cloud DiscoveryClient
• Predicates 和 Filters 作用于特定路由，易于编写的 Predicates 和 Filters
• 支持动态路由、限流、路径重写

2.核心组件

• Filter（过滤器）：

Spring Cloud Gateway的Filter和Zuul的过滤器类似，可以在请求发出前后进行一些业务上的处理 ,这里分为两种类型的Filter，分别是Gateway Filter网关filter和Global Filter全局Filter, 他们的区别在后续会讲到。

• Route（路由）：

网关配置的基本组成模块，和Zuul的路由配置模块类似。一个Route模块由一个 ID，一个目标 URI，一组断言和一组过滤器定义。如果断言为真，则路由匹配，目标URI会被访问。说白了就是把url请求路由到对应的资源(服务)，或者说是一个请求过来Gateway应该怎么把这个请求转发给下游的微服务，转发给谁。

• Predicate（断言）：

这是一个 Java 8 的 Predicate，可以使用它来匹配来自 HTTP 请求的任何内容，例如 headers 或参数。断言的输入类型是一个 ServerWebExchange。简单理解就是处理HTTP请求的匹配规则，在什么样的请情况下才能命中资源继续访问。

二.使用

1.导入依赖

<!--服务注册与发现-->
<dependencies>
   <!--服务注册与发现-->
     <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
     </dependency>
     <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-gateway</artifactId>
     </dependency>
 </dependencies>

注：不能导入spring-boot-starter-web依赖，会冲突

2.启动类

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

3.application.yml

#注册到EurekaServer
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:1010/eureka/
  instance:
    instance-id: gateway-server:1060	#实例ID
spring:
  application:
    name: gateway-server
  cloud:
    gateway:
      discovery:
        locator:
          enabled: false #开放服务名访问方式
          lower-case-service-id: true #服务名小写
      routes:
        - id: user-server #指定服务名 "-"表示数组的一个元素
          uri: lb://user-server #去注册中心找这个服务名， “lb”负载均衡
          predicates: #断言，匹配访问的路径
            - Path=/user/**    #根据Path进行断言，服务访问路径
          filters:
            - StripPrefix=1    #请求转发的时候会去掉 /user访问路径
        - id: pay-server #指定服务名 "-"表示数组的一个元素
          uri: lb://pay-server #去注册中心找这个服务名， “lb”负载均衡
          predicates: #断言，匹配访问的路径
            - Path=/pay/**    #根据Path进行断言，服务访问路径
          filters:
            - StripPrefix=1    #请求转发的时候会去掉 /user访问路径

三.Gateway 的 Filter 过滤器

3.1.基本认知

Spring Cloud Gateway的Filter和Zuul的过滤器类似，可以在请求发出前后进行一些业务上的处理 ,这里分为`两种类型的Filter，分别是Gateway Filter网关filter和Global Filter全局Filter

3.2.自定义Gateway Filter

编写一个类实现GatewayFilter, Ordered接口（内置排序器）

public class RequestTimeFilter implements GatewayFilter, Ordered {
    private static final Log log = LogFactory.getLog(GatewayFilter.class);
    private static final String COUNT_Start_TIME = "countStartTime";

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //开始时间
        exchange.getAttributes().put(COUNT_Start_TIME, System.currentTimeMillis());
        //执行完成之后
        return chain.filter(exchange).then(
                Mono.fromRunnable(() -> {
                    //开始时间
                    Long startTime = exchange.getAttribute(COUNT_Start_TIME);
                    //结束时间
                    Long endTime=(System.currentTimeMillis() - startTime);
                    if (startTime != null) {
                        log.info(exchange.getRequest().getURI().getRawPath() + ": " + endTime + "ms");
                    }
                })
        );
    }

    @Override
    public int getOrder() {
        // 顺序，越小越先
        return 0;
    }
}

编写配置类测试方法

@Configuration
public class FilterConfig {

    //配置Filter作用于那个访问规则上
    @Bean
    public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {

        return builder.routes().route(r -> r.path("/services/user/**")
                //去掉2个前缀
                        .filters(f -> f.stripPrefix(2)
                        .filter(new RequestTimeFilter())
                        .addResponseHeader("X-Response-test", "test"))
                        .uri("lb://user-server")
                        .order(0)
                        .id("test-RequestTimeFilter")
                ).build();
    }
}

3.3.自定义GlobalFilter

创建一个类实现GlobalFilter, Ordered接口

/**
 * 登录检查
 */
@Component
public class TimeGlobleFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        List<String> token = exchange.getRequest().getHeaders().get("token");

        if(token == null || token.isEmpty()){
            //响应对象
            ServerHttpResponse response = exchange.getResponse();

            DataBuffer buffer = null;
            try {
                byte[] bytes = "请先登录".getBytes("utf-8");
                buffer = response.bufferFactory().wrap(bytes);

                // 设置完成相应，不会继续执行后面的filter
                // response.setComplete();
                response.setStatusCode(HttpStatus.UNAUTHORIZED);
                response.getHeaders().add("Content-Type","application/json;charset=UTF-8");
            } catch (UnsupportedEncodingException e) {
                e.printStackTrace();
            }

            // 把结果写给客户端
            return response.writeWith(Mono.just(buffer));
        }
        // 放行
        return chain.filter(exchange);
    }

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

记得加上@Component注解