SpringCloud之服务网关Gateway，入门+实操

SpringCloudAlibaba微服务实战教程系列

Spring Cloud 微服务架构学习记录与示例

一、 GateWay简介

　　Spring Cloud GateWay是Spring Cloud的⼀个全新项⽬，⽬标是取代Netflflix Zuul，它基于Spring5.0+SpringBoot2.0+WebFlux（基于⾼性能的Reactor模式响应式通信框架Netty，异步⾮阻塞模型）等技术开发，性能⾼于Zuul，官⽅测试，GateWay是Zuul的1.6倍，旨在为微服务架构提供⼀种简单有效的统⼀的API路由管理⽅式。Spring Cloud GateWay不仅提供统⼀的路由⽅式（反向代理）并且基于 Filter(定义过滤器对请求过滤，完成⼀些功能) 链的⽅式提供了⽹关基本的功能，例如：鉴权、流量控制、熔断、路径重写、⽇志监控等。

⽹关在架构中的位置

 

二、 GateWay核⼼概念

Zuul1.x 阻塞式IO 2.x 基于Netty

Spring Cloud GateWay天⽣就是异步⾮阻塞的，基于Reactor模型

⼀个请求—>⽹关根据⼀定的条件匹配—匹配成功之后可以将请求转发到指定的服务地址；⽽在这个过程中，我们可以进⾏⼀些⽐较具体的控制（限流、⽇志、⿊⽩名单）

• 路由（route）： ⽹关最基础的部分，也是⽹关⽐较基础的⼯作单元。路由由⼀个ID、⼀个⽬标URL（最终路由到的地址）、⼀系列的断⾔（匹配条件判断）和Filter过滤器（精细化控制）组成。如果断⾔为true，则匹配该路由。
• 断⾔（predicates）：参考了Java8中的断⾔java.util.function.Predicate，开发⼈员可以匹配Http请求中的所有内容（包括请求头、请求参数等）（类似于nginx中的location匹配⼀样），如果断⾔与请求相匹配则路由。
• 过滤器（fifilter）：⼀个标准的Spring webFilter，使⽤过滤器，可以在请求之前或者之后执⾏业务逻辑。

三、GateWay⼯作过程

　　客户端向Spring Cloud GateWay发出请求，然后在GateWay Handler Mapping中找到与请求相匹配的路由，将其发送到GateWay Web Handler；Handler再通过指定的过滤器链来将请求发送到我们实际的服务执⾏业务逻辑，然后返回。过滤器之间⽤虚线分开是因为过滤器可能会在发送代理请求之前（pre）或者之后（post）执⾏业务逻辑。

　　Filter在“pre”类型过滤器中可以做参数校验、权限校验、流量监控、⽇志输出、协议转换等，在“post”类型的过滤器中可以做响应内容、响应头的修改、⽇志的输出、流量监控等。

　　GateWay核⼼逻辑：路由转发+执⾏过滤器链

四、应用

第一步、引入pom，注意使用的不是spring-mvc，只需要引入webflux即可

<!--GateWay ⽹关-->
<dependency> 
　　<groupId>org.springframework.cloud</groupId>
　　<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--引⼊webflux-->
<dependency> 
　　<groupId>org.springframework.boot</groupId> 
　　<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

第二步、配置配置文件

1、时间点前匹配

spring:
  cloud:
    gateway:
      routes:
       - id: after_route
        uri: http://ityouknow.com
        predicates:
         - Before=2018-01-20T06:06:06+08:00[Asia/Shanghai]

2、时间点后匹配

spring:
  cloud:
    gateway:
      routes:
       - id: time_route
        uri: http://ityouknow.com
        predicates:
         - After=2018-01-20T06:06:06+08:00[Asia/Shanghai]

3、时间区间匹配

spring:
  cloud:
    gateway:
      routes:
       - id: after_route
        uri: http://ityouknow.com
        predicates:
         - Between=2018-01-20T06:06:06+08:00[Asia/Shanghai], 2019-01-20T06:06:06+08:00[Asia/Shanghai]

4、指定Cookie正则匹配指定值

spring:
  cloud:
    gateway:
      routes:
       - id: cookie_route
         uri: http://ityouknow.com
         predicates:
         - Cookie=ityouknow, kee.e

5、指定Header正则匹配指定值

spring:
  cloud:
    gateway:
      routes:
      - id: header_route
        uri: http://ityouknow.com
        predicates:
        - Header=X-Request-Id, \d+

6、请求Host匹配指定值

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://ityouknow.com
        predicates:
        - Host=**.ityouknow.com

