SpringCloud/spring-cloud-gateway
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change Filter from (value, args[]) to (args...)

Browse Source
This commit is contained in:
Spencer Gibb
2017-01-27 21:04:02 -07:00
parent c31e92a2b5
commit 06b5211a39
18 changed files with 57 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/main/java/org/springframework/cloud/gateway/config/FilterDefinition.java
View File

@@ -14,9 +14,6 @@ import static org.springframework.util.StringUtils.tokenizeToStringArray;
public class FilterDefinition {
@NotNull
private String name;
@NotNull
private String value;
private String[] args;
public FilterDefinition() {
@@ -32,11 +29,7 @@ public class FilterDefinition {
String[] args = tokenizeToStringArray(text.substring(eqIdx+1), ",");
setValue(args[0]);
if (args.length > 1) {
setArgs(Arrays.copyOfRange(args, 1, args.length));
}
setArgs(args);
}
public String getName() {
@@ -47,19 +40,11 @@ public class FilterDefinition {
this.name = name;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
public String[] getArgs() {
return args;
}
public void setArgs(String[] args) {
public void setArgs(String... args) {
this.args = args;
}
@@ -69,20 +54,18 @@ public class FilterDefinition {
if (o == null || getClass() != o.getClass()) return false;
FilterDefinition that = (FilterDefinition) o;
return Objects.equals(name, that.name) &&
Objects.equals(value, that.value) &&
Arrays.equals(args, that.args);
}
@Override
public int hashCode() {
return Objects.hash(name, value, args);
return Objects.hash(name, args);
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder("FilterDefinition{");
sb.append("name='").append(name).append('\'');
sb.append(", value='").append(value).append('\'');
sb.append(", args=").append(Arrays.toString(args));
sb.append('}');
return sb.toString();

5
src/main/java/org/springframework/cloud/gateway/discovery/DiscoveryClientRouteReader.java
View File

@@ -43,8 +43,9 @@ public class DiscoveryClientRouteReader implements RouteReader {
// add a filter that removes /serviceId by default
FilterDefinition filter = new FilterDefinition();
filter.setName("RewritePath");
filter.setValue("/" + serviceId + "/(?<remaining>.*)");
filter.setArgs(new String[]{ "/${remaining}" });
String regex = "/" + serviceId + "/(?<remaining>.*)";
String replacement = "/${remaining}";
filter.setArgs(regex, replacement);
route.getFilters().add(filter);
//TODO: support for default filters

7
src/main/java/org/springframework/cloud/gateway/filter/route/AddRequestHeaderRouteFilter.java
View File

@@ -9,13 +9,12 @@ import org.springframework.http.server.reactive.ServerHttpRequest;
public class AddRequestHeaderRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String header, String[] args) {
validate(args, 1);
public WebFilter apply(String... args) {
validate(2, args);
//TODO: caching can happen here
return (exchange, chain) -> {
ServerHttpRequest request = exchange.getRequest().mutate()
.header(header, args[0])
.header(args[0], args[1])
.build();
return chain.filter(exchange.mutate().request(request).build());

9
src/main/java/org/springframework/cloud/gateway/filter/route/AddRequestParameterRouteFilter.java
View File

@@ -17,10 +17,11 @@ import org.springframework.web.server.WebFilter;
public class AddRequestParameterRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String parameter, String[] args) {
validate(args, 1);
public WebFilter apply(String... args) {
validate(2, args);
String parameter = args[0];
String value = args[1];
//TODO: caching can happen here
return (exchange, chain) -> {
URI uri = exchange.getRequest().getURI();
@@ -37,7 +38,7 @@ public class AddRequestParameterRouteFilter implements RouteFilter {
//TODO urlencode?
query.append(parameter);
query.append('=');
query.append(args[0]);
query.append(value);
ServerHttpRequest request = new QueryParamServerHttpRequestBuilder(exchange.getRequest())
.query(query.toString())

9
src/main/java/org/springframework/cloud/gateway/filter/route/AddResponseHeaderRouteFilter.java
View File

@@ -8,12 +8,13 @@ import org.springframework.web.server.WebFilter;
public class AddResponseHeaderRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String header, String[] args) {
validate(args, 1);
public WebFilter apply(String... args) {
validate(2, args);
final String header = args[0];
final String value = args[1];
//TODO: caching can happen here
return (exchange, chain) -> {
exchange.getResponse().getHeaders().add(header, args[0]);
exchange.getResponse().getHeaders().add(header, value);
return chain.filter(exchange);
};

4
src/main/java/org/springframework/cloud/gateway/filter/route/HystrixRouteFilter.java
View File

@@ -19,7 +19,9 @@ import rx.Subscription;
public class HystrixRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String commandName, String[] args) {
public WebFilter apply(String... args) {
validate(1, args);
final String commandName = args[0];
final HystrixCommandGroupKey groupKey = HystrixCommandGroupKey.Factory.asKey(getClass().getSimpleName());
final HystrixCommandKey commandKey = HystrixCommandKey.Factory.asKey(commandName);

11
src/main/java/org/springframework/cloud/gateway/filter/route/RedirectToRouteFilter.java
View File

@@ -20,18 +20,19 @@ import reactor.core.publisher.Mono;
*/
public class RedirectToRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String statusString, String[] args) {
validate(args, 1);
public WebFilter apply(String... args) {
validate(2, args);
final String statusString = args[0];
final String uri = args[1];
final HttpStatus httpStatus = parse(statusString);
final URL url;
try {
url = URI.create(args[0]).toURL();
url = URI.create(uri).toURL();
} catch (MalformedURLException e) {
throw new IllegalArgumentException("Invalid url " + args[0], e);
throw new IllegalArgumentException("Invalid url " + uri, e);
}
//TODO: caching can happen here
return (exchange, chain) ->
chain.filter(exchange).then(() -> {
if (!isResponseCommitted(exchange)) {

5
src/main/java/org/springframework/cloud/gateway/filter/route/RemoveRequestHeaderRouteFilter.java
View File

@@ -11,9 +11,10 @@ public class RemoveRequestHeaderRouteFilter implements RouteFilter {
public static final String FAKE_HEADER = "_______force_______";
@Override
public WebFilter apply(String header, String[] args) {
public WebFilter apply(String... args) {
validate(1, args);
final String header = args[0];
//TODO: caching can happen here
return (exchange, chain) -> {
ServerHttpRequest request = exchange.getRequest().mutate()
.header(FAKE_HEADER, "mutable") //TODO: is there a better way?

5
src/main/java/org/springframework/cloud/gateway/filter/route/RemoveResponseHeaderRouteFilter.java
View File

@@ -8,9 +8,10 @@ import org.springframework.web.server.WebFilter;
public class RemoveResponseHeaderRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String header, String[] args) {
public WebFilter apply(String... args) {
validate(1, args);
final String header = args[0];
//TODO: caching can happen here
return (exchange, chain) -> {
exchange.getResponse().getHeaders().remove(header);

8
src/main/java/org/springframework/cloud/gateway/filter/route/RewritePathRouteFilter.java
View File

@@ -9,11 +9,11 @@ import org.springframework.http.server.reactive.ServerHttpRequest;
public class RewritePathRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String regex, String[] args) {
validate(args, 1);
String replacement = args[0].replace("$\\", "$");
public WebFilter apply(String... args) {
validate(2, args);
final String regex = args[0];
String replacement = args[1].replace("$\\", "$");
//TODO: caching can happen here
return (exchange, chain) -> {
ServerHttpRequest req = exchange.getRequest();
String path = req.getURI().getPath();

4
src/main/java/org/springframework/cloud/gateway/filter/route/RouteFilter.java
View File

@@ -8,9 +8,9 @@ import org.springframework.web.server.WebFilter;
*/
public interface RouteFilter {
WebFilter apply(String value, String[] args);
WebFilter apply(String... args);
default void validate(String[] args, int requiredSize) {
default void validate(int requiredSize, String... args) {
Assert.isTrue(args != null && args.length == requiredSize,
"args must have "+ requiredSize +" entry(s)");
}

6
src/main/java/org/springframework/cloud/gateway/filter/route/SetPathRouteFilter.java
View File

@@ -17,10 +17,10 @@ public class SetPathRouteFilter implements RouteFilter {
@Override
@SuppressWarnings("unchecked")
public WebFilter apply(String template, String[] args) {
UriTemplate uriTemplate = new UriTemplate(template);
public WebFilter apply(String... args) {
validate(1, args);
UriTemplate uriTemplate = new UriTemplate(args[0]);
//TODO: caching can happen here
return (exchange, chain) -> {
Map<String, String> variables = getAttribute(exchange, URL_PREDICATE_VARS_ATTR, Map.class);
ServerHttpRequest req = exchange.getRequest();

9
src/main/java/org/springframework/cloud/gateway/filter/route/SetResponseHeaderRouteFilter.java
View File

@@ -8,12 +8,13 @@ import org.springframework.web.server.WebFilter;
public class SetResponseHeaderRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String header, String[] args) {
validate(args, 1);
public WebFilter apply(String... args) {
validate(2, args);
final String header = args[0];
final String value = args[1];
//TODO: caching can happen here
return (exchange, chain) -> {
exchange.getResponse().getHeaders().set(header, args[0]);
exchange.getResponse().getHeaders().set(header, value);
return chain.filter(exchange);
};

6
src/main/java/org/springframework/cloud/gateway/filter/route/SetStatusRouteFilter.java
View File

@@ -15,10 +15,10 @@ import reactor.core.publisher.Mono;
public class SetStatusRouteFilter implements RouteFilter {
@Override
public WebFilter apply(String statusString, String[] args) {
final HttpStatus httpStatus = ServerWebExchangeUtils.parse(statusString);
public WebFilter apply(String... args) {
validate(1, args);
final HttpStatus httpStatus = ServerWebExchangeUtils.parse(args[0]);
//TODO: caching can happen here
return (exchange, chain) -> {
// option 1 (runs in filter order)

5
src/main/java/org/springframework/cloud/gateway/handler/FilteringWebHandler.java
View File

@@ -143,10 +143,9 @@ public class FilteringWebHandler extends WebHandlerDecorator {
} else {
args = Collections.emptyList();
}
logger.debug("Route " + route.getId() + " applying filter " + definition.getValue()
+ ", " + args + " to " + definition.getName());
logger.debug("Route " + route.getId() + " applying filter " + args + " to " + definition.getName());
}
return filter.apply(definition.getValue(), definition.getArgs());
return filter.apply(definition.getArgs());
})
.collect(Collectors.toList());

2
src/test/java/org/springframework/cloud/gateway/filter/route/RewritePathRouteFilterTests.java
View File

@@ -30,7 +30,7 @@ public class RewritePathRouteFilterTests {
}
private void testRewriteFilter(String regex, String replacement, String actualPath, String expectedPath) {
WebFilter filter = new RewritePathRouteFilter().apply(regex, new String[]{replacement});
WebFilter filter = new RewritePathRouteFilter().apply(regex, replacement);
MockServerHttpRequest request = MockServerHttpRequest
.get("http://localhost"+ actualPath)

2
src/test/java/org/springframework/cloud/gateway/filter/route/SetPathRouteFilterTests.java
View File

@@ -37,7 +37,7 @@ public class SetPathRouteFilterTests {
}
private void testRewriteFilter(String template, String actualPath, String expectedPath, HashMap<String, String> variables) {
WebFilter filter = new SetPathRouteFilter().apply(template, new String[]{});
WebFilter filter = new SetPathRouteFilter().apply(new String[]{template});
MockServerHttpRequest request = MockServerHttpRequest
.get("http://localhost"+ actualPath)

3
src/test/resources/application.yml
View File

@@ -124,7 +124,8 @@ spring:
- Host=**.setstatusint.org
- Url=/headers
filters:
- SetStatus=401
- name: SetStatus
args: 401
# =====================================
- id: set_status_string_test