自定义断言

本文介绍了如何在Spring Cloud Gateway中创建一个自定义断言工厂,用于根据用户年龄进行路由过滤。通过配置文件设置年龄范围,并在代码中实现断言逻辑,确保只有年龄在18到60之间的请求才能通过网关访问特定服务。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

使用方法

修改配置文件

server:
  port: 8000

spring:
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
    gateway:
      routes:
        - id: shop-product
          uri: lb://shop-product
          order: 0
          predicates:
           - Path=/product/**
           - Age=18,60
  application:
    name: my-gateway



2.创建自定义断言的类

package com.xp.geteway;

import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;

import org.springframework.cloud.gateway.handler.predicate.GatewayPredicate;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.server.ServerWebExchange;

import javax.validation.constraints.NotNull;
import java.time.ZonedDateTime;
import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

/**
 * @program: spring-cloud
 * @description: 这是一个自定义断言
 *
 * @author: 许鹏
 * @create: 2021-07-08 15:38
 **/
@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> {
    public static final String DATETIME1_KEY = "datetime1";
    public static final String DATETIME2_KEY = "datetime2";

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

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("minAge", "maxAge");
    }

    @Override
    public Predicate<ServerWebExchange> apply(AgeRoutePredicateFactory.Config config) {
        return new GatewayPredicate() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                ServerHttpRequest request = serverWebExchange.getRequest();
                String age=request.getQueryParams().getFirst("age");
                if (StringUtils.isEmpty(age)){
                    return false;
                }else {
                    Integer a=Integer.parseInt(age);
                    if (a>=config.getMinAge()&&a<=config.getMaxAge()){
                        return true;
                    }else {
                        return false;
                    }
                }
            }


        };
    }



    @Validated
    public static class Config {
        @NotNull
        private Integer minAge;
        @NotNull
        private Integer maxAge;

        public Integer getMinAge() {
            return minAge;
        }

        public void setMinAge(Integer minAge) {
            this.minAge = minAge;
        }

        public Integer getMaxAge() {
            return maxAge;
        }

        public void setMaxAge(Integer maxAge) {
            this.maxAge = maxAge;
        }
    }
}

3.启动后观察 年龄大于18小于60的能访问,其余的不可以

<think>嗯,用户问的是关于Spring Cloud Gateway的自定义断言。我需要先回忆一下Gateway的基本概念,断言的作用是什么。断言主要用于路由匹配,根据请求的不同条件来决定是否路由到某个服务。 首先,应该解释什么是自定义断言,可能用户已经了解内置的断言,比如Path、Query这些,但需要扩展自己的逻辑。然后,步骤应该是如何创建自定义断言,可能需要实现特定的接口,比如RoutePredicateFactory。 接下来,要考虑用户可能的疑问点,比如如何注册自定义断言到Spring容器,配置文件中如何引用。还要注意命名的规范,因为Spring Cloud Gateway的断言工厂命名有特定规则,比如XXXRoutePredicateFactory,配置的时候用XXX=参数。 可能需要一个具体的例子来说明,比如基于请求时间的断言。这样用户更容易理解。同时,要提醒注意事项,比如配置的key要和工厂名前缀一致,确保Spring能够正确识别。 另外,是否需要提到版本兼容性?或者常见的错误,比如配置错误导致断言不生效?可能用户在实际操作中会遇到这些问题,所以注意事项部分可以包括这些内容。 最后,总结一下自定义断言的应用场景,比如灰度发布、特定Header校验等,让用户知道什么时候需要用到它。确保整个回答结构清晰,步骤明确,示例具体,注意事项全面。</think>Spring Cloud Gateway 的自定义断言是用于扩展路由匹配规则的核心机制,下面通过结构化的步骤为您讲解实现原理和操作方法: ### 一、断言的作用原理 1. **路由匹配**:每个路由可配置多个断言,全部满足时触发路由 2. **执行顺序**:位于过滤器链之前,先进行请求匹配,再执行过滤逻辑 3. **内置断言**:包含 Path、Method、Header 等 12 种官方实现 ### 二、实现自定义断言(3个核心步骤) #### 1. 创建断言工厂类 ```java @Component public class CustomTimePredicateFactory extends AbstractRoutePredicateFactory<CustomTimePredicateFactory.Config> { // 必须的构造函数 public CustomTimePredicateFactory() { super(Config.class); } // 断言逻辑实现 @Override public Predicate<ServerWebExchange> apply(Config config) { return exchange -> { LocalTime now = LocalTime.now(); return now.isAfter(config.start) && now.isBefore(config.end); }; } // 配置参数类 @Validated public static class Config { private LocalTime start; private LocalTime end; // 必须的getter/setter } // 参数绑定(关键步骤) @Override public List<String> shortcutFieldOrder() { return Arrays.asList("start", "end"); } } ``` #### 2. 配置路由规则(application.yml) ```yaml spring: cloud: gateway: routes: - id: time_route uri: http://example.org predicates: - name: CustomTime # 自动匹配XXXRoutePredicateFactory args: start: 09:00:00 end: 17:00:00 ``` #### 3. 命名规范要求 - 类名必须遵循 `[YourName]RoutePredicateFactory` 格式 - 配置文件中的 `name` 值对应类名前缀(如 `CustomTime` 对应 `CustomTimeRoutePredicateFactory`) ### 三、典型应用场景 1. **灰度发布控制**:基于设备类型或用户分组路由 2. **地域路由**:根据 IP 解析的地理位置分配服务 3. **协议版本校验**:检查特定 header 中的版本号 4. **流量采样**:按百分比随机路由到新版本服务
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值