impl: HttpHeaders.backedBy and HttpHeaders.copyOf to reduce ambiguity on the constructor.

craftmaster2190 · craftmaster2190 · commit 942dba2ca944 · 2025-01-30T08:55:46.000-07:00
Fixes spring-projects#34340 chore: Update constructor references with backedBy method. Signed-off-by: Bryce J. Fisher <bryce.fisher@gmail.com>
diff --git a/spring-web/src/main/java/org/springframework/http/HttpHeaders.java b/spring-web/src/main/java/org/springframework/http/HttpHeaders.java
@@ -452,7 +452,9 @@ public HttpHeaders() {
 	 * headers map structures, primarily for internal use within the framework.
 	 * @param headers the headers map (expected to operate with case-insensitive keys)
 	 * @since 5.1
+	 * @deprecated Will be made default visibility in favor of {@link #backedBy(MultiValueMap)} in a future release.
 	 */
+	@Deprecated
 	public HttpHeaders(MultiValueMap<String, String> headers) {
 		Assert.notNull(headers, "MultiValueMap must not be null");
 		if (headers == EMPTY) {
@@ -477,7 +479,9 @@ else if (headers instanceof HttpHeaders httpHeaders) {
 	 * likely to be out of sync and should be discarded.
 	 * @param httpHeaders the headers to expose
 	 * @since 7.0
+	 * @deprecated Will be made private in favor of {@link #backedBy(HttpHeaders)} in a future release.
 	 */
+	@Deprecated
 	public HttpHeaders(HttpHeaders httpHeaders) {
 		Assert.notNull(httpHeaders, "HttpHeaders must not be null");
 		if (httpHeaders == EMPTY) {
@@ -491,6 +495,49 @@ public HttpHeaders(HttpHeaders httpHeaders) {
 		}
 	}
 
+	/**
+	 * Construct a new {@code HttpHeaders} instance backed by an existing map.
+	 * <p>This constructor is available as an optimization for adapting to existing
+	 * headers map structures, primarily for internal use within the framework.
+	 * @param headers the headers map (expected to operate with case-insensitive keys)
+	 */
+	@SuppressWarnings("deprecation") // @Deprecated wll be removed when visibility is changed.
+	public static HttpHeaders backedBy(MultiValueMap<String, String> headers) {
+		return new HttpHeaders(headers);
+	}
+
+	/**
+	 * Construct a new {@code HttpHeaders} instance by removing any read-only
+	 * wrapper that may have been previously applied around the given
+	 * {@code HttpHeaders} via {@link #readOnlyHttpHeaders(HttpHeaders)}.
+	 * <p>Once the writable instance is mutated, the read-only instance is
+	 * likely to be out of sync and should be discarded.
+	 * @param httpHeaders the headers to expose
+	 */
+	@SuppressWarnings("deprecation") // @Deprecated wll be removed when visibility is changed.
+	public static HttpHeaders backedBy(HttpHeaders httpHeaders) {
+		return new HttpHeaders(httpHeaders);
+	}
+
+	/**
+	 * Constructs a new {@code HttpHeaders} instance with the given headers.
+	 * Changes made to this new instance will NOT be reflected in the original headers.
+	 * @param headers The headers to copy
+	 */
+	public static HttpHeaders copyOf(MultiValueMap<String, String> headers) {
+		HttpHeaders httpHeadersCopy = new HttpHeaders();
+		headers.forEach((key, values) -> httpHeadersCopy.put(key, new ArrayList<>(values)));
+		return httpHeadersCopy;
+	}
+
+	/**
+	 * Constructs a new {@code HttpHeaders} instance with the given headers.
+	 * Changes made to this new instance will NOT be reflected in the original headers.
+	 * @param httpHeaders The headers to copy
+	 */
+	public static HttpHeaders copyOf(HttpHeaders httpHeaders) {
+		return copyOf(httpHeaders.headers);
+	}
 
 	/**
 	 * Get the list of header values for the given header name, if any.
diff --git a/spring-web/src/main/java/org/springframework/http/ReadOnlyHttpHeaders.java b/spring-web/src/main/java/org/springframework/http/ReadOnlyHttpHeaders.java
@@ -36,6 +36,7 @@
  * <p>This caches the parsed representations of the "Accept" and "Content-Type" headers
  * and will get out of sync with the backing map it is mutated at runtime.
  *
+ * @implNote This does NOT make the underlying MultiValueMap readonly.
  * @author Brian Clozel
  * @author Sam Brannen
  * @since 5.1.1
@@ -49,7 +50,7 @@ class ReadOnlyHttpHeaders extends HttpHeaders {
 	@SuppressWarnings("serial")
 	private @Nullable List<MediaType> cachedAccept;
 
-
+	@SuppressWarnings("deprecation") // @Deprecated wll be removed when visibility is changed.
 	ReadOnlyHttpHeaders(MultiValueMap<String, String> headers) {
 		super(headers);
 	}
diff --git a/spring-web/src/main/java/org/springframework/http/codec/multipart/PartHttpMessageWriter.java b/spring-web/src/main/java/org/springframework/http/codec/multipart/PartHttpMessageWriter.java
@@ -91,7 +91,7 @@ public Mono<Void> write(Publisher<? extends Part> parts,
 	}
 
 	private <T> Flux<DataBuffer> encodePart(byte[] boundary, Part part, DataBufferFactory bufferFactory) {
-		HttpHeaders headers = new HttpHeaders(part.headers());
+		HttpHeaders headers = HttpHeaders.backedBy(part.headers());
 
 		String name = part.name();
 		if (!headers.containsHeader(HttpHeaders.CONTENT_DISPOSITION)) {
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/JettyCoreServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/JettyCoreServerHttpRequest.java
@@ -56,7 +56,7 @@ public JettyCoreServerHttpRequest(Request request, JettyDataBufferFactory dataBu
 		super(HttpMethod.valueOf(request.getMethod()),
 				request.getHttpURI().toURI(),
 				request.getContext().getContextPath(),
-				new HttpHeaders(new JettyHeadersAdapter(request.getHeaders())));
+				HttpHeaders.backedBy(new JettyHeadersAdapter(request.getHeaders())));
 		this.dataBufferFactory = dataBufferFactory;
 		this.request = request;
 	}
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/JettyCoreServerHttpResponse.java b/spring-web/src/main/java/org/springframework/http/server/reactive/JettyCoreServerHttpResponse.java
@@ -56,7 +56,7 @@ class JettyCoreServerHttpResponse extends AbstractServerHttpResponse implements
 
 
 	public JettyCoreServerHttpResponse(Response response, JettyDataBufferFactory dataBufferFactory) {
-		super(dataBufferFactory, new HttpHeaders(new JettyHeadersAdapter(response.getHeaders())));
+		super(dataBufferFactory, HttpHeaders.backedBy(new JettyHeadersAdapter(response.getHeaders())));
 		this.response = response;
 
 		// remove all existing cookies from the response and add them to the cookie map, to be added back later
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorNetty2ServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorNetty2ServerHttpRequest.java
@@ -71,7 +71,7 @@ public ReactorNetty2ServerHttpRequest(HttpServerRequest request, Netty5DataBuffe
 			throws URISyntaxException {
 
 		super(HttpMethod.valueOf(request.method().name()), initUri(request), "",
-				new HttpHeaders(new Netty5HeadersAdapter(request.requestHeaders())));
+				HttpHeaders.backedBy(new Netty5HeadersAdapter(request.requestHeaders())));
 		Assert.notNull(bufferFactory, "DataBufferFactory must not be null");
 		this.request = request;
 		this.bufferFactory = bufferFactory;
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorNetty2ServerHttpResponse.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorNetty2ServerHttpResponse.java
@@ -58,7 +58,7 @@ class ReactorNetty2ServerHttpResponse extends AbstractServerHttpResponse impleme
 
 
 	public ReactorNetty2ServerHttpResponse(HttpServerResponse response, DataBufferFactory bufferFactory) {
-		super(bufferFactory, new HttpHeaders(new Netty5HeadersAdapter(response.responseHeaders())));
+		super(bufferFactory, HttpHeaders.backedBy(new Netty5HeadersAdapter(response.responseHeaders())));
 		Assert.notNull(response, "HttpServerResponse must not be null");
 		this.response = response;
 	}
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorServerHttpRequest.java
@@ -68,7 +68,7 @@ public ReactorServerHttpRequest(HttpServerRequest request, NettyDataBufferFactor
 
 		super(HttpMethod.valueOf(request.method().name()),
 				ReactorUriHelper.createUri(request), request.forwardedPrefix(),
-				new HttpHeaders(new Netty4HeadersAdapter(request.requestHeaders())));
+				HttpHeaders.backedBy(new Netty4HeadersAdapter(request.requestHeaders())));
 		Assert.notNull(bufferFactory, "DataBufferFactory must not be null");
 		this.request = request;
 		this.bufferFactory = bufferFactory;
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorServerHttpResponse.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ReactorServerHttpResponse.java
@@ -57,7 +57,7 @@ class ReactorServerHttpResponse extends AbstractServerHttpResponse implements Ze
 
 
 	public ReactorServerHttpResponse(HttpServerResponse response, DataBufferFactory bufferFactory) {
-		super(bufferFactory, new HttpHeaders(new Netty4HeadersAdapter(Objects.requireNonNull(response,
+		super(bufferFactory, HttpHeaders.backedBy(new Netty4HeadersAdapter(Objects.requireNonNull(response,
 				"HttpServerResponse must not be null").responseHeaders())));
 		this.response = response;
 	}
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/ServletServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/ServletServerHttpRequest.java
@@ -168,7 +168,7 @@ private static HttpHeaders initHeaders(HttpHeaders headerValues, HttpServletRequ
 			String requestContentType = request.getContentType();
 			if (StringUtils.hasLength(requestContentType)) {
 				contentType = MediaType.parseMediaType(requestContentType);
-				headers = new HttpHeaders(headerValues);
+				headers = HttpHeaders.backedBy(headerValues);
 				headers.setContentType(contentType);
 			}
 		}
@@ -184,7 +184,7 @@ private static HttpHeaders initHeaders(HttpHeaders headerValues, HttpServletRequ
 		if (headerValues.getFirst(HttpHeaders.CONTENT_TYPE) == null) {
 			int contentLength = request.getContentLength();
 			if (contentLength != -1) {
-				headers = (headers != null ? headers : new HttpHeaders(headerValues));
+				headers = (headers != null ? headers : HttpHeaders.backedBy(headerValues));
 				headers.setContentLength(contentLength);
 			}
 		}
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/TomcatHttpHandlerAdapter.java b/spring-web/src/main/java/org/springframework/http/server/reactive/TomcatHttpHandlerAdapter.java
@@ -96,7 +96,7 @@ private static HttpHeaders createTomcatHttpHeaders(HttpServletRequest request) {
 					ReflectionUtils.getField(COYOTE_REQUEST_FIELD, requestFacade);
 			Assert.state(connectorRequest != null, "No Tomcat connector request");
 			Request tomcatRequest = connectorRequest.getCoyoteRequest();
-			return new HttpHeaders(new TomcatHeadersAdapter(tomcatRequest.getMimeHeaders()));
+			return HttpHeaders.backedBy(new TomcatHeadersAdapter(tomcatRequest.getMimeHeaders()));
 		}
 
 		private static RequestFacade getRequestFacade(HttpServletRequest request) {
@@ -140,7 +140,7 @@ private static HttpHeaders createTomcatHttpHeaders(HttpServletResponse response)
 			Assert.state(connectorResponse != null, "No Tomcat connector response");
 			Response tomcatResponse = connectorResponse.getCoyoteResponse();
 			TomcatHeadersAdapter headers = new TomcatHeadersAdapter(tomcatResponse.getMimeHeaders());
-			return new HttpHeaders(headers);
+			return HttpHeaders.backedBy(headers);
 		}
 
 		private static ResponseFacade getResponseFacade(HttpServletResponse response) {
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java b/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpRequest.java
@@ -66,7 +66,7 @@ public UndertowServerHttpRequest(HttpServerExchange exchange, DataBufferFactory
 			throws URISyntaxException {
 
 		super(HttpMethod.valueOf(exchange.getRequestMethod().toString()), initUri(exchange), "",
-				new HttpHeaders(new UndertowHeadersAdapter(exchange.getRequestHeaders())));
+				HttpHeaders.backedBy(new UndertowHeadersAdapter(exchange.getRequestHeaders())));
 		this.exchange = exchange;
 		this.body = new RequestBodyPublisher(exchange, bufferFactory);
 		this.body.registerListeners(exchange);
diff --git a/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpResponse.java b/spring-web/src/main/java/org/springframework/http/server/reactive/UndertowServerHttpResponse.java
@@ -70,7 +70,7 @@ class UndertowServerHttpResponse extends AbstractListenerServerHttpResponse impl
 	private static HttpHeaders createHeaders(HttpServerExchange exchange) {
 		Assert.notNull(exchange, "HttpServerExchange must not be null");
 		UndertowHeadersAdapter headersMap = new UndertowHeadersAdapter(exchange.getResponseHeaders());
-		return new HttpHeaders(headersMap);
+		return HttpHeaders.backedBy(headersMap);
 	}
 
 
diff --git a/spring-web/src/test/java/org/springframework/http/HttpHeadersTests.java b/spring-web/src/test/java/org/springframework/http/HttpHeadersTests.java
@@ -58,23 +58,71 @@ class HttpHeadersTests {
 	final HttpHeaders headers = new HttpHeaders();
 
 	@Test
-	void constructorUnwrapsReadonly() {
+	void backedByFactoryUnwrapsReadonly() {
 		headers.setContentType(MediaType.APPLICATION_JSON);
 		HttpHeaders readOnly = HttpHeaders.readOnlyHttpHeaders(headers);
 		assertThat(readOnly.getContentType()).isEqualTo(MediaType.APPLICATION_JSON);
-		HttpHeaders writable = new HttpHeaders(readOnly);
+		HttpHeaders writable = HttpHeaders.backedBy(readOnly);
 		writable.setContentType(MediaType.TEXT_PLAIN);
+
 		// content-type value is cached by ReadOnlyHttpHeaders
+		assertThat(readOnly.getContentType())
+				.describedAs("readOnly HttpHeaders should NOT have updated content-type value")
+				.isEqualTo(MediaType.APPLICATION_JSON);
+		assertThat(writable.getContentType())
+				.describedAs("writable HttpHeaders should have updated content-type value")
+				.isEqualTo(MediaType.TEXT_PLAIN);
+		assertThat(headers.getContentType())
+				.describedAs("initial HttpHeaders should have updated content-type value")
+				.isEqualTo(MediaType.TEXT_PLAIN);
+	}
+
+	@Test
+	void backedByFactoryUnwrapsMultipleHeaders() {
+		headers.setContentType(MediaType.APPLICATION_JSON);
+		HttpHeaders readonlyOriginalExchangeHeaders = HttpHeaders.readOnlyHttpHeaders(headers);
+		HttpHeaders firewallHeaders = HttpHeaders.backedBy(readonlyOriginalExchangeHeaders);
+		HttpHeaders writeable = HttpHeaders.backedBy(firewallHeaders);
+		writeable.setContentType(MediaType.TEXT_PLAIN);
+
+		// If readonly headers are unwrapped multiple times, the content-type value should be updated
+		assertThat(writeable.getContentType()).isEqualTo(MediaType.TEXT_PLAIN);
+		assertThat(firewallHeaders.getContentType()).isEqualTo(MediaType.TEXT_PLAIN);
+		assertThat(readonlyOriginalExchangeHeaders.getContentType()).isEqualTo(MediaType.TEXT_PLAIN);
+		assertThat(headers.getContentType()).isEqualTo(MediaType.TEXT_PLAIN);
+	}
+
+	@Test
+	void copyOfFactoryUnwrapsReadonly() {
+		headers.setContentType(MediaType.APPLICATION_JSON);
+		HttpHeaders readOnly = HttpHeaders.readOnlyHttpHeaders(headers);
 		assertThat(readOnly.getContentType()).isEqualTo(MediaType.APPLICATION_JSON);
-		assertThat(writable.getContentType()).isEqualTo(MediaType.TEXT_PLAIN);
+		HttpHeaders writable = HttpHeaders.copyOf(readOnly);
+		writable.setContentType(MediaType.TEXT_PLAIN);
+
+		assertThat(readOnly.getContentType())
+				.describedAs("readOnly HttpHeaders should NOT have updated content-type value")
+				.isEqualTo(MediaType.APPLICATION_JSON);
+		assertThat(writable.getContentType())
+				.describedAs("writable HttpHeaders should have updated content-type value")
+				.isEqualTo(MediaType.TEXT_PLAIN);
+		assertThat(headers.getContentType())
+				.describedAs("initial HttpHeaders should have updated content-type value")
+				.isEqualTo(MediaType.APPLICATION_JSON);
 	}
 
 	@Test
-	void writableHttpHeadersUnwrapsMultiple() {
-		HttpHeaders originalExchangeHeaders = HttpHeaders.readOnlyHttpHeaders(new HttpHeaders());
-		HttpHeaders firewallHeaders = new HttpHeaders(originalExchangeHeaders);
-		HttpHeaders writeable = new HttpHeaders(firewallHeaders);
-		writeable.setContentType(MediaType.APPLICATION_JSON);
+	void copyOfFactoryUnwrapsMultipleHeaders() {
+		headers.setContentType(MediaType.APPLICATION_JSON);
+		HttpHeaders readonlyOriginalExchangeHeaders = HttpHeaders.readOnlyHttpHeaders(headers);
+		HttpHeaders firewallHeaders = HttpHeaders.copyOf(readonlyOriginalExchangeHeaders);
+		HttpHeaders writeable = HttpHeaders.copyOf(firewallHeaders);
+		writeable.setContentType(MediaType.TEXT_PLAIN);
+
+		assertThat(writeable.getContentType()).isEqualTo(MediaType.TEXT_PLAIN);
+		assertThat(firewallHeaders.getContentType()).isEqualTo(MediaType.APPLICATION_JSON);
+		assertThat(readonlyOriginalExchangeHeaders.getContentType()).isEqualTo(MediaType.APPLICATION_JSON);
+		assertThat(headers.getContentType()).isEqualTo(MediaType.APPLICATION_JSON);
 	}
 
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public Mono<Void> write(Publisher<? extends Part> parts,`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`private <T> Flux<DataBuffer> encodePart(byte[] boundary, Part part, DataBufferFactory bufferFactory) {`
`94`		`- HttpHeaders headers = new HttpHeaders(part.headers());`
	`94`	`+ HttpHeaders headers = HttpHeaders.backedBy(part.headers());`
`95`	`95`
`96`	`96`	`String name = part.name();`
`97`	`97`	`if (!headers.containsHeader(HttpHeaders.CONTENT_DISPOSITION)) {`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public JettyCoreServerHttpRequest(Request request, JettyDataBufferFactory dataBu`
`56`	`56`	`super(HttpMethod.valueOf(request.getMethod()),`
`57`	`57`	`request.getHttpURI().toURI(),`
`58`	`58`	`request.getContext().getContextPath(),`
`59`		`- new HttpHeaders(new JettyHeadersAdapter(request.getHeaders())));`
	`59`	`+ HttpHeaders.backedBy(new JettyHeadersAdapter(request.getHeaders())));`
`60`	`60`	`this.dataBufferFactory = dataBufferFactory;`
`61`	`61`	`this.request = request;`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ class ReactorNetty2ServerHttpResponse extends AbstractServerHttpResponse impleme`
`58`	`58`
`59`	`59`
`60`	`60`	`public ReactorNetty2ServerHttpResponse(HttpServerResponse response, DataBufferFactory bufferFactory) {`
`61`		`- super(bufferFactory, new HttpHeaders(new Netty5HeadersAdapter(response.responseHeaders())));`
	`61`	`+ super(bufferFactory, HttpHeaders.backedBy(new Netty5HeadersAdapter(response.responseHeaders())));`
`62`	`62`	`Assert.notNull(response, "HttpServerResponse must not be null");`
`63`	`63`	`this.response = response;`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class ReactorServerHttpResponse extends AbstractServerHttpResponse implements Ze`
`57`	`57`
`58`	`58`
`59`	`59`	`public ReactorServerHttpResponse(HttpServerResponse response, DataBufferFactory bufferFactory) {`
`60`		`- super(bufferFactory, new HttpHeaders(new Netty4HeadersAdapter(Objects.requireNonNull(response,`
	`60`	`+ super(bufferFactory, HttpHeaders.backedBy(new Netty4HeadersAdapter(Objects.requireNonNull(response,`
`61`	`61`	`"HttpServerResponse must not be null").responseHeaders())));`
`62`	`62`	`this.response = response;`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -168,7 +168,7 @@ private static HttpHeaders initHeaders(HttpHeaders headerValues, HttpServletRequ`
`168`	`168`	`String requestContentType = request.getContentType();`
`169`	`169`	`if (StringUtils.hasLength(requestContentType)) {`
`170`	`170`	`contentType = MediaType.parseMediaType(requestContentType);`
`171`		`- headers = new HttpHeaders(headerValues);`
	`171`	`+ headers = HttpHeaders.backedBy(headerValues);`
`172`	`172`	`headers.setContentType(contentType);`
`173`	`173`	`}`
`174`	`174`	`}`
`@@ -184,7 +184,7 @@ private static HttpHeaders initHeaders(HttpHeaders headerValues, HttpServletRequ`
`184`	`184`	`if (headerValues.getFirst(HttpHeaders.CONTENT_TYPE) == null) {`
`185`	`185`	`int contentLength = request.getContentLength();`
`186`	`186`	`if (contentLength != -1) {`
`187`		`- headers = (headers != null ? headers : new HttpHeaders(headerValues));`
	`187`	`+ headers = (headers != null ? headers : HttpHeaders.backedBy(headerValues));`
`188`	`188`	`headers.setContentLength(contentLength);`
`189`	`189`	`}`
`190`	`190`	`}`