RequestPath improvements

Static parse methods on PathSegmentContainer and PathSegment plus:

isEmpty() on PathSegmentContainer and PathSegment
isAbsolute() and hasTrailingSlash() on PathSegmentContainer
char[] alternative for valueDecoded() on PathSegment
This commit is contained in:
Rossen Stoyanchev
2017-06-14 15:58:44 -04:00
parent 7b5f96c804
commit 97a97f9bba
5 changed files with 201 additions and 63 deletions

View File

@@ -28,6 +28,7 @@ import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
/**
* Default implementation of {@link RequestPath}.
*
* @author Rossen Stoyanchev
* @since 5.0
@@ -58,13 +59,13 @@ class DefaultRequestPath implements RequestPath {
this.pathWithinApplication = initPathWithinApplication(this.fullPath, this.contextPath);
}
DefaultRequestPath(RequestPath requestPath, String contextPath, Charset charset) {
DefaultRequestPath(RequestPath requestPath, String contextPath) {
this.fullPath = new DefaultPathSegmentContainer(requestPath.value(), requestPath.pathSegments());
this.contextPath = initContextPath(this.fullPath, contextPath);
this.pathWithinApplication = initPathWithinApplication(this.fullPath, this.contextPath);
}
private static PathSegmentContainer parsePath(String path, Charset charset) {
static PathSegmentContainer parsePath(String path, Charset charset) {
path = StringUtils.hasText(path) ? path : "";
if ("".equals(path)) {
return EMPTY_PATH;
@@ -73,8 +74,8 @@ class DefaultRequestPath implements RequestPath {
return ROOT_PATH;
}
List<PathSegment> result = new ArrayList<>();
int begin = 1;
while (true) {
int begin = (path.charAt(0) == '/' ? 1 : 0);
while (begin < path.length()) {
int end = path.indexOf('/', begin);
String segment = (end != -1 ? path.substring(begin, end) : path.substring(begin));
result.add(parsePathSegment(segment, charset));
@@ -82,22 +83,18 @@ class DefaultRequestPath implements RequestPath {
break;
}
begin = end + 1;
if (begin == path.length()) {
// trailing slash
result.add(EMPTY_PATH_SEGMENT);
break;
}
}
return new DefaultPathSegmentContainer(path, result);
}
private static PathSegment parsePathSegment(String input, Charset charset) {
static PathSegment parsePathSegment(String input, Charset charset) {
if ("".equals(input)) {
return EMPTY_PATH_SEGMENT;
}
int index = input.indexOf(';');
if (index == -1) {
return new DefaultPathSegment(input, StringUtils.uriDecode(input, charset), "", EMPTY_MAP);
String inputDecoded = StringUtils.uriDecode(input, charset);
return new DefaultPathSegment(input, inputDecoded, "", EMPTY_MAP);
}
String value = input.substring(0, index);
String valueDecoded = StringUtils.uriDecode(value, charset);
@@ -180,16 +177,37 @@ class DefaultRequestPath implements RequestPath {
}
// PathSegmentContainer methods..
@Override
public boolean isEmpty() {
return this.contextPath.isEmpty() && this.pathWithinApplication.isEmpty();
}
@Override
public String value() {
return this.fullPath.value();
}
@Override
public boolean isAbsolute() {
return !this.contextPath.isEmpty() && this.contextPath.isAbsolute() || this.pathWithinApplication.isAbsolute();
}
@Override
public List<PathSegment> pathSegments() {
return this.fullPath.pathSegments();
}
@Override
public boolean hasTrailingSlash() {
return this.pathWithinApplication.hasTrailingSlash();
}
// RequestPath methods..
@Override
public PathSegmentContainer contextPath() {
return this.contextPath;
@@ -205,12 +223,22 @@ class DefaultRequestPath implements RequestPath {
private final String path;
private final boolean empty;
private final boolean absolute;
private final List<PathSegment> pathSegments;
private final boolean trailingSlash;
DefaultPathSegmentContainer(String path, List<PathSegment> pathSegments) {
DefaultPathSegmentContainer(String path, List<PathSegment> segments) {
this.path = path;
this.pathSegments = Collections.unmodifiableList(pathSegments);
this.absolute = path.startsWith("/");
this.pathSegments = Collections.unmodifiableList(segments);
this.trailingSlash = path.endsWith("/") && path.length() > 1;
this.empty = !this.absolute && !this.trailingSlash && segments.stream().allMatch(PathSegment::isEmpty);
}
@@ -219,11 +247,26 @@ class DefaultRequestPath implements RequestPath {
return this.path;
}
@Override
public boolean isEmpty() {
return this.empty;
}
@Override
public boolean isAbsolute() {
return this.absolute;
}
@Override
public List<PathSegment> pathSegments() {
return this.pathSegments;
}
@Override
public boolean hasTrailingSlash() {
return this.trailingSlash;
}
@Override
public boolean equals(Object other) {
@@ -254,6 +297,10 @@ class DefaultRequestPath implements RequestPath {
private final String valueDecoded;
private final char[] valueCharsDecoded;
private final boolean empty;
private final String semicolonContent;
private final MultiValueMap<String, String> parameters;
@@ -262,8 +309,12 @@ class DefaultRequestPath implements RequestPath {
DefaultPathSegment(String value, String valueDecoded, String semicolonContent,
MultiValueMap<String, String> params) {
Assert.isTrue(!value.contains("/"), "Invalid path segment value: " + value);
this.value = value;
this.valueDecoded = valueDecoded;
this.valueCharsDecoded = valueDecoded.toCharArray();
this.empty = !StringUtils.hasText(this.valueDecoded);
this.semicolonContent = semicolonContent;
this.parameters = CollectionUtils.unmodifiableMultiValueMap(params);
}
@@ -279,6 +330,16 @@ class DefaultRequestPath implements RequestPath {
return this.valueDecoded;
}
@Override
public char[] valueCharsDecoded() {
return this.valueCharsDecoded;
}
@Override
public boolean isEmpty() {
return this.empty;
}
@Override
public String semicolonContent() {
return this.semicolonContent;

View File

@@ -107,7 +107,7 @@ class DefaultServerHttpRequestBuilder implements ServerHttpRequest.Builder {
return null;
}
else if (uriToUse == null) {
return new DefaultRequestPath(this.delegate.getPath(), this.contextPath, StandardCharsets.UTF_8);
return new DefaultRequestPath(this.delegate.getPath(), this.contextPath);
}
else {
return new DefaultRequestPath(uriToUse, this.contextPath, StandardCharsets.UTF_8);

View File

@@ -15,6 +15,8 @@
*/
package org.springframework.http.server.reactive;
import java.nio.charset.Charset;
import org.springframework.util.MultiValueMap;
/**
@@ -32,10 +34,21 @@ public interface PathSegment {
String value();
/**
* The path {@link #value()} decoded.
* Return the path {@link #value()} decoded.
*/
String valueDecoded();
/**
* Return the same as {@link #valueDecoded()} but as a {@code char[]}.
*/
char[] valueCharsDecoded();
/**
* Whether the path value (encoded or decoded) is empty meaning that it has
* {@link Character#isWhitespace whitespace} characters or none.
*/
boolean isEmpty();
/**
* Return the portion of the path segment after and including the first
* ";" (semicolon) representing path parameters. The actual parsed
@@ -48,4 +61,15 @@ public interface PathSegment {
*/
MultiValueMap<String, String> parameters();
/**
* Parse the given path segment value.
* @param path the value to parse
* @param encoding the charset to use for the decoded value
* @return the parsed path segment
*/
static PathSegment parse(String path, Charset encoding) {
return DefaultRequestPath.parsePathSegment(path, encoding);
}
}

