Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inaccuracy in RequestHeaderArgumentResolver Javadoc #34230

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -940,7 +940,7 @@ method parameters:
| `@RequestHeader`
| Add a request header or multiple headers. The argument may be a `Map<String, ?>` or
`MultiValueMap<String, ?>` with multiple headers, a `Collection<?>` of values, or an
individual value. Type conversion is supported for non-String values. This overrides
individual value. Type conversion is supported for non-String values. This does not override
the annotation's `headers` attribute.

| `@PathVariable`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
Expand All @@ -23,6 +23,7 @@
import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.service.annotation.GetExchange;
import org.springframework.web.service.annotation.HttpExchange;

import static org.assertj.core.api.Assertions.assertThat;

Expand All @@ -32,6 +33,7 @@
*
* @author Olga Maciaszek-Sharma
* @author Rossen Stoyanchev
* @author Yanming Zhou
*/
class RequestHeaderArgumentResolverTests {

Expand All @@ -49,6 +51,12 @@ void header() {
assertRequestHeaders("id", "test");
}

@Test
void doesNotOverrideAnnotationHeaders() {
this.service.executeWithAnnotationHeaders("test");
assertRequestHeaders("id", "default", "test");
}

private void assertRequestHeaders(String key, String... values) {
List<String> actualValues = this.client.getRequestValues().getHeaders().get(key);
if (ObjectUtils.isEmpty(values)) {
Expand All @@ -65,6 +73,9 @@ private interface Service {
@GetExchange
void execute(@RequestHeader String id);

@HttpExchange(method = "GET", headers = "id=default")
void executeWithAnnotationHeaders(@RequestHeader String id);

}

}
Loading