Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Configure a CompositeRouteLocator by default so it is easier to compose multiple RouteLocators.
- Loading branch information
1 parent
bf586ba
commit 899d8bc
Showing
6 changed files
with
212 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
...e/src/main/java/org/springframework/cloud/netflix/zuul/filters/CompositeRouteLocator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * Copyright 2013-2014 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.cloud.netflix.zuul.filters; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.List; | ||
|
|
||
| import org.springframework.core.annotation.AnnotationAwareOrderComparator; | ||
| import org.springframework.util.Assert; | ||
|
|
||
| /** | ||
| * RouteLocator that composes multiple RouteLocators. | ||
| * | ||
| * @author Johannes Edmeier | ||
| * | ||
| */ | ||
| public class CompositeRouteLocator implements RefreshableRouteLocator { | ||
| private final Collection<? extends RouteLocator> routeLocators; | ||
| private ArrayList<RouteLocator> rl; | ||
|
|
||
| public CompositeRouteLocator(Collection<? extends RouteLocator> routeLocators) { | ||
| Assert.notNull(routeLocators, "'routeLocators' must not be null"); | ||
| rl = new ArrayList<>(routeLocators); | ||
| AnnotationAwareOrderComparator.sort(rl); | ||
| this.routeLocators = rl; | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<String> getIgnoredPaths() { | ||
| List<String> ignoredPaths = new ArrayList<>(); | ||
| for (RouteLocator locator : routeLocators) { | ||
| ignoredPaths.addAll(locator.getIgnoredPaths()); | ||
| } | ||
| return ignoredPaths; | ||
| } | ||
|
|
||
| @Override | ||
| public List<Route> getRoutes() { | ||
| List<Route> route = new ArrayList<>(); | ||
| for (RouteLocator locator : routeLocators) { | ||
| route.addAll(locator.getRoutes()); | ||
| } | ||
| return route; | ||
| } | ||
|
|
||
| @Override | ||
| public Route getMatchingRoute(String path) { | ||
| for (RouteLocator locator : routeLocators) { | ||
| Route route = locator.getMatchingRoute(path); | ||
| if (route != null) { | ||
| return route; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public void refresh() { | ||
| for (RouteLocator locator : routeLocators) { | ||
| if (locator instanceof RefreshableRouteLocator) { | ||
| ((RefreshableRouteLocator) locator).refresh(); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
.../test/java/org/springframework/cloud/netflix/zuul/filters/CompositeRouteLocatorTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package org.springframework.cloud.netflix.zuul.filters; | ||
|
|
||
| import static java.util.Arrays.asList; | ||
| import static org.hamcrest.CoreMatchers.hasItems; | ||
| import static org.hamcrest.CoreMatchers.is; | ||
| import static org.hamcrest.CoreMatchers.notNullValue; | ||
| import static org.hamcrest.CoreMatchers.nullValue; | ||
| import static org.junit.Assert.assertThat; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.verify; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * @author Johannes Edmeier | ||
| */ | ||
| public class CompositeRouteLocatorTests { | ||
| private CompositeRouteLocator locator; | ||
|
|
||
| public CompositeRouteLocatorTests() { | ||
| List<RouteLocator> locators = new ArrayList<>(); | ||
| locators.add(new TestRouteLocator(asList("ign1"), | ||
| asList(createRoute("1", "/pathA")))); | ||
| locators.add( | ||
| new TestRouteLocator(asList("ign1", "ign2"), | ||
| asList(createRoute("2", "/pathA"), createRoute("2", "/pathB")))); | ||
| this.locator = new CompositeRouteLocator(locators); | ||
| } | ||
|
|
||
| @Test | ||
| public void test_getIgnoredPaths() { | ||
| assertThat(locator.getIgnoredPaths(), hasItems("ign1", "ign2")); | ||
|
|
||
| } | ||
|
|
||
| @Test | ||
| public void test_getRoutes() { | ||
| assertThat(locator.getRoutes(), | ||
| hasItems(createRoute("1", "/pathA"), createRoute("2", "/pathB"))); | ||
| } | ||
|
|
||
| @Test | ||
| public void test_getMatchingRoute() { | ||
| assertThat(locator.getMatchingRoute("/pathA"), notNullValue()); | ||
| assertThat(locator.getMatchingRoute("/pathA").getId(), is("1")); | ||
| assertThat("Locator 1 should take precedence", locator.getMatchingRoute("/pathB").getId(), | ||
| is("2")); | ||
| assertThat(locator.getMatchingRoute("/pathNot"), nullValue()); | ||
| } | ||
|
|
||
| @Test | ||
| public void test_refresh() { | ||
| RefreshableRouteLocator mock = mock(RefreshableRouteLocator.class); | ||
| new CompositeRouteLocator(asList(mock)).refresh(); | ||
| verify(mock).refresh(); | ||
| } | ||
|
|
||
| private Route createRoute(String id, String path) { | ||
| return new Route(id, path, null, null, false, Collections.<String>emptySet()); | ||
| } | ||
|
|
||
| private static class TestRouteLocator implements RouteLocator { | ||
| private Collection<String> ignoredPaths; | ||
| private List<Route> routes; | ||
|
|
||
| public TestRouteLocator(Collection<String> ignoredPaths, List<Route> routes) { | ||
| this.ignoredPaths = ignoredPaths; | ||
| this.routes = routes; | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<String> getIgnoredPaths() { | ||
| return this.ignoredPaths; | ||
| } | ||
|
|
||
| @Override | ||
| public List<Route> getRoutes() { | ||
| return this.routes; | ||
| } | ||
|
|
||
| @Override | ||
| public Route getMatchingRoute(String path) { | ||
| for (Route route : routes) { | ||
| if (path.startsWith(route.getPath())) { | ||
| return route; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters