Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introduce ServerHttpRequest.Builder.header() variant for setting headers

Browse Source 
Prior to this commit, the `header(String, String)` method in the
ServerHttpRequest.Builder API actually added a header value instead of
setting or overriding a header value. Since this conflicted with the
stated behavior in the Javadoc as well as the original intention of the
method, we have decided to introduce an overloaded variant
`header(String, String...)` which accepts a var-args list of header
values to set or override.

In addition, this commit deprecates the existing `header(String, String)`
method for removal in Spring Framework 5.2.

In order not to be a breaking change for custom implementations of the
builder API, this commit implements the new `header(String, String...)`
method as an interface `default` method, with the intent to remove the
default implementation in Spring Framework 5.2

closes gh-23333
This commit is contained in:
Sam Brannen
2019-07-25 13:45:39 +02:00
parent db3990d031
commit 9655fc5007
3 changed files with 16 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
spring-web/src/test/java/org/springframework/http/server/reactive/ServerHttpRequestTests.java
View File

@@ -126,27 +126,21 @@ public class ServerHttpRequestTests {
}
@Test
@SuppressWarnings("deprecation")
public void mutateHeaderByAddingHeaderValues() throws Exception {
public void mutateHeadersViaConsumer() throws Exception {
String headerName = "key";
String headerValue1 = "value1";
String headerValue2 = "value2";
ServerHttpRequest request = createHttpRequest("/path");
assertNull(request.getHeaders().get(headerName));
assertThat(request.getHeaders().get(headerName)).isNull();
request = request.mutate().header(headerName, headerValue1).build();
request = request.mutate().headers(headers -> headers.add(headerName, headerValue1)).build();
assertNotNull(request.getHeaders().get(headerName));
assertEquals(1, request.getHeaders().get(headerName).size());
assertEquals(headerValue1, request.getHeaders().get(headerName).get(0));
assertThat(request.getHeaders().get(headerName)).containsExactly(headerValue1);
request = request.mutate().header(headerName, headerValue2).build();
request = request.mutate().headers(headers -> headers.add(headerName, headerValue2)).build();
assertNotNull(request.getHeaders().get(headerName));
assertEquals(2, request.getHeaders().get(headerName).size());
assertEquals(headerValue1, request.getHeaders().get(headerName).get(0));
assertEquals(headerValue2, request.getHeaders().get(headerName).get(1));
assertThat(request.getHeaders().get(headerName)).containsExactly(headerValue1, headerValue2);
}
@Test
@@ -157,20 +151,15 @@ public class ServerHttpRequestTests {
String headerValue3 = "value3";
ServerHttpRequest request = createHttpRequest("/path");
assertNull(request.getHeaders().get(headerName));
assertThat(request.getHeaders().get(headerName)).isNull();
request = request.mutate().header(headerName, headerValue1, headerValue2).build();
assertNotNull(request.getHeaders().get(headerName));
assertEquals(2, request.getHeaders().get(headerName).size());
assertEquals(headerValue1, request.getHeaders().get(headerName).get(0));
assertEquals(headerValue2, request.getHeaders().get(headerName).get(1));
assertThat(request.getHeaders().get(headerName)).containsExactly(headerValue1, headerValue2);
request = request.mutate().header(headerName, new String[] { headerValue3 }).build();
request = request.mutate().header(headerName, headerValue3).build();
assertNotNull(request.getHeaders().get(headerName));
assertEquals(1, request.getHeaders().get(headerName).size());
assertEquals(headerValue3, request.getHeaders().get(headerName).get(0));
assertThat(request.getHeaders().get(headerName)).containsExactly(headerValue3);
}
private ServerHttpRequest createHttpRequest(String uriString) throws Exception {