1、基本环境搭建

1.1 依赖

<!--  Gatway 网关会和springMvc冲突，不能添加web依赖      -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>

<!--   gateway 依赖     -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

1.2 配置

# 端口
server:
  port: 9606

# 服务名
spring:
  application:
    name: kgcmall-gatway

  cloud:
    #nacos 配置
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

    # 网关配置
    gateway:
      routes: # 路由，是list集合，可以配置多个路由
      	#product模块
        - id: kh96_route_first # 当前route路由的唯一标识，不能重复
          #uri: http://localhost:9602 # 路由转发的目标资源地址，不支持多负载调用，不利于扩展，不推荐
          uri: lb://kgcmall96-prod # lb 从nacos注册中心的服务列表中，根据指定的服务名，调用服务，推荐用法
          predicates: # 指定路由断言配置，支持多个断言，只要断言成功（满足路由转发条件），才会执行转发到目标资源地址访问
            - Path=/prod-gateway/** # 指定path路径断言，必须满足请求地址是/prod-gateway开始，才会执行路由转发
          filters: # 指定路由过滤配置，支持多个过滤器，在断言成功，执行路由转发时，对请求和响应数据进行过滤处理
            - StripPrefix=1 # 在请求断言成功后，执行路由转发时，自动去除第一层的访问路径/prod-gateway
        #user模块
        - id: kh96_route_second
          uri: lb://kgcmall96-user
          predicates:
            - Path=/user-gateway/**
          filters:
            - StripPrefix=1

1.3 测试

1.3.1 nacos

1.3.2 请求测试

1.3.2.1 通过gateway网关调用prod模块

1.3.2.1 通过gateway网关调用user模块

2、路由Route

Route 主要由 路由id、目标uri、断言集合和过滤器集合组成，那我们简单看看这些属性到底有什么作用。

（1）id：路由标识，要求唯一，名称任意（默认值 uuid，一般不用，需要自定义）；

（2）uri：请求最终被转发到的目标地址；

（3）order： 路由优先级，数字越小，优先级越高；

（4）predicates：断言数组，即判断条件，如果返回值是boolean，则转发请求到 uri 属性指定的服务中；

（5）filters：过滤器数组，在请求传递过程中，对请求做一些修改；

3、断言 Predicate

Predicate(断言, 谓词) 用于进行条件判断，只有断言都返回真，才会真正的执行路由。

断言就是说: 在什么条件下 才能进行路由转发；

3.1 内置路由断言工厂

• 基于Datetime类型的断言工厂

  • AfterRoutePredicateFactory： 接收一个日期参数，判断请求日期是否晚于指定日期;
    • -After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]
  • BeforeRoutePredicateFactory： 接收一个日期参数，判断请求日期是否早于指定日期;
  • BetweenRoutePredicateFactory： 接收两个日期参数，判断请求日期是否在指定时间段内;

• 基于远程地址的断言工厂RemoteAddrRoutePredicateFactory

  • -RemoteAddr=192.168.1.1/24

• 基于Cookie的断言工厂CookieRoutePredicateFactory(接收两个参数，cookie 名字和一个正则表达式)

  • -Cookie=chocolate, ch

• 基于Header的断言工厂HeaderRoutePredicateFactory

  • -Header=X-Request-Id, \d+

• 基于Host的断言工厂HostRoutePredicateFactory

  • -Host=**.testhost.org

• 基于Method请求方法的断言工厂MethodRoutePredicateFactory

  • -Method=GET

• 基于Path求路径的断言工厂

  • PathRoutePredicateFactory（接收一个参数，判断请求的URI部分是否满足路径规则）
    • -Path=/foo/{segment}
  • `QueryRoutePredicateFactory·
    • -Query=baz, ba.

• 基于路由权重的断言工厂WeightRoutePredicateFactory（接收一个[组名,权重], 然后对于同一个组内的路由按照权重转发）

  • routes:

    -id: weight_route1 uri: host1 predicates:

    -Path=/product/**

    -Weight=group3, 1

    -id: weight_route2 uri: host2 predicates:

    -Path=/product/**

    -Weight= group3, 9

3.2 自定义路由断言工厂

3.2.1 自定义网关断言工厂 - 权限断言

/**
 * Created On : 28/11/2022.
 * <p>
 * Author : huayu
 * <p>
 * Description: 自定义网关断言工厂-权限断言
 */
