Skip to content

Commit d382365

Browse files
spencergibbspencergibb
committed
Polishes route filter cache.
Adds refresh listener to clear the cache. See gh-2760
1 parent 9557d12 commit d382365

File tree

5 files changed

+168
-31
lines changed

5 files changed

+168
-31
lines changed

‎spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/config/GatewayAutoConfiguration.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,8 @@ public RouteRefreshListener routeRefreshListener(ApplicationEventPublisher publi
272272

273273
@Bean
274274
@ConditionalOnMissingBean
275-
public FilteringWebHandler filteringWebHandler(List<GlobalFilter> globalFilters) {
276-
return new FilteringWebHandler(globalFilters);
275+
public FilteringWebHandler filteringWebHandler(List<GlobalFilter> globalFilters, GatewayProperties properties) {
276+
return new FilteringWebHandler(globalFilters, properties.isRouteFilterCacheEnabled());
277277
}
278278

279279
@Bean

‎spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/config/GatewayProperties.java‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,18 @@ public class GatewayProperties {
6969
private boolean failOnRouteDefinitionError = true;
7070

7171
/**
72-
* org.springframework.cloud.gateway.handler.FilteringWebHandler#handle add filter cache
73-
* if true then enable filter cache
72+
* Enables the route filter cache, defaults to false.
7473
*/
75-
private boolean filterCache = false;
74+
private boolean routeFilterCacheEnabled = false;
7675

77-
public boolean isFilterCache() {
78-
return filterCache;
76+
public boolean isRouteFilterCacheEnabled() {
77+
return routeFilterCacheEnabled;
7978
}
8079

81-
public void setFilterCache(boolean filterCache) {
82-
this.filterCache = filterCache;
80+
public void setRouteFilterCacheEnabled(boolean routeFilterCacheEnabled) {
81+
this.routeFilterCacheEnabled = routeFilterCacheEnabled;
8382
}
8483

85-
8684
public List<RouteDefinition> getRoutes() {
8785
return routes;
8886
}
@@ -124,7 +122,8 @@ public String toString() {
124122
.append("defaultFilters", defaultFilters)
125123
.append("streamingMediaTypes", streamingMediaTypes)
126124
.append("failOnRouteDefinitionError", failOnRouteDefinitionError)
127-
.append("filterCache", filterCache).toString();
125+
.append("routeFilterCacheEnabled", routeFilterCacheEnabled)
126+
.toString();
128127

129128
}
130129

‎spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/handler/FilteringWebHandler.java‎

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,16 @@
2323

2424
import org.apache.commons.logging.Log;
2525
import org.apache.commons.logging.LogFactory;
26-
import org.springframework.cloud.gateway.config.GatewayProperties;
2726
import reactor.core.publisher.Mono;
2827

28+
import org.springframework.cloud.gateway.event.RefreshRoutesEvent;
2929
import org.springframework.cloud.gateway.filter.GatewayFilter;
3030
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
3131
import org.springframework.cloud.gateway.filter.GlobalFilter;
3232
import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
3333
import org.springframework.cloud.gateway.filter.factory.GatewayFilterFactory;
3434
import org.springframework.cloud.gateway.route.Route;
35+
import org.springframework.context.ApplicationListener;
3536
import org.springframework.core.DecoratingProxy;
3637
import org.springframework.core.Ordered;
3738
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
@@ -51,19 +52,28 @@
5152
* @author Yuxin Wang
5253
* @since 0.1
5354
*/
54-
public class FilteringWebHandler implements WebHandler {
55+
public class FilteringWebHandler implements WebHandler, ApplicationListener<RefreshRoutesEvent> {
5556

5657
protected static final Log logger = LogFactory.getLog(FilteringWebHandler.class);
5758

5859
private final List<GatewayFilter> globalFilters;
5960

60-
private ConcurrentHashMap<Route,List<GatewayFilter>> RouteFilterMap = new ConcurrentHashMap();
61+
private final ConcurrentHashMap<Route, List<GatewayFilter>> routeFilterMap = new ConcurrentHashMap();
6162

62-
private GatewayProperties properties;
63+
private final boolean filterCacheEnabled;
6364

64-
public FilteringWebHandler(List<GlobalFilter> globalFilters, GatewayProperties properties) {
65+
@Deprecated
66+
public FilteringWebHandler(List<GlobalFilter> globalFilters) {
67+
this(globalFilters, false);
68+
}
69+
70+
public FilteringWebHandler(List<GlobalFilter> globalFilters, boolean filterCacheEnabled) {
6571
this.globalFilters = loadFilters(globalFilters);
66-
this.properties = properties;
72+
this.filterCacheEnabled = filterCacheEnabled;
73+
}
74+
75+
/* for testing */ ConcurrentHashMap<Route, List<GatewayFilter>> getRouteFilterMap() {
76+
return routeFilterMap;
6777
}
6878

6979
private static List<GatewayFilter> loadFilters(List<GlobalFilter> filters) {
@@ -83,10 +93,12 @@ private static List<GatewayFilter> loadFilters(List<GlobalFilter> filters) {
8393
}).collect(Collectors.toList());
8494
}
8595

86-
/*
87-
* TODO: relocate @EventListener(RefreshRoutesEvent.class) void handleRefresh() {
88-
* this.combinedFiltersForRoute.clear();
89-
*/
96+
@Override
97+
public void onApplicationEvent(RefreshRoutesEvent event) {
98+
if (this.filterCacheEnabled) {
99+
routeFilterMap.clear();
100+
}
101+
}
90102

91103
@Override
92104
public Mono<Void> handle(ServerWebExchange exchange) {
@@ -100,18 +112,16 @@ public Mono<Void> handle(ServerWebExchange exchange) {
100112
return new DefaultGatewayFilterChain(combined).filter(exchange);
101113
}
102114

103-
public List<GatewayFilter> getCombinedFilters(Route route){
104-
if (this.properties.isFilterCache()) {
105-
if (!this.RouteFilterMap.contains(route)) {
106-
RouteFilterMap.put(route,getAllFilters(route));
107-
}
108-
return RouteFilterMap.get(route);
109-
}else {
115+
protected List<GatewayFilter> getCombinedFilters(Route route) {
116+
if (this.filterCacheEnabled) {
117+
return routeFilterMap.computeIfAbsent(route, this::getAllFilters);
118+
}
119+
else {
110120
return getAllFilters(route);
111121
}
112-
113122
}
114-
public List<GatewayFilter> getAllFilters(Route route){
123+
124+
protected List<GatewayFilter> getAllFilters(Route route) {
115125
List<GatewayFilter> gatewayFilters = route.getFilters();
116126
List<GatewayFilter> combined = new ArrayList<>(this.globalFilters);
117127
combined.addAll(gatewayFilters);

‎spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/route/RouteRefreshListener.java‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,12 @@ public RouteRefreshListener(ApplicationEventPublisher publisher) {
4646
public void onApplicationEvent(ApplicationEvent event) {
4747
if (event instanceof ContextRefreshedEvent) {
4848
ContextRefreshedEvent refreshedEvent = (ContextRefreshedEvent) event;
49-
if (!WebServerApplicationContext.hasServerNamespace(refreshedEvent.getApplicationContext(), "management")) {
49+
boolean isManagementCtxt = WebServerApplicationContext
50+
.hasServerNamespace(refreshedEvent.getApplicationContext(), "management");
51+
boolean isLoadBalancerCtxt = refreshedEvent.getApplicationContext().getDisplayName() != null
52+
&& refreshedEvent.getApplicationContext().getDisplayName().startsWith("LoadBalancerClientFactory-");
53+
54+
if (!isManagementCtxt && !isLoadBalancerCtxt) {
5055
reset();
5156
}
5257
}

‎spring-cloud-gateway-server/src/test/java/org/springframework/cloud/gateway/handler/FilteringWebHandlerCacheEnabledIntegrationTests.java‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
/*
2+
* Copyright 2013-2020 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.cloud.gateway.handler;
18+
19+
import java.net.URI;
20+
import java.time.Duration;
21+
import java.util.Arrays;
22+
23+
import org.junit.jupiter.api.Test;
24+
25+
import org.springframework.beans.factory.annotation.Autowired;
26+
import org.springframework.boot.SpringBootConfiguration;
27+
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
28+
import org.springframework.boot.test.context.SpringBootTest;
29+
import org.springframework.cloud.gateway.filter.FilterDefinition;
30+
import org.springframework.cloud.gateway.handler.predicate.PredicateDefinition;
31+
import org.springframework.cloud.gateway.route.RouteDefinition;
32+
import org.springframework.cloud.gateway.route.RouteLocator;
33+
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
34+
import org.springframework.cloud.gateway.test.BaseWebClientTests;
35+
import org.springframework.context.annotation.Bean;
36+
import org.springframework.context.annotation.Import;
37+
import org.springframework.http.MediaType;
38+
import org.springframework.test.annotation.DirtiesContext;
39+
import org.springframework.web.reactive.function.BodyInserters;
40+
41+
import static org.assertj.core.api.Assertions.assertThat;
42+
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;
43+
44+
@SpringBootTest(webEnvironment = RANDOM_PORT,
45+
properties = { "spring.cloud.gateway.route-filter-cache-enabled=true", "management.endpoint.gateway.enabled=true",
46+
"management.endpoints.web.exposure.include=*", "spring.cloud.gateway.actuator.verbose.enabled=true" })
47+
@DirtiesContext
48+
public class FilteringWebHandlerCacheEnabledIntegrationTests extends BaseWebClientTests {
49+
50+
@Autowired
51+
private FilteringWebHandler webHandler;
52+
53+
@Test
54+
public void filteringWebHandlerCacheEnabledWorks() {
55+
// prime the cache
56+
callRoute("/get");
57+
assertThat(webHandler.getRouteFilterMap()).hasSize(1);
58+
59+
callRoute("/anything/testRoute1");
60+
61+
assertThat(webHandler.getRouteFilterMap()).hasSize(2);
62+
63+
RouteDefinition testRouteDefinition = new RouteDefinition();
64+
testRouteDefinition.setId("testRoute2");
65+
testRouteDefinition.setUri(URI.create("lb://testservice"));
66+
67+
FilterDefinition filterDefinition = new FilterDefinition("PrefixPath=/httpbin");
68+
testRouteDefinition.getFilters().add(filterDefinition);
69+
70+
PredicateDefinition hostRoutePredicateDefinition = new PredicateDefinition("Path=/anything/testRoute2");
71+
testRouteDefinition.setPredicates(Arrays.asList(hostRoutePredicateDefinition));
72+
73+
testClient.post()
74+
.uri("http://localhost:" + port + "/actuator/gateway/routes/testRoute2")
75+
.accept(MediaType.APPLICATION_JSON)
76+
.body(BodyInserters.fromValue(testRouteDefinition))
77+
.exchange()
78+
.expectStatus()
79+
.isCreated();
80+
81+
testClient.post()
82+
.uri("http://localhost:" + port + "/actuator/gateway/refresh")
83+
.exchange()
84+
.expectStatus()
85+
.isOk();
86+
87+
callRoute("/get");
88+
callRoute("/anything/testRoute1");
89+
callRoute("/anything/testRoute2");
90+
91+
assertThat(webHandler.getRouteFilterMap()).hasSize(3);
92+
}
93+
94+
private void callRoute(String uri) {
95+
testClient.mutate()
96+
.responseTimeout(Duration.ofMinutes(5))
97+
.build()
98+
.get()
99+
.uri(uri)
100+
.exchange()
101+
.expectStatus()
102+
.isOk();
103+
}
104+
105+
@EnableAutoConfiguration
106+
@SpringBootConfiguration
107+
@Import(DefaultTestConfig.class)
108+
public static class TestConfig {
109+
110+
@Bean
111+
RouteLocator testRouteLocator(RouteLocatorBuilder builder) {
112+
return builder.routes()
113+
.route("get_route", r -> r.path("/get").filters(f -> f.prefixPath("/httpbin")).uri("lb://testservice"))
114+
.route("testRoute1",
115+
r -> r.path("/anything/testRoute1")
116+
.filters(f -> f.prefixPath("/httpbin"))
117+
.uri("lb://testservice"))
118+
.build();
119+
}
120+
121+
}
122+
123+
}

0 commit comments

Comments
 (0)