7、请求Method匹配指定请求⽅式

spring:
  cloud:
    gateway:
      routes:
      - id: method_route
        uri: http://ityouknow.com
        predicates:
        - Method=GET

8、请求路径正则匹配

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://ityouknow.com
        predicates:
        - Path=/foo/{segment}

9、请求包含某参数

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://ityouknow.com
        predicates:
        - Query=smile

10、请求包含某参数并且参数值匹配正则表达式

spring:
  cloud:
    gateway:
      routes:
      - id: query_route
        uri: http://ityouknow.com
        predicates:
        - Query=keep, pu.

11、远程地址IP匹配

spring:
  cloud:
    gateway:
      routes:
      - id: remoteaddr_route
        uri: http://ityouknow.com
        predicates:
        - RemoteAddr=192.168.1.1/24

注意：如果是注册中心配置，那需要uri更换为：  lb://服务名，同时需要引入客户端pom，和配置客户端注册中心配置。

五、过滤器

从过滤器⽣命周期（影响时机点）的⻆度来说，主要有两个pre和post：

• pre：这种过滤器在请求被路由之前调⽤。我们可利⽤这种过滤器实现身份验证、在集群中选择 请求的微服务、记录调试信息等。
• post：这种过滤器在路由到微服务以后执⾏。这种过滤器可⽤来为响应添加标准的 HTTPHeader、收集统计信息和指标、将响应从微服务发送给客户端等。

从过滤器类型的⻆度，Spring Cloud GateWay的过滤器分为GateWayFilter和GlobalFilter两种

• GateWayFilter 应⽤到单个路由路由上
• GlobalFilter全局过滤器、应⽤到所有的路由上。实现的时候只需要实现GlobalFilter接口即可，有时候添加Ordered接口，设置拦截器的优先级，数值越⼩，优先级越⾼

如Gateway Filter可以去掉url中的占位后转发路由，⽐如

spring:
  cloud:
    gateway:
      routes:
      - id: service-user8080
        uri: lb://service-user8080
        predicates:
        - Path=/api/user
        filters:
        - StripPrefix=1 #去掉path第一个路径参数在进行转发

1、GateWayFilter单个路由上

　　实现GateWayFilter 接口

package city.albert.filter;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.core.Ordered;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * @author niunafei
 * @function
 * @email niunafei0315@163.com
 * @date 2020/9/23  1:26 AM
 */
public class IpFilter implements GatewayFilter, Ordered {
    Logger logger = LoggerFactory.getLogger(IpFilter.class);

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        HttpHeaders httpHeaders = exchange.getResponse().getHeaders();
        //返回数据格式
        httpHeaders.setContentType(MediaType.APPLICATION_JSON);

        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        // 从request对象中获取客户端ip

        logger.info("拦截处理业务");
        return chain.filter(exchange);
    }

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

　　配置生效

package city.albert.config;

import city.albert.filter.IpFilter;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author niunafei
 * @function
 * @email niunafei0315@163.com
 * @date 2020/9/23  2:03 AM
 */
@Configuration
public class GateWayConfig {

    @Bean
    public RouteLocator customerRouteLocator(RouteLocatorBuilder builder) {
        RouteLocator build = builder.routes()
                //设置拦截接口
                .route(r -> r.path("/api/user/register/**")
                        //去除路径上第一个参数/api
                        .filters(f -> f.stripPrefix(1)
                                //自定义的filetr
                                .filter(new IpFilter())
                                .addResponseHeader("X-Response-Default-Foo", "Default-Bar"))
                        .uri("lb://lagou-service-user8080")
                        .order(0)
                        .id("lagou-service-user80801")
                )
                .build();
        return build;
    }

}

2、全局生效

package city.albert.filter;

import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;

/**
 * @author niunafei
 * @function
 * @email niunafei0315@163.com
 * @date 2020/9/24  1:46 AM
 */
@Configuration
public class AutoFilter {

    @Bean
    @Order(10)
    public GlobalFilter b() {
        return (exchange, chain) -> {
            HttpHeaders httpHeaders = exchange.getResponse().getHeaders();
            //返回数据格式
            httpHeaders.setContentType(MediaType.APPLICATION_JSON);
            ServerHttpRequest request = exchange.getRequest();
            ServerHttpResponse response = exchange.getResponse();

            //业务逻辑

            return chain.filter(exchange);
        };
    }

}

路由配置：https://blog.csdn.net/rain_web/article/details/102469745

过滤器：https://blog.csdn.net/lizhiqiang1217/article/details/90576228