• SpringCloudGateway--谓词（断言）

    目录

    一、定义

    二、谓词使用

    1、After

    2、Before

    3、Between

    4、Cookie

    5、Header

    6、Host

    7、Method

    8、Path

    9、Query 

    10、RemoteAddr

    11、Weight

    一、定义

            SpringCloudGateway中三个重要词汇：

            路由（Route）：配置网关中的一个完整路由，包括命名，地址，谓词集合（规则），过滤器集合。

            谓词、断言（Predicate）：这是一个 Java 8 函数谓词。输入类型是一个 Spring 框架的 ServerWebExchange。这允许开发人员匹配来自 HTTP 请求的任何内容，例如头部或参数。简单说就是看发送的请求url中是否符合谓词中的规则，符合就通过，不符合就进行拦截。

            过滤器（Filter）：这些是 Spring 框架网关过滤器在特定工厂中构建的实例。这里，可以在发送下游请求之前或之后修改请求和响应。简单说就是负责在代理服务之前或是之后做的一些事情。

    二、谓词使用

            Gateway中有很多已经实现好的谓词，可以查看GatewayPredicate下的实现类：

            接下来单独用这11个实现类举例，Gateway项目可以参考：SpringCloudGateway--自动路由映射与手动路由映射_雨欲语的博客-CSDN博客

    1、After

            在指定时间之后，顾名思义就是只有在指定时间之后的请求才会生效：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.       - After=2022-11-26T00:00:00.000+08:00[Asia/Shanghai]
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms

            进入AfterRoutePredicateFactory实现里面，可以看到是由工厂方法加匿名内部类实现：

            在SpringCloudGateway中可以找到加载这些实现类的工厂方法：

            其余的实现类也是同理 

    2、Before

            指定时间之前,只有在指定时间之前的请求才会生效：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.       - Before=2022-11-26T00:00:00.000+08:00[Asia/Shanghai]
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms

          

    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.time.ZonedDateTime;
    4. import java.util.Collections;
    5. import java.util.List;
    6. import java.util.function.Predicate;
    7.  
    8. import org.springframework.web.server.ServerWebExchange;
    9.  
    10. /**
    11.  * @author Spencer Gibb
    12.  */
    13. public class BeforeRoutePredicateFactory extends AbstractRoutePredicateFactory {
    14.  
    15. 	/**
    16. 	 * DateTime key.
    17. 	 */
    18. 	public static final String DATETIME_KEY = "datetime";
    19.  
    20. 	public BeforeRoutePredicateFactory() {
    21. 		super(Config.class);
    22. 	}
    23.  
    24. 	@Override
    25. 	public List shortcutFieldOrder() {
    26. 		return Collections.singletonList(DATETIME_KEY);
    27. 	}
    28.  
    29. 	@Override
    30. 	public Predicate apply(Config config) {
    31. 		return new GatewayPredicate() {
    32. 			@Override
    33. 			public boolean test(ServerWebExchange serverWebExchange) {
    34. 				final ZonedDateTime now = ZonedDateTime.now();
    35. 				return now.isBefore(config.getDatetime());
    36. 			}
    37.  
    38. 			@Override
    39. 			public String toString() {
    40. 				return String.format("Before: %s", config.getDatetime());
    41. 			}
    42. 		};
    43. 	}
    44.  
    45. 	public static class Config {
    46.  
    47. 		private ZonedDateTime datetime;
    48.  
    49. 		public ZonedDateTime getDatetime() {
    50. 			return datetime;
    51. 		}
    52.  
    53. 		public void setDatetime(ZonedDateTime datetime) {
    54. 			this.datetime = datetime;
    55. 		}
    56.  
    57. 	}
    58.  
    59. }

    3、Between

            需要在设定的时间范围之内才能进行请求转发：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.       - Between=2022-11-26T00:00:00.000+08:00[Asia/Shanghai],2022-11-30T00:00:00.000+08:00[Asia/Shanghai]
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms

            源码：

    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.time.ZonedDateTime;
    4. import java.util.Arrays;
    5. import java.util.List;
    6. import java.util.function.Predicate;
    7.  
    8. import javax.validation.constraints.NotNull;
    9.  
    10. import org.springframework.util.Assert;
    11. import org.springframework.validation.annotation.Validated;
    12. import org.springframework.web.server.ServerWebExchange;
    13.  
    14. /**
    15.  * @author Spencer Gibb
    16.  */
    17. public class BetweenRoutePredicateFactory extends AbstractRoutePredicateFactory {
    18.  
    19. 	/**
    20. 	 * DateTime 1 key.
    21. 	 */
    22. 	public static final String DATETIME1_KEY = "datetime1";
    23.  
    24. 	/**
    25. 	 * DateTime 2 key.
    26. 	 */
    27. 	public static final String DATETIME2_KEY = "datetime2";
    28.  
    29. 	public BetweenRoutePredicateFactory() {
    30. 		super(Config.class);
    31. 	}
    32.  
    33. 	@Override
    34. 	public List shortcutFieldOrder() {
    35. 		return Arrays.asList(DATETIME1_KEY, DATETIME2_KEY);
    36. 	}
    37.  
    38. 	@Override
    39. 	public Predicate apply(Config config) {
    40. 		Assert.isTrue(config.getDatetime1().isBefore(config.getDatetime2()),
    41. 				config.getDatetime1() + " must be before " + config.getDatetime2());
    42.  
    43. 		return new GatewayPredicate() {
    44. 			@Override
    45. 			public boolean test(ServerWebExchange serverWebExchange) {
    46. 				final ZonedDateTime now = ZonedDateTime.now();
    47. 				return now.isAfter(config.getDatetime1()) && now.isBefore(config.getDatetime2());
    48. 			}
    49.  
    50. 			@Override
    51. 			public String toString() {
    52. 				return String.format("Between: %s and %s", config.getDatetime1(), config.getDatetime2());
    53. 			}
    54. 		};
    55. 	}
    56.  
    57. 	@Validated
    58. 	public static class Config {
    59.  
    60. 		@NotNull
    61. 		private ZonedDateTime datetime1;
    62.  
    63. 		@NotNull
    64. 		private ZonedDateTime datetime2;
    65.  
    66. 		public ZonedDateTime getDatetime1() {
    67. 			return datetime1;
    68. 		}
    69.  
    70. 		public Config setDatetime1(ZonedDateTime datetime1) {
    71. 			this.datetime1 = datetime1;
    72. 			return this;
    73. 		}
    74.  
    75. 		public ZonedDateTime getDatetime2() {
    76. 			return datetime2;
    77. 		}
    78.  
    79. 		public Config setDatetime2(ZonedDateTime datetime2) {
    80. 			this.datetime2 = datetime2;
    81. 			return this;
    82. 		}
    83.  
    84. 	}
    85.  
    86. }

    4、Cookie

            要求请求中包含指定Cookie名和满足特定正则要求的值，Cookie必须有两个值，第一个Cookie包含的参数名，第二个表示参数对应的值，正则表达式：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Cookie=username,admin*
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.Arrays;
    4. import java.util.List;
    5. import java.util.function.Predicate;
    6.  
    7. import javax.validation.constraints.NotEmpty;
    8.  
    9. import org.springframework.http.HttpCookie;
    10. import org.springframework.validation.annotation.Validated;
    11. import org.springframework.web.server.ServerWebExchange;
    12.  
    13. /**
    14.  * @author Spencer Gibb
    15.  */
    16. public class CookieRoutePredicateFactory extends AbstractRoutePredicateFactory {
    17.  
    18. 	/**
    19. 	 * Name key.
    20. 	 */
    21. 	public static final String NAME_KEY = "name";
    22.  
    23. 	/**
    24. 	 * Regexp key.
    25. 	 */
    26. 	public static final String REGEXP_KEY = "regexp";
    27.  
    28. 	public CookieRoutePredicateFactory() {
    29. 		super(Config.class);
    30. 	}
    31.  
    32. 	@Override
    33. 	public List shortcutFieldOrder() {
    34. 		return Arrays.asList(NAME_KEY, REGEXP_KEY);
    35. 	}
    36.  
    37. 	@Override
    38. 	public Predicate apply(Config config) {
    39. 		return new GatewayPredicate() {
    40. 			@Override
    41. 			public boolean test(ServerWebExchange exchange) {
    42. 				List cookies = exchange.getRequest().getCookies().get(config.name);
    43. 				if (cookies == null) {
    44. 					return false;
    45. 				}
    46. 				for (HttpCookie cookie : cookies) {
    47. 					if (cookie.getValue().matches(config.regexp)) {
    48. 						return true;
    49. 					}
    50. 				}
    51. 				return false;
    52. 			}
    53.  
    54. 			@Override
    55. 			public String toString() {
    56. 				return String.format("Cookie: name=%s regexp=%s", config.name, config.regexp);
    57. 			}
    58. 		};
    59. 	}
    60.  
    61. 	@Validated
    62. 	public static class Config {
    63.  
    64. 		@NotEmpty
    65. 		private String name;
    66.  
    67. 		@NotEmpty
    68. 		private String regexp;
    69.  
    70. 		public String getName() {
    71. 			return name;
    72. 		}
    73.  
    74. 		public Config setName(String name) {
    75. 			this.name = name;
    76. 			return this;
    77. 		}
    78.  
    79. 		public String getRegexp() {
    80. 			return regexp;
    81. 		}
    82.  
    83. 		public Config setRegexp(String regexp) {
    84. 			this.regexp = regexp;
    85. 			return this;
    86. 		}
    87.  
    88. 	}
    89.  
    90. }

    5、Header

            表示请求头中必须包含的内容。

            注意：参数名和参数值之间依然使用逗号，参数值要使用正则表达式

            如果Header只有一个值表示请求头中必须包含的参数。如果有两个值，第一个表示请求头必须包含的参数名，第二个表示请求头参数对应值。

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Header=Connection,keep-alive
    6.        - Header=Cache-Control,max-age=0
    7.     filters:
    8.       - StripPrefix=1
    9.     metadata:
    10.       connect-timeout: 15000 #ms
    11.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.Arrays;
    4. import java.util.Collections;
    5. import java.util.List;
    6. import java.util.function.Predicate;
    7.  
    8. import javax.validation.constraints.NotEmpty;
    9.  
    10. import org.springframework.util.ObjectUtils;
    11. import org.springframework.validation.annotation.Validated;
    12. import org.springframework.web.server.ServerWebExchange;
    13.  
    14. /**
    15.  * @author Spencer Gibb
    16.  */
    17. public class HeaderRoutePredicateFactory extends AbstractRoutePredicateFactory {
    18.  
    19. 	/**
    20. 	 * Header key.
    21. 	 */
    22. 	public static final String HEADER_KEY = "header";
    23.  
    24. 	/**
    25. 	 * Regexp key.
    26. 	 */
    27. 	public static final String REGEXP_KEY = "regexp";
    28.  
    29. 	public HeaderRoutePredicateFactory() {
    30. 		super(Config.class);
    31. 	}
    32.  
    33. 	@Override
    34. 	public List shortcutFieldOrder() {
    35. 		return Arrays.asList(HEADER_KEY, REGEXP_KEY);
    36. 	}
    37.  
    38. 	@Override
    39. 	public Predicate apply(Config config) {
    40. 		boolean hasRegex = !ObjectUtils.isEmpty(config.regexp);
    41.  
    42. 		return new GatewayPredicate() {
    43. 			@Override
    44. 			public boolean test(ServerWebExchange exchange) {
    45. 				List values = exchange.getRequest().getHeaders().getOrDefault(config.header,
    46. 						Collections.emptyList());
    47. 				if (values.isEmpty()) {
    48. 					return false;
    49. 				}
    50. 				// values is now guaranteed to not be empty
    51. 				if (hasRegex) {
    52. 					// check if a header value matches
    53. 					for (int i = 0; i < values.size(); i++) {
    54. 						String value = values.get(i);
    55. 						if (value.matches(config.regexp)) {
    56. 							return true;
    57. 						}
    58. 					}
    59. 					return false;
    60. 				}
    61.  
    62. 				// there is a value and since regexp is empty, we only check existence.
    63. 				return true;
    64. 			}
    65.  
    66. 			@Override
    67. 			public String toString() {
    68. 				return String.format("Header: %s regexp=%s", config.header, config.regexp);
    69. 			}
    70. 		};
    71. 	}
    72.  
    73. 	@Validated
    74. 	public static class Config {
    75.  
    76. 		@NotEmpty
    77. 		private String header;
    78.  
    79. 		private String regexp;
    80.  
    81. 		public String getHeader() {
    82. 			return header;
    83. 		}
    84.  
    85. 		public Config setHeader(String header) {
    86. 			this.header = header;
    87. 			return this;
    88. 		}
    89.  
    90. 		public String getRegexp() {
    91. 			return regexp;
    92. 		}
    93.  
    94. 		public Config setRegexp(String regexp) {
    95. 			this.regexp = regexp;
    96. 			return this;
    97. 		}
    98.  
    99. 	}
    100.  
    101. }

    6、Host

            匹配请求参数中Host参数的值，可以有多个，使用逗号隔开,**表示支持模糊匹配：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Host=127.0.0.1:8080,**.test.com
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.ArrayList;
    4. import java.util.Collections;
    5. import java.util.List;
    6. import java.util.Map;
    7. import java.util.function.Predicate;
    8.  
    9. import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
    10. import org.springframework.core.style.ToStringCreator;
    11. import org.springframework.util.AntPathMatcher;
    12. import org.springframework.util.PathMatcher;
    13. import org.springframework.validation.annotation.Validated;
    14. import org.springframework.web.server.ServerWebExchange;
    15.  
    16. /**
    17.  * @author Spencer Gibb
    18.  */
    19. public class HostRoutePredicateFactory extends AbstractRoutePredicateFactory {
    20.  
    21. 	private PathMatcher pathMatcher = new AntPathMatcher(".");
    22.  
    23. 	public HostRoutePredicateFactory() {
    24. 		super(Config.class);
    25. 	}
    26.  
    27. 	public void setPathMatcher(PathMatcher pathMatcher) {
    28. 		this.pathMatcher = pathMatcher;
    29. 	}
    30.  
    31. 	@Override
    32. 	public List shortcutFieldOrder() {
    33. 		return Collections.singletonList("patterns");
    34. 	}
    35.  
    36. 	@Override
    37. 	public ShortcutType shortcutType() {
    38. 		return ShortcutType.GATHER_LIST;
    39. 	}
    40.  
    41. 	@Override
    42. 	public Predicate apply(Config config) {
    43. 		return new GatewayPredicate() {
    44. 			@Override
    45. 			public boolean test(ServerWebExchange exchange) {
    46. 				String host = exchange.getRequest().getHeaders().getFirst("Host");
    47. 				String match = null;
    48. 				for (int i = 0; i < config.getPatterns().size(); i++) {
    49. 					String pattern = config.getPatterns().get(i);
    50. 					if (pathMatcher.match(pattern, host)) {
    51. 						match = pattern;
    52. 						break;
    53. 					}
    54. 				}
    55.  
    56. 				if (match != null) {
    57. 					Map variables = pathMatcher.extractUriTemplateVariables(match, host);
    58. 					ServerWebExchangeUtils.putUriTemplateVariables(exchange, variables);
    59. 					return true;
    60. 				}
    61.  
    62. 				return false;
    63. 			}
    64.  
    65. 			@Override
    66. 			public String toString() {
    67. 				return String.format("Hosts: %s", config.getPatterns());
    68. 			}
    69. 		};
    70. 	}
    71.  
    72. 	@Validated
    73. 	public static class Config {
    74.  
    75. 		private List patterns = new ArrayList<>();
    76.  
    77. 		public List getPatterns() {
    78. 			return patterns;
    79. 		}
    80.  
    81. 		public Config setPatterns(List patterns) {
    82. 			this.patterns = patterns;
    83. 			return this;
    84. 		}
    85.  
    86. 		@Override
    87. 		public String toString() {
    88. 			return new ToStringCreator(this).append("patterns", patterns).toString();
    89. 		}
    90.  
    91. 	}
    92.  
    93. }

    7、Method

            Method表示请求方式。支持多个值，使用逗号分隔，多个值之间为or条件

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Method=GET,POST # 表示只允许GET or POST请求通过
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.Arrays;
    4. import java.util.List;
    5. import java.util.function.Predicate;
    6.  
    7. import org.springframework.http.HttpMethod;
    8. import org.springframework.validation.annotation.Validated;
    9. import org.springframework.web.server.ServerWebExchange;
    10.  
    11. import static java.util.Arrays.stream;
    12.  
    13. /**
    14.  * @author Spencer Gibb
    15.  * @author Dennis Menge
    16.  */
    17. public class MethodRoutePredicateFactory extends AbstractRoutePredicateFactory {
    18.  
    19. 	/**
    20. 	 * Methods key.
    21. 	 */
    22. 	public static final String METHODS_KEY = "methods";
    23.  
    24. 	public MethodRoutePredicateFactory() {
    25. 		super(Config.class);
    26. 	}
    27.  
    28. 	@Override
    29. 	public List shortcutFieldOrder() {
    30. 		return Arrays.asList(METHODS_KEY);
    31. 	}
    32.  
    33. 	@Override
    34. 	public ShortcutType shortcutType() {
    35. 		return ShortcutType.GATHER_LIST;
    36. 	}
    37.  
    38. 	@Override
    39. 	public Predicate apply(Config config) {
    40. 		return new GatewayPredicate() {
    41. 			@Override
    42. 			public boolean test(ServerWebExchange exchange) {
    43. 				HttpMethod requestMethod = exchange.getRequest().getMethod();
    44. 				return stream(config.getMethods()).anyMatch(httpMethod -> httpMethod == requestMethod);
    45. 			}
    46.  
    47. 			@Override
    48. 			public String toString() {
    49. 				return String.format("Methods: %s", Arrays.toString(config.getMethods()));
    50. 			}
    51. 		};
    52. 	}
    53.  
    54. 	@Validated
    55. 	public static class Config {
    56.  
    57. 		private HttpMethod[] methods;
    58.  
    59. 		public HttpMethod[] getMethods() {
    60. 			return methods;
    61. 		}
    62.  
    63. 		public void setMethods(HttpMethod... methods) {
    64. 			this.methods = methods;
    65. 		}
    66.  
    67. 	}
    68.  
    69. }

    8、Path

            请求url包含的路径，这种是使用得最多的一种,路径可以配置多个，用逗号隔开。

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Path=/service/**,/server/**
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.ArrayList;
    4. import java.util.Arrays;
    5. import java.util.List;
    6. import java.util.function.Predicate;
    7.  
    8. import org.apache.commons.logging.Log;
    9. import org.apache.commons.logging.LogFactory;
    10.  
    11. import org.springframework.core.style.ToStringCreator;
    12. import org.springframework.http.server.PathContainer;
    13. import org.springframework.validation.annotation.Validated;
    14. import org.springframework.web.server.ServerWebExchange;
    15. import org.springframework.web.util.pattern.PathPattern;
    16. import org.springframework.web.util.pattern.PathPattern.PathMatchInfo;
    17. import org.springframework.web.util.pattern.PathPatternParser;
    18.  
    19. import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.putUriTemplateVariables;
    20. import static org.springframework.http.server.PathContainer.parsePath;
    21.  
    22. /**
    23.  * @author Spencer Gibb
    24.  * @author Dhawal Kapil
    25.  */
    26. public class PathRoutePredicateFactory extends AbstractRoutePredicateFactory {
    27.  
    28. 	private static final Log log = LogFactory.getLog(PathRoutePredicateFactory.class);
    29.  
    30. 	private static final String MATCH_TRAILING_SLASH = "matchTrailingSlash";
    31.  
    32. 	private PathPatternParser pathPatternParser = new PathPatternParser();
    33.  
    34. 	public PathRoutePredicateFactory() {
    35. 		super(Config.class);
    36. 	}
    37.  
    38. 	private static void traceMatch(String prefix, Object desired, Object actual, boolean match) {
    39. 		if (log.isTraceEnabled()) {
    40. 			String message = String.format("%s \"%s\" %s against value \"%s\"", prefix, desired,
    41. 					match ? "matches" : "does not match", actual);
    42. 			log.trace(message);
    43. 		}
    44. 	}
    45.  
    46. 	public void setPathPatternParser(PathPatternParser pathPatternParser) {
    47. 		this.pathPatternParser = pathPatternParser;
    48. 	}
    49.  
    50. 	@Override
    51. 	public List shortcutFieldOrder() {
    52. 		return Arrays.asList("patterns", MATCH_TRAILING_SLASH);
    53. 	}
    54.  
    55. 	@Override
    56. 	public ShortcutType shortcutType() {
    57. 		return ShortcutType.GATHER_LIST_TAIL_FLAG;
    58. 	}
    59.  
    60. 	@Override
    61. 	public Predicate apply(Config config) {
    62. 		final ArrayList pathPatterns = new ArrayList<>();
    63. 		synchronized (this.pathPatternParser) {
    64. 			pathPatternParser.setMatchOptionalTrailingSeparator(config.isMatchTrailingSlash());
    65. 			config.getPatterns().forEach(pattern -> {
    66. 				PathPattern pathPattern = this.pathPatternParser.parse(pattern);
    67. 				pathPatterns.add(pathPattern);
    68. 			});
    69. 		}
    70. 		return new GatewayPredicate() {
    71. 			@Override
    72. 			public boolean test(ServerWebExchange exchange) {
    73. 				PathContainer path = parsePath(exchange.getRequest().getURI().getRawPath());
    74.  
    75. 				PathPattern match = null;
    76. 				for (int i = 0; i < pathPatterns.size(); i++) {
    77. 					PathPattern pathPattern = pathPatterns.get(i);
    78. 					if (pathPattern.matches(path)) {
    79. 						match = pathPattern;
    80. 						break;
    81. 					}
    82. 				}
    83.  
    84. 				if (match != null) {
    85. 					traceMatch("Pattern", match.getPatternString(), path, true);
    86. 					PathMatchInfo pathMatchInfo = match.matchAndExtract(path);
    87. 					putUriTemplateVariables(exchange, pathMatchInfo.getUriVariables());
    88. 					return true;
    89. 				}
    90. 				else {
    91. 					traceMatch("Pattern", config.getPatterns(), path, false);
    92. 					return false;
    93. 				}
    94. 			}
    95.  
    96. 			@Override
    97. 			public String toString() {
    98. 				return String.format("Paths: %s, match trailing slash: %b", config.getPatterns(),
    99. 						config.isMatchTrailingSlash());
    100. 			}
    101. 		};
    102. 	}
    103.  
    104. 	@Validated
    105. 	public static class Config {
    106.  
    107. 		private List patterns = new ArrayList<>();
    108.  
    109. 		private boolean matchTrailingSlash = true;
    110.  
    111. 		public List getPatterns() {
    112. 			return patterns;
    113. 		}
    114.  
    115. 		public Config setPatterns(List patterns) {
    116. 			this.patterns = patterns;
    117. 			return this;
    118. 		}
    119.  
    120. 		/**
    121. 		 * @deprecated use {@link #isMatchTrailingSlash()}
    122. 		 */
    123. 		@Deprecated
    124. 		public boolean isMatchOptionalTrailingSeparator() {
    125. 			return isMatchTrailingSlash();
    126. 		}
    127.  
    128. 		/**
    129. 		 * @deprecated use {@link #setMatchTrailingSlash(boolean)}
    130. 		 */
    131. 		@Deprecated
    132. 		public Config setMatchOptionalTrailingSeparator(boolean matchOptionalTrailingSeparator) {
    133. 			setMatchTrailingSlash(matchOptionalTrailingSeparator);
    134. 			return this;
    135. 		}
    136.  
    137. 		public boolean isMatchTrailingSlash() {
    138. 			return matchTrailingSlash;
    139. 		}
    140.  
    141. 		public Config setMatchTrailingSlash(boolean matchTrailingSlash) {
    142. 			this.matchTrailingSlash = matchTrailingSlash;
    143. 			return this;
    144. 		}
    145.  
    146. 		@Override
    147. 		public String toString() {
    148. 			return new ToStringCreator(this).append("patterns", patterns)
    149. 					.append(MATCH_TRAILING_SLASH, matchTrailingSlash).toString();
    150. 		}
    151.  
    152. 	}
    153.  
    154. }

    9、Query 

            Query指请求参数，有两种，一种是必须包含参数名：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Query=username
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms

            另外一种是设置参数的值，用正则匹配：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - Query=username,admin*
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.Arrays;
    4. import java.util.List;
    5. import java.util.function.Predicate;
    6.  
    7. import javax.validation.constraints.NotEmpty;
    8.  
    9. import org.springframework.util.StringUtils;
    10. import org.springframework.validation.annotation.Validated;
    11. import org.springframework.web.server.ServerWebExchange;
    12.  
    13. /**
    14.  * @author Spencer Gibb
    15.  */
    16. public class QueryRoutePredicateFactory extends AbstractRoutePredicateFactory {
    17.  
    18. 	/**
    19. 	 * Param key.
    20. 	 */
    21. 	public static final String PARAM_KEY = "param";
    22.  
    23. 	/**
    24. 	 * Regexp key.
    25. 	 */
    26. 	public static final String REGEXP_KEY = "regexp";
    27.  
    28. 	public QueryRoutePredicateFactory() {
    29. 		super(Config.class);
    30. 	}
    31.  
    32. 	@Override
    33. 	public List shortcutFieldOrder() {
    34. 		return Arrays.asList(PARAM_KEY, REGEXP_KEY);
    35. 	}
    36.  
    37. 	@Override
    38. 	public Predicate apply(Config config) {
    39. 		return new GatewayPredicate() {
    40. 			@Override
    41. 			public boolean test(ServerWebExchange exchange) {
    42. 				if (!StringUtils.hasText(config.regexp)) {
    43. 					// check existence of header
    44. 					return exchange.getRequest().getQueryParams().containsKey(config.param);
    45. 				}
    46.  
    47. 				List values = exchange.getRequest().getQueryParams().get(config.param);
    48. 				if (values == null) {
    49. 					return false;
    50. 				}
    51. 				for (String value : values) {
    52. 					if (value != null && value.matches(config.regexp)) {
    53. 						return true;
    54. 					}
    55. 				}
    56. 				return false;
    57. 			}
    58.  
    59. 			@Override
    60. 			public String toString() {
    61. 				return String.format("Query: param=%s regexp=%s", config.getParam(), config.getRegexp());
    62. 			}
    63. 		};
    64. 	}
    65.  
    66. 	@Validated
    67. 	public static class Config {
    68.  
    69. 		@NotEmpty
    70. 		private String param;
    71.  
    72. 		private String regexp;
    73.  
    74. 		public String getParam() {
    75. 			return param;
    76. 		}
    77.  
    78. 		public Config setParam(String param) {
    79. 			this.param = param;
    80. 			return this;
    81. 		}
    82.  
    83. 		public String getRegexp() {
    84. 			return regexp;
    85. 		}
    86.  
    87. 		public Config setRegexp(String regexp) {
    88. 			this.regexp = regexp;
    89. 			return this;
    90. 		}
    91.  
    92. 	}
    93.  
    94. }

    10、RemoteAddr

            允许访问的客户端地址，不能使用类似localhost这种：

    1. routes: 
    2.   - id: service-one 
    3.     uri: lb://service-one
    4.     predicates: 
    5.        - RemoteAddr=127.0.0.1
    6.     filters:
    7.       - StripPrefix=1
    8.     metadata:
    9.       connect-timeout: 15000 #ms
    10.       response-timeout: 15000 #ms
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.net.InetSocketAddress;
    4. import java.util.ArrayList;
    5. import java.util.Arrays;
    6. import java.util.Collections;
    7. import java.util.List;
    8. import java.util.function.Predicate;
    9.  
    10. import javax.validation.constraints.NotEmpty;
    11. import javax.validation.constraints.NotNull;
    12.  
    13. import io.netty.handler.ipfilter.IpFilterRuleType;
    14. import io.netty.handler.ipfilter.IpSubnetFilterRule;
    15. import org.apache.commons.logging.Log;
    16. import org.apache.commons.logging.LogFactory;
    17.  
    18. import org.springframework.cloud.gateway.support.ipresolver.RemoteAddressResolver;
    19. import org.springframework.validation.annotation.Validated;
    20. import org.springframework.web.server.ServerWebExchange;
    21.  
    22. import static org.springframework.cloud.gateway.support.ShortcutConfigurable.ShortcutType.GATHER_LIST;
    23.  
    24. /**
    25.  * @author Spencer Gibb
    26.  */
    27. public class RemoteAddrRoutePredicateFactory
    28. 		extends AbstractRoutePredicateFactory {
    29.  
    30. 	private static final Log log = LogFactory.getLog(RemoteAddrRoutePredicateFactory.class);
    31.  
    32. 	public RemoteAddrRoutePredicateFactory() {
    33. 		super(Config.class);
    34. 	}
    35.  
    36. 	@Override
    37. 	public ShortcutType shortcutType() {
    38. 		return GATHER_LIST;
    39. 	}
    40.  
    41. 	@Override
    42. 	public List shortcutFieldOrder() {
    43. 		return Collections.singletonList("sources");
    44. 	}
    45.  
    46. 	@NotNull
    47. 	private List convert(List values) {
    48. 		List sources = new ArrayList<>();
    49. 		for (String arg : values) {
    50. 			addSource(sources, arg);
    51. 		}
    52. 		return sources;
    53. 	}
    54.  
    55. 	@Override
    56. 	public Predicate apply(Config config) {
    57. 		List sources = convert(config.sources);
    58.  
    59. 		return new GatewayPredicate() {
    60. 			@Override
    61. 			public boolean test(ServerWebExchange exchange) {
    62. 				InetSocketAddress remoteAddress = config.remoteAddressResolver.resolve(exchange);
    63. 				if (remoteAddress != null && remoteAddress.getAddress() != null) {
    64. 					String hostAddress = remoteAddress.getAddress().getHostAddress();
    65. 					String host = exchange.getRequest().getURI().getHost();
    66.  
    67. 					if (log.isDebugEnabled() && !hostAddress.equals(host)) {
    68. 						log.debug("Remote addresses didn't match " + hostAddress + " != " + host);
    69. 					}
    70.  
    71. 					for (IpSubnetFilterRule source : sources) {
    72. 						if (source.matches(remoteAddress)) {
    73. 							return true;
    74. 						}
    75. 					}
    76. 				}
    77.  
    78. 				return false;
    79. 			}
    80.  
    81. 			@Override
    82. 			public String toString() {
    83. 				return String.format("RemoteAddrs: %s", config.getSources());
    84. 			}
    85. 		};
    86. 	}
    87.  
    88. 	private void addSource(List sources, String source) {
    89. 		if (!source.contains("/")) { // no netmask, add default
    90. 			source = source + "/32";
    91. 		}
    92.  
    93. 		String[] ipAddressCidrPrefix = source.split("/", 2);
    94. 		String ipAddress = ipAddressCidrPrefix[0];
    95. 		int cidrPrefix = Integer.parseInt(ipAddressCidrPrefix[1]);
    96.  
    97. 		sources.add(new IpSubnetFilterRule(ipAddress, cidrPrefix, IpFilterRuleType.ACCEPT));
    98. 	}
    99.  
    100. 	@Validated
    101. 	public static class Config {
    102.  
    103. 		@NotEmpty
    104. 		private List sources = new ArrayList<>();
    105.  
    106. 		@NotNull
    107. 		private RemoteAddressResolver remoteAddressResolver = new RemoteAddressResolver() {
    108. 		};
    109.  
    110. 		public List getSources() {
    111. 			return sources;
    112. 		}
    113.  
    114. 		public Config setSources(List sources) {
    115. 			this.sources = sources;
    116. 			return this;
    117. 		}
    118.  
    119. 		public Config setSources(String... sources) {
    120. 			this.sources = Arrays.asList(sources);
    121. 			return this;
    122. 		}
    123.  
    124. 		public Config setRemoteAddressResolver(RemoteAddressResolver remoteAddressResolver) {
    125. 			this.remoteAddressResolver = remoteAddressResolver;
    126. 			return this;
    127. 		}
    128.  
    129. 	}
    130.  
    131. }

    11、Weight

            负载均衡中权重：

    1. routes:
    2.   - id: service-one
    3.     uri: lb://service-one
    4.     predicates:
    5.       - Weight=group,2
    6.     filters: StripPrefix=1
    7.   - id: service-two
    8.     uri: lb://service-two
    9.     predicates:
    10.       - Weight=group,8
    11.     filters: StripPrefix=1
    1. package org.springframework.cloud.gateway.handler.predicate;
    2.  
    3. import java.util.Arrays;
    4. import java.util.Collections;
    5. import java.util.List;
    6. import java.util.Map;
    7. import java.util.function.Predicate;
    8.  
    9. import org.apache.commons.logging.Log;
    10. import org.apache.commons.logging.LogFactory;
    11.  
    12. import org.springframework.cloud.gateway.event.WeightDefinedEvent;
    13. import org.springframework.cloud.gateway.support.WeightConfig;
    14. import org.springframework.context.ApplicationEventPublisher;
    15. import org.springframework.context.ApplicationEventPublisherAware;
    16. import org.springframework.web.server.ServerWebExchange;
    17.  
    18. import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_PREDICATE_ROUTE_ATTR;
    19. import static org.springframework.cloud.gateway.support.ServerWebExchangeUtils.WEIGHT_ATTR;
    20.  
    21. /**
    22.  * @author Spencer Gibb
    23.  */
    24. // TODO: make this a generic Choose out of group predicate?
    25. public class WeightRoutePredicateFactory extends AbstractRoutePredicateFactory
    26. 		implements ApplicationEventPublisherAware {
    27.  
    28. 	/**
    29. 	 * Weight config group key.
    30. 	 */
    31. 	public static final String GROUP_KEY = WeightConfig.CONFIG_PREFIX + ".group";
    32.  
    33. 	/**
    34. 	 * Weight config weight key.
    35. 	 */
    36. 	public static final String WEIGHT_KEY = WeightConfig.CONFIG_PREFIX + ".weight";
    37.  
    38. 	private static final Log log = LogFactory.getLog(WeightRoutePredicateFactory.class);
    39.  
    40. 	private ApplicationEventPublisher publisher;
    41.  
    42. 	public WeightRoutePredicateFactory() {
    43. 		super(WeightConfig.class);
    44. 	}
    45.  
    46. 	@Override
    47. 	public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
    48. 		this.publisher = publisher;
    49. 	}
    50.  
    51. 	@Override
    52. 	public List shortcutFieldOrder() {
    53. 		return Arrays.asList(GROUP_KEY, WEIGHT_KEY);
    54. 	}
    55.  
    56. 	@Override
    57. 	public String shortcutFieldPrefix() {
    58. 		return WeightConfig.CONFIG_PREFIX;
    59. 	}
    60.  
    61. 	@Override
    62. 	public void beforeApply(WeightConfig config) {
    63. 		if (publisher != null) {
    64. 			publisher.publishEvent(new WeightDefinedEvent(this, config));
    65. 		}
    66. 	}
    67.  
    68. 	@Override
    69. 	public Predicate apply(WeightConfig config) {
    70. 		return new GatewayPredicate() {
    71. 			@Override
    72. 			public boolean test(ServerWebExchange exchange) {
    73. 				Map weights = exchange.getAttributeOrDefault(WEIGHT_ATTR, Collections.emptyMap());
    74.  
    75. 				String routeId = exchange.getAttribute(GATEWAY_PREDICATE_ROUTE_ATTR);
    76.  
    77. 				// all calculations and comparison against random num happened in
    78. 				// WeightCalculatorWebFilter
    79. 				String group = config.getGroup();
    80. 				if (weights.containsKey(group)) {
    81.  
    82. 					String chosenRoute = weights.get(group);
    83. 					if (log.isTraceEnabled()) {
    84. 						log.trace("in group weight: " + group + ", current route: " + routeId + ", chosen route: "
    85. 								+ chosenRoute);
    86. 					}
    87.  
    88. 					return routeId.equals(chosenRoute);
    89. 				}
    90. 				else if (log.isTraceEnabled()) {
    91. 					log.trace("no weights found for group: " + group + ", current route: " + routeId);
    92. 				}
    93.  
    94. 				return false;
    95. 			}
    96.  
    97. 			@Override
    98. 			public String toString() {
    99. 				return String.format("Weight: %s %s", config.getGroup(), config.getWeight());
    100. 			}
    101. 		};
    102. 	}
    103.  
    104. }

  • 相关阅读:
    无法创建 8192 MB 的匿名分页文件: 系统资源不足，无法完成请求的服务。
    C语言之指针详解
    DJYOS物联屏：工业HMI里的显控异构计算的超稳定解决方案
    SpringCloud01
    一张图系列 - “kv cache“
    普中精灵开发板stm32烧录程序失败
    Linux从0到1——Linux第一个小程序：进度条
    Fiori VS code 连接配置本地SDK yaml 文件配置
    HTML易忽略的角落【目录】
    matplotlib图表常用设置(四)
  • 原文地址：https://blog.csdn.net/qq_41061437/article/details/127992541