Browse Source

Add getQueryParams to ServerHttpRequest

pull/1111/head
Rossen Stoyanchev 9 years ago
parent
commit
a7f32cd528
  1. 38
      spring-web-reactive/src/main/java/org/springframework/http/server/reactive/AbstractServerHttpRequest.java
  2. 8
      spring-web-reactive/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java
  3. 7
      spring-web-reactive/src/test/java/org/springframework/http/server/reactive/MockServerHttpRequest.java
  4. 79
      spring-web-reactive/src/test/java/org/springframework/http/server/reactive/ServerHttpRequestTests.java

38
spring-web-reactive/src/main/java/org/springframework/http/server/reactive/AbstractServerHttpRequest.java

@ -17,14 +17,15 @@ package org.springframework.http.server.reactive;
import java.net.URI; import java.net.URI;
import java.net.URISyntaxException; import java.net.URISyntaxException;
import java.util.List; import java.util.regex.Matcher;
import java.util.Map; import java.util.regex.Pattern;
import org.springframework.http.HttpCookie; import org.springframework.http.HttpCookie;
import org.springframework.http.HttpHeaders; import org.springframework.http.HttpHeaders;
import org.springframework.util.LinkedCaseInsensitiveMap; import org.springframework.util.CollectionUtils;
import org.springframework.util.LinkedMultiValueMap; import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap; import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
/** /**
* Common base class for {@link ServerHttpRequest} implementations. * Common base class for {@link ServerHttpRequest} implementations.
@ -33,8 +34,13 @@ import org.springframework.util.MultiValueMap;
*/ */
public abstract class AbstractServerHttpRequest implements ServerHttpRequest { public abstract class AbstractServerHttpRequest implements ServerHttpRequest {
private static final Pattern QUERY_PATTERN = Pattern.compile("([^&=]+)(=?)([^&]+)?");
private URI uri; private URI uri;
private MultiValueMap<String, String> queryParams;
private HttpHeaders headers; private HttpHeaders headers;
private MultiValueMap<String, HttpCookie> cookies; private MultiValueMap<String, HttpCookie> cookies;
@ -60,6 +66,30 @@ public abstract class AbstractServerHttpRequest implements ServerHttpRequest {
*/ */
protected abstract URI initUri() throws URISyntaxException; protected abstract URI initUri() throws URISyntaxException;
@Override
public MultiValueMap<String, String> getQueryParams() {
if (this.queryParams == null) {
this.queryParams = CollectionUtils.unmodifiableMultiValueMap(initQueryParams());
}
return this.queryParams;
}
protected MultiValueMap<String, String> initQueryParams() {
MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
String query = getURI().getRawQuery();
if (query != null) {
Matcher matcher = QUERY_PATTERN.matcher(query);
while (matcher.find()) {
String name = matcher.group(1);
String eq = matcher.group(2);
String value = matcher.group(3);
value = (value != null ? value : (StringUtils.hasLength(eq) ? "" : null));
queryParams.add(name, value);
}
}
return queryParams;
}
@Override @Override
public HttpHeaders getHeaders() { public HttpHeaders getHeaders() {
if (this.headers == null) { if (this.headers == null) {
@ -79,7 +109,7 @@ public abstract class AbstractServerHttpRequest implements ServerHttpRequest {
@Override @Override
public MultiValueMap<String, HttpCookie> getCookies() { public MultiValueMap<String, HttpCookie> getCookies() {
if (this.cookies == null) { if (this.cookies == null) {
this.cookies = new LinkedMultiValueMap<String, HttpCookie>(); this.cookies = new LinkedMultiValueMap<>();
initCookies(this.cookies); initCookies(this.cookies);
} }
return this.cookies; return this.cookies;

8
spring-web-reactive/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java

@ -16,9 +16,6 @@
package org.springframework.http.server.reactive; package org.springframework.http.server.reactive;
import java.util.List;
import java.util.Map;
import org.springframework.http.HttpCookie; import org.springframework.http.HttpCookie;
import org.springframework.http.HttpRequest; import org.springframework.http.HttpRequest;
import org.springframework.http.ReactiveHttpInputMessage; import org.springframework.http.ReactiveHttpInputMessage;
@ -31,6 +28,11 @@ import org.springframework.util.MultiValueMap;
*/ */
public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage { public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage {
/**
* Return a read-only map with parsed and decoded query parameter values.
*/
MultiValueMap<String, String> getQueryParams();
/** /**
* Return a read-only map of cookies sent by the client. * Return a read-only map of cookies sent by the client.
*/ */

7
spring-web-reactive/src/test/java/org/springframework/http/server/reactive/MockServerHttpRequest.java

@ -36,6 +36,8 @@ public class MockServerHttpRequest implements ServerHttpRequest {
private URI uri; private URI uri;
private MultiValueMap<String, String> queryParams = new LinkedMultiValueMap<>();
private HttpHeaders headers = new HttpHeaders(); private HttpHeaders headers = new HttpHeaders();
private MultiValueMap<String, HttpCookie> cookies = new LinkedMultiValueMap<>(); private MultiValueMap<String, HttpCookie> cookies = new LinkedMultiValueMap<>();
@ -79,6 +81,11 @@ public class MockServerHttpRequest implements ServerHttpRequest {
return this.headers; return this.headers;
} }
@Override
public MultiValueMap<String, String> getQueryParams() {
return this.queryParams;
}
@Override @Override
public MultiValueMap<String, HttpCookie> getCookies() { public MultiValueMap<String, HttpCookie> getCookies() {
return this.cookies; return this.cookies;

79
spring-web-reactive/src/test/java/org/springframework/http/server/reactive/ServerHttpRequestTests.java

@ -0,0 +1,79 @@
/*
* Copyright 2002-2016 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.http.server.reactive;
import java.util.Arrays;
import java.util.Collections;
import javax.servlet.http.HttpServletRequest;
import org.junit.Test;
import reactor.core.publisher.Flux;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.util.MultiValueMap;
import static org.junit.Assert.assertEquals;
/**
* Unit tests for {@link AbstractServerHttpRequest}.
*
* @author Rossen Stoyanchev
*/
public class ServerHttpRequestTests {
@Test
public void queryParamsNone() throws Exception {
MultiValueMap<String, String> params = createHttpRequest("/path").getQueryParams();
assertEquals(0, params.size());
}
@Test
public void queryParams() throws Exception {
MultiValueMap<String, String> params = createHttpRequest("/path?a=A&b=B").getQueryParams();
assertEquals(2, params.size());
assertEquals(Collections.singletonList("A"), params.get("a"));
assertEquals(Collections.singletonList("B"), params.get("b"));
}
@Test
public void queryParamsWithMulitpleValues() throws Exception {
MultiValueMap<String, String> params = createHttpRequest("/path?a=1&a=2").getQueryParams();
assertEquals(1, params.size());
assertEquals(Arrays.asList("1", "2"), params.get("a"));
}
@Test
public void queryParamsWithEmptyValue() throws Exception {
MultiValueMap<String, String> params = createHttpRequest("/path?a=").getQueryParams();
assertEquals(1, params.size());
assertEquals(Collections.singletonList(""), params.get("a"));
}
@Test
public void queryParamsWithNoValue() throws Exception {
MultiValueMap<String, String> params = createHttpRequest("/path?a").getQueryParams();
assertEquals(1, params.size());
assertEquals(Collections.singletonList(null), params.get("a"));
}
private ServerHttpRequest createHttpRequest(String path) {
HttpServletRequest servletRequest = new MockHttpServletRequest("GET", path);
return new ServletServerHttpRequest(servletRequest, Flux.empty());
}
}
Loading…
Cancel
Save