@Component //自定义断言工厂，必须是一个组件放入容器才可以生效
public class MyAuthRoutePredicateFactory
        extends AbstractRoutePredicateFactory<MyAuthRoutePredicateFactory.Config> {

    /*
        配置项名MyAuth的配置参数值，映射到断言工厂内部类的属性名
     */
    public static final String MYAUTH_KEY = "myAuth";

    /*
        通过空参构造方法，指定静态内部类，用于接收配置文件中的配置项的内容，即断言(- myAuth=xxx)
     */
    public MyAuthRoutePredicateFactory() {
        super(MyAuthRoutePredicateFactory.Config.class);
    }

    /*
        价格核心配置文件中的自定义配置项的内容，映射到当前配置类的属性中，即Collections.singletonList(DATETIME_KEY)；指定的内部属性
     */
    public List<String> shortcutFieldOrder() {
        return Collections.singletonList(MYAUTH_KEY);
    }

    @Override
    public Predicate<ServerWebExchange> apply(MyAuthRoutePredicateFactory.Config config) {
        return new GatewayPredicate() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                //自定义权限断言业务逻辑
                if (StringUtils.isNotBlank(config.getMyAuth())) {
                    //判断自定义权限配置参数值，是否和当前指定的值一直，如果一致则断言成功，否则失败
                    return config.getMyAuth().equals("KH96");
                }
                //断言失败
                return false;

            }
        };
    }

    @Data
    public static class Config {
        private String myAuth;
    }

}

可以配置多个参数，案例：https://blog.csdn.net/qq_31155349/article/details/108557969

3.2.2 配置

3.2.2.1 正确配置成功效果

predicates:
	- MyAuth=KH96  # 自定义 权限断言 配置 (注意首字母要大写)

测试效果：

3.2.2.1 正确配置失败效果

predicates:
	- MyAuth=KHxx  # 配置错误信息

测试效果 :

4、过滤器 Filter

1 作用: 过滤器就是在请求的传递过程中,对请求和响应做一些手脚

2 生命周期: Pre Post

3 分类: 局部过滤器(作用在某一个路由上) 全局过滤器(作用全部路由上)

在Gateway中, Filter的生命周期只有两个：“pre” 和 “post”。

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

Gateway 的Filter从作用范围可分为两种: GatewayFilter与GlobalFilter。

1. GatewayFilter：应用到单个路由或者一个分组的路由上。
2. GlobalFilter：应用到所有的路由上。

4.1 内置的过滤器工厂

4.2 测试

简单测试几个；

4.2.1 AddRequestHeader

4.2.1.1 添加配置

filters: 
	- AddRequestHeader=X-Request-token,token_kh96  # 添加请求头参数，两个参数，第一个是添加请求头参数名，第二个参数值

4.2.1.2 通过路由调用的方法

@GetMapping("/mallProduct")
public KgcMallProduct mallProduct(@RequestParam Integer pid,
                                  @RequestHeader(value = "X-Request-token", required = false) String gateWayFilterToken) {
    log.info("------ 根据商品编号：{}， 查询商品详情 ------", pid);

    //通过GateWay网关滤器，增加请求头参数
    log.info("------ 通过GateWay网关滤器，增加请求头参数 X-Request-token：{} ------", gateWayFilterToken);
    // 调用业务接口，查询商品详情
    return kgcMallProductService.getMallProductById(pid);
}

4.2.1.3 测试

4.2.2 AddRequestParameter

4.2.2.1 添加配置

filters: 
	- AddRequestParameter=queryName,param_kh96 # 添加普通 请求参数 ,两个参数，第一个是添加请求头参数名，第二个参数值