View File

@@ -15,13 +15,18 @@
*/
package org.springframework.http.server.reactive;
import java.nio.charset.Charset;
import java.util.List;
/**
* Container for 0..N path segments.
*
* <p>Typically consumed via {@link ServerHttpRequest#getPath()} but can also
* be created by parsing a path value via {@link #parse(String, Charset)}.
*
* @author Rossen Stoyanchev
* @since 5.0
* @see RequestPath
*/
public interface PathSegmentContainer {
@@ -30,9 +35,36 @@ public interface PathSegmentContainer {
*/
String value();
/**
* Whether the path (encoded or decoded) is empty meaning that it has
* {@link Character#isWhitespace whitespace} characters or none.
*/
boolean isEmpty();
/**
* Whether the path {@link #value()} starts with "/".
*/
boolean isAbsolute();
/**
* The list of path segments contained.
*/
List<PathSegment> pathSegments();
/**
* Whether the path {@link #value()} ends with "/".
*/
boolean hasTrailingSlash();
/**
* Parse the given path value into a {@link PathSegmentContainer}.
* @param path the value to parse
* @param encoding the charset to use for decoded path segment values
* @return the parsed path
*/
static PathSegmentContainer parse(String path, Charset encoding) {
return DefaultRequestPath.parsePath(path, encoding);
}
}