4.2.2.2 通过路由调用的方法

@GetMapping("/mallProduct")
public KgcMallProduct mallProduct(@RequestParam Integer pid
                                  @RequestParam(value = "queryName", required = false) String gateWayFilterParamQueryName) {
    log.info("------ 根据商品编号：{}， 查询商品详情 ------", pid);
    
    //通过GateWay网关滤器，增加请求参数
    log.info("------ 通过GateWay网关滤器，增加请求头参数 queryName：{} ------", gateWayFilterParamQueryName);

    // 调用业务接口，查询商品详情
    return kgcMallProductService.getMallProductById(pid);
}

4.2.2.3 测试

4.3 自定义网关过滤器

如果带checkParam参数进行参数校验，如果没有携带直接放行；

4.3.1 自定义网关过滤器

/**
 * Created On : 28/11/2022.
 * <p>
 * Author : huayu
 * <p>
 * Description: 自定义网关过滤工厂 -校验过滤器
 */
@Component //自定义网关过滤工厂，必须是一个组件放入容器才可以生效
public class MyCheckGatewayFilterFactory extends AbstractGatewayFilterFactory<MyCheckGatewayFilterFactory.Config> {
    /*
        配置项名MyAuth的配置参数值，映射到断言工厂内部类的属性名
     */
    public static final String MYCHECK_KEY = "myCheck";

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

    public List<String> shortcutFieldOrder() {
        return Arrays.asList(MYCHECK_KEY);
    }

    public GatewayFilter apply(MyCheckGatewayFilterFactory.Config config) {
        return new GatewayFilter() {
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                //自定义网关过滤器实现过滤业务逻辑
                //模拟发送到网关的请求，如果请求携带参数和网关过滤器配置参数一致，放行，如果不一致，直接404
                String checkParam = exchange.getRequest().getQueryParams().getFirst("checkParam");

                //如果携带了checkParam参数  判断获取的请求参数是否和网关过滤器中配置的参数一致
                if (StringUtils.isNotBlank(checkParam)) {
                    //判断是否一致
                    if (checkParam.equals(config.getMyCheck())) {
                        //过滤器放行到目标请求
                        return chain.filter(exchange);
                    }

                    //返回404
                    exchange.getResponse().setStatusCode(HttpStatus.NOT_FOUND);

                    return exchange.getResponse().setComplete();

                }
                //没有携带参数，直接放行
                return chain.filter(exchange);
            }
        };
    }

    @Data
    public static class Config {
        private String myCheck;
    }

}

4.3.2 带正确的参数

4.3.3 带错误的参数

4.3.4 不带参数

4.4 自定义网关全局过滤(token)

4.4.1 自定义网关全局过滤(token)

携带token放行，不携带，跳转到登录页面(通过跳转到百度模拟)

/**
 * Created On : 28/11/2022.
 * <p>
 * Author : huayu
 * <p>
 * Description: 自定义网关全局过滤，实现token鉴权，实现GlobalFilter 和 Ordered接口
 */
@Component  //必须是spring组件
public class MyTokenGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //自定义全局过滤逻辑，判断请求头中们是否携带了token参数，如果带了就放行，非欧洲就就拒绝
        if (StringUtils.isBlank(exchange.getRequest().getHeaders().getFirst("token"))) {
            //没有携带token,直接重定向到登录页
            //模拟重定向到单点登录网址，临时用百度
            String redirectUrl = "https://www.baidu.com";

            ServerHttpResponse response = exchange.getResponse();
            response.setStatusCode(HttpStatus.SEE_OTHER); //303 错误，重定向
            response.getHeaders().set(HttpHeaders.LOCATION, redirectUrl);

            //结束响应
            return response.setComplete();
        }
        //代了token,
        //TODO token校验
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        //指定全局过滤器的优先级，值越小，优先级越高
        return 0;
    }
}

4.4.2 携带token

4.4.2 不携带token

出处：https://www.cnblogs.com/xiaoqigui/p/16934368.html