spring/spring-framework
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-framework.git synced 2026-10-06 15:09:34 +00:00
Code Issues Projects Releases Wiki Activity

Polishing contribution

Browse Source 
Closes gh-36400
This commit is contained in:
rstoyanchev
2026-03-10 19:14:41 +00:00
parent d4893fb32f
commit 5168e3a38b
11 changed files with 122 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files
spring-test/src/main/java/org/springframework/mock/web/server/MockServerWebExchange.java
+4 -12
View File
@@ -49,17 +49,9 @@ public final class MockServerWebExchange extends DefaultServerWebExchange {
MockServerHttpRequest request, @Nullable WebSessionManager sessionManager,
@Nullable ApplicationContext applicationContext, @Nullable Principal principal) {
this(request, sessionManager, applicationContext, null, principal);
}
private MockServerWebExchange(
MockServerHttpRequest request, @Nullable WebSessionManager sessionManager,
@Nullable ApplicationContext applicationContext, @Nullable Boolean defaultHtmlEscape, @Nullable Principal principal) {
super(request, new MockServerHttpResponse(),
sessionManager != null ? sessionManager : new DefaultWebSessionManager(),
ServerCodecConfigurer.create(), new AcceptHeaderLocaleContextResolver(),
applicationContext, defaultHtmlEscape);
ServerCodecConfigurer.create(), new AcceptHeaderLocaleContextResolver(), applicationContext);
this.principalMono = (principal != null) ? Mono.just(principal) : Mono.empty();
}
@@ -180,8 +172,8 @@ public final class MockServerWebExchange extends DefaultServerWebExchange {
* @since 7.0.6
*/
public Builder defaultHtmlEscape(@Nullable Boolean defaultHtmlEscape) {
this.defaultHtmlEscape = defaultHtmlEscape;
return this;
this.defaultHtmlEscape = defaultHtmlEscape;
return this;
}
/**
@@ -199,7 +191,7 @@ public final class MockServerWebExchange extends DefaultServerWebExchange {
*/
public MockServerWebExchange build() {
return new MockServerWebExchange(
this.request, this.sessionManager, this.applicationContext, this.defaultHtmlEscape, this.principal);
this.request, this.sessionManager, this.applicationContext, this.principal);
}
}
spring-web/src/main/java/org/springframework/web/server/ServerWebExchange.java
+6 -9
View File
@@ -43,6 +43,12 @@ import org.springframework.util.MultiValueMap;
*/
public interface ServerWebExchange {
/**
* HTML escape attribute, populated from the value of
* {@link org.springframework.web.server.adapter.WebHttpHandlerBuilder#defaultHtmlEscape(Boolean)}.
*/
String HTML_ESCAPE_ATTRIBUTE = ServerWebExchange.class.getName() + ".HTML_ESCAPE";
/**
* Name of {@link #getAttributes() attribute} whose value can be used to
* correlate log messages for this exchange. Use {@link #getLogPrefix()} to
@@ -169,15 +175,6 @@ public interface ServerWebExchange {
*/
@Nullable ApplicationContext getApplicationContext();
/**
* Return the default HTML escape setting available for the current request,
* or {@code null} if no default was configured at the handler level.
* @return whether default HTML escaping is enabled, or {@code null} if not configured
* @since 7.0.6
* @see org.springframework.web.server.adapter.WebHttpHandlerBuilder#defaultHtmlEscape(boolean)
*/
@Nullable Boolean getDefaultHtmlEscape();
/**
* Returns {@code true} if the one of the {@code checkNotModified} methods
* in this contract were used and they returned true.
spring-web/src/main/java/org/springframework/web/server/ServerWebExchangeDecorator.java
-5
View File
@@ -98,11 +98,6 @@ public class ServerWebExchangeDecorator implements ServerWebExchange {
return getDelegate().getApplicationContext();
}
@Override
public @Nullable Boolean getDefaultHtmlEscape() {
return getDelegate().getDefaultHtmlEscape();
}
@Override
public Mono<MultiValueMap<String, String>> getFormData() {
return getDelegate().getFormData();
spring-web/src/main/java/org/springframework/web/server/adapter/DefaultServerWebExchange.java
+1 -16
View File
@@ -101,8 +101,6 @@ public class DefaultServerWebExchange implements ServerWebExchange {
private final @Nullable ApplicationContext applicationContext;
private final @Nullable Boolean defaultHtmlEscape;
private volatile boolean notModified;
private Function<String, String> urlTransformer = url -> url;
@@ -116,20 +114,13 @@ public class DefaultServerWebExchange implements ServerWebExchange {
WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer,
LocaleContextResolver localeContextResolver) {
this(request, response, sessionManager, codecConfigurer, localeContextResolver, null, null);
this(request, response, sessionManager, codecConfigurer, localeContextResolver, null);
}
public DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response,
WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer,
LocaleContextResolver localeContextResolver, @Nullable ApplicationContext applicationContext) {
this(request, response, sessionManager, codecConfigurer, localeContextResolver, applicationContext, null);
}
protected DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response,
WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer,
LocaleContextResolver localeContextResolver, @Nullable ApplicationContext applicationContext, @Nullable Boolean defaultHtmlEscape) {
Assert.notNull(request, "'request' is required");
Assert.notNull(response, "'response' is required");
Assert.notNull(sessionManager, "'sessionManager' is required");
@@ -146,7 +137,6 @@ public class DefaultServerWebExchange implements ServerWebExchange {
this.formDataMono = initFormData(request, codecConfigurer, getLogPrefix());
this.multipartDataMono = initMultipartData(codecConfigurer, getLogPrefix());
this.applicationContext = applicationContext;
this.defaultHtmlEscape = defaultHtmlEscape;
if (request instanceof AbstractServerHttpRequest abstractServerHttpRequest) {
abstractServerHttpRequest.setAttributesSupplier(() -> this.attributes);
@@ -288,11 +278,6 @@ public class DefaultServerWebExchange implements ServerWebExchange {
return this.applicationContext;
}
@Override
public @Nullable Boolean getDefaultHtmlEscape() {
return this.defaultHtmlEscape;
}
@Override
public boolean isNotModified() {
return this.notModified;
spring-web/src/main/java/org/springframework/web/server/adapter/HttpWebHandlerAdapter.java
+27 -22
View File
@@ -97,10 +97,10 @@ public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHa
private ServerRequestObservationConvention observationConvention = DEFAULT_OBSERVATION_CONVENTION;
private @Nullable ApplicationContext applicationContext;
private @Nullable Boolean defaultHtmlEscape;
private @Nullable ApplicationContext applicationContext;
/** Whether to log potentially sensitive info (form data at DEBUG, headers at TRACE). */
private boolean enableLoggingRequestDetails = false;
@@ -233,6 +233,26 @@ public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHa
return this.observationConvention;
}
/**
* Configure whether default HTML escaping is enabled for the web application.
* The setting is then exposed as the exchanger attribute
* {@link ServerWebExchange#HTML_ESCAPE_ATTRIBUTE}.
* @param defaultHtmlEscape whether to enable default HTML escaping
* @since 7.0.6
*/
public void setDefaultHtmlEscape(Boolean defaultHtmlEscape) {
this.defaultHtmlEscape = defaultHtmlEscape;
}
/**
* Return the configured default HTML escape setting,
* or {@code null} if not configured.
* @since 7.0.6
*/
public @Nullable Boolean getDefaultHtmlEscape() {
return this.defaultHtmlEscape;
}
/**
* Configure the {@code ApplicationContext} associated with the web application,
* if it was initialized with one via
@@ -252,25 +272,6 @@ public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHa
return this.applicationContext;
}
/**
* Configure a default HTML escape setting to apply to every
* {@link org.springframework.web.server.ServerWebExchange} created
* by this adapter.
* @param defaultHtmlEscape whether to enable default HTML escaping
* @since 7.0.6
*/
public void setDefaultHtmlEscape(Boolean defaultHtmlEscape) {
this.defaultHtmlEscape = defaultHtmlEscape;
}
/**
* Return the configured default HTML escape setting,
* or {@code null} if not configured.
* @since 7.0.6
*/
public @Nullable Boolean getDefaultHtmlEscape() {
return this.defaultHtmlEscape;
}
/**
* This method must be invoked after all properties have been set to
@@ -312,6 +313,10 @@ public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHa
exchange.getAttributes().put(
ServerRequestObservationContext.CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE, observationContext);
if (this.defaultHtmlEscape != null) {
exchange.getAttributes().put(ServerWebExchange.HTML_ESCAPE_ATTRIBUTE, this.defaultHtmlEscape);
}
return getDelegate().handle(exchange)
.doOnSuccess(aVoid -> logResponse(exchange))
.onErrorResume(ex -> handleUnresolvedError(exchange, observationContext, ex))
@@ -322,7 +327,7 @@ public class HttpWebHandlerAdapter extends WebHandlerDecorator implements HttpHa
protected ServerWebExchange createExchange(ServerHttpRequest request, ServerHttpResponse response) {
return new DefaultServerWebExchange(request, response, this.sessionManager,
getCodecConfigurer(), getLocaleContextResolver(), this.applicationContext, this.defaultHtmlEscape);
getCodecConfigurer(), getLocaleContextResolver(), this.applicationContext);
}
/**
spring-web/src/main/java/org/springframework/web/server/adapter/WebHttpHandlerBuilder.java
+43 -40
View File
@@ -91,8 +91,6 @@ public final class WebHttpHandlerBuilder {
private final List<WebExceptionHandler> exceptionHandlers = new ArrayList<>();
private @Nullable Boolean defaultHtmlEscape;
private @Nullable Function<HttpHandler, HttpHandler> httpHandlerDecorator;
private @Nullable WebSessionManager sessionManager;
@@ -107,6 +105,8 @@ public final class WebHttpHandlerBuilder {
private @Nullable ServerRequestObservationConvention observationConvention;
private @Nullable Boolean defaultHtmlEscape;
/**
* Private constructor to use when initialized from an ApplicationContext.
@@ -125,13 +125,13 @@ public final class WebHttpHandlerBuilder {
this.applicationContext = other.applicationContext;
this.filters.addAll(other.filters);
this.exceptionHandlers.addAll(other.exceptionHandlers);
this.httpHandlerDecorator = other.httpHandlerDecorator;
this.sessionManager = other.sessionManager;
this.codecConfigurer = other.codecConfigurer;
this.localeContextResolver = other.localeContextResolver;
this.forwardedHeaderTransformer = other.forwardedHeaderTransformer;
this.observationRegistry = other.observationRegistry;
this.observationConvention = other.observationConvention;
this.httpHandlerDecorator = other.httpHandlerDecorator;
this.defaultHtmlEscape = other.defaultHtmlEscape;
}
@@ -271,6 +271,31 @@ public final class WebHttpHandlerBuilder {
return this;
}
/**
* Configure a {@link Function} to decorate the {@link HttpHandler} returned
* by this builder which effectively wraps the entire
* {@link WebExceptionHandler} - {@link WebFilter} - {@link WebHandler}
* processing chain. This provides access to the request and response before
* the entire chain and likewise the ability to observe the result of
* the entire chain.
* @param handlerDecorator the decorator to apply
* @since 5.3
*/
public WebHttpHandlerBuilder httpHandlerDecorator(Function<HttpHandler, HttpHandler> handlerDecorator) {
this.httpHandlerDecorator = (this.httpHandlerDecorator != null ?
handlerDecorator.andThen(this.httpHandlerDecorator) : handlerDecorator);
return this;
}
/**
* Whether a decorator for {@link HttpHandler} is configured or not via
* {@link #httpHandlerDecorator(Function)}.
* @since 5.3
*/
public boolean hasHttpHandlerDecorator() {
return (this.httpHandlerDecorator != null);
}
/**
* Configure the {@link WebSessionManager} to set on the
* {@link ServerWebExchange WebServerExchange}.
@@ -292,26 +317,6 @@ public final class WebHttpHandlerBuilder {
return (this.sessionManager != null);
}
/**
* Configure a default HTML escape setting to apply to the created
* {@link org.springframework.web.server.ServerWebExchange}.
* @param defaultHtmlEscape whether to enable default HTML escaping
* @return this builder
* @since 7.0.6
*/
public WebHttpHandlerBuilder defaultHtmlEscape(Boolean defaultHtmlEscape) {
this.defaultHtmlEscape = defaultHtmlEscape;
return this;
}
/**
* Return whether a default HTML escape setting has been configured.
* @since 7.0.6
*/
public boolean hasDefaultHtmlEscape() {
return (this.defaultHtmlEscape != null);
}
/**
* Configure the {@link ServerCodecConfigurer} to set on the {@code WebServerExchange}.
* @param codecConfigurer the codec configurer
@@ -394,28 +399,26 @@ public final class WebHttpHandlerBuilder {
}
/**
* Configure a {@link Function} to decorate the {@link HttpHandler} returned
* by this builder which effectively wraps the entire
* {@link WebExceptionHandler} - {@link WebFilter} - {@link WebHandler}
* processing chain. This provides access to the request and response before
* the entire chain and likewise the ability to observe the result of
* the entire chain.
* @param handlerDecorator the decorator to apply
* @since 5.3
* Configure whether default HTML escaping is enabled for the web application.
* The setting is then exposed as the exchanger attribute
* {@link ServerWebExchange#HTML_ESCAPE_ATTRIBUTE}.
* <p>This method differentiates between no setting specified at all and
* an actual boolean value specified, allowing to have a context-specific
* default in case of no setting at the global level.
* @param defaultHtmlEscape whether to enable default HTML escaping
* @since 7.0.6
*/
public WebHttpHandlerBuilder httpHandlerDecorator(Function<HttpHandler, HttpHandler> handlerDecorator) {
this.httpHandlerDecorator = (this.httpHandlerDecorator != null ?
handlerDecorator.andThen(this.httpHandlerDecorator) : handlerDecorator);
public WebHttpHandlerBuilder defaultHtmlEscape(@Nullable Boolean defaultHtmlEscape) {
this.defaultHtmlEscape = defaultHtmlEscape;
return this;
}
/**
* Whether a decorator for {@link HttpHandler} is configured or not via
* {@link #httpHandlerDecorator(Function)}.
* @since 5.3
* Whether HTML escaping is enabled for the web application.
* @since 7.0.6
*/
public boolean hasHttpHandlerDecorator() {
return (this.httpHandlerDecorator != null);
public @Nullable Boolean getDefaultHtmlEscape() {
return this.defaultHtmlEscape;
}
/**
@@ -447,7 +450,7 @@ public final class WebHttpHandlerBuilder {
if (this.applicationContext != null) {
adapted.setApplicationContext(this.applicationContext);
}
if(this.defaultHtmlEscape != null) {
if (this.defaultHtmlEscape != null) {
adapted.setDefaultHtmlEscape(this.defaultHtmlEscape);
}
adapted.afterPropertiesSet();
spring-web/src/test/java/org/springframework/web/server/adapter/WebHttpHandlerBuilderTests.java
+31 -42
View File
@@ -127,48 +127,6 @@ class WebHttpHandlerBuilderTests {
assertThat(((HttpWebHandlerAdapter) builder.clone().build()).getApplicationContext()).isSameAs(context);
}
@Test
void defaultHtmlEscape() {
HttpHandler httpHandler = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.defaultHtmlEscape(true)
.build();
assertThat(httpHandler).isInstanceOf(HttpWebHandlerAdapter.class);
assertThat(((HttpWebHandlerAdapter) httpHandler).getDefaultHtmlEscape()).isTrue();
}
@Test
void defaultHtmlEscapeSetToFalse() {
HttpHandler httpHandler = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.defaultHtmlEscape(false)
.build();
assertThat(httpHandler).isInstanceOf(HttpWebHandlerAdapter.class);
assertThat(((HttpWebHandlerAdapter) httpHandler).getDefaultHtmlEscape()).isFalse();
}
@Test
void defaultHtmlEscapeNotConfigured() {
HttpHandler httpHandler = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.build();
assertThat(httpHandler).isInstanceOf(HttpWebHandlerAdapter.class);
assertThat(((HttpWebHandlerAdapter) httpHandler).getDefaultHtmlEscape()).isNull();
}
@Test
void cloneWithDefaultHtmlEscape() {
WebHttpHandlerBuilder builder = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.defaultHtmlEscape(true);
assertThat(((HttpWebHandlerAdapter) builder.build()).getDefaultHtmlEscape()).isTrue();
assertThat(((HttpWebHandlerAdapter) builder.clone().build()).getDefaultHtmlEscape()).isTrue();
}
@Test
void httpHandlerDecorator() {
BiFunction<ServerHttpRequest, String, ServerHttpRequest> mutator =
@@ -224,6 +182,37 @@ class WebHttpHandlerBuilderTests {
.isInstanceOf(NoUniqueBeanDefinitionException.class);
}
@Test
void defaultHtmlEscape() {
HttpHandler httpHandler = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.defaultHtmlEscape(true)
.build();
assertThat(httpHandler).isInstanceOf(HttpWebHandlerAdapter.class);
assertThat(((HttpWebHandlerAdapter) httpHandler).getDefaultHtmlEscape()).isTrue();
}
@Test
void defaultHtmlEscapeNotConfigured() {
HttpHandler httpHandler = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.build();
assertThat(httpHandler).isInstanceOf(HttpWebHandlerAdapter.class);
assertThat(((HttpWebHandlerAdapter) httpHandler).getDefaultHtmlEscape()).isNull();
}
@Test
void cloneWithDefaultHtmlEscape() {
WebHttpHandlerBuilder builder = WebHttpHandlerBuilder
.webHandler(exchange -> Mono.empty())
.defaultHtmlEscape(true);
assertThat(((HttpWebHandlerAdapter) builder.build()).getDefaultHtmlEscape()).isTrue();
assertThat(((HttpWebHandlerAdapter) builder.clone().build()).getDefaultHtmlEscape()).isTrue();
}
private static Mono<Void> writeToResponse(ServerWebExchange exchange, String value) {
byte[] bytes = value.getBytes(StandardCharsets.UTF_8);
DataBuffer buffer = DefaultDataBufferFactory.sharedInstance.wrap(bytes);
spring-web/src/testFixtures/java/org/springframework/web/testfixture/server/MockServerWebExchange.java
+3 -15
View File
@@ -40,9 +40,9 @@ import org.springframework.web.testfixture.http.server.reactive.MockServerHttpRe
public final class MockServerWebExchange extends DefaultServerWebExchange {
private MockServerWebExchange(MockServerHttpRequest request, WebSessionManager sessionManager, Boolean defaultHtmlEscape) {
private MockServerWebExchange(MockServerHttpRequest request, WebSessionManager sessionManager) {
super(request, new MockServerHttpResponse(), sessionManager,
ServerCodecConfigurer.create(), new AcceptHeaderLocaleContextResolver(), null, defaultHtmlEscape);
ServerCodecConfigurer.create(), new AcceptHeaderLocaleContextResolver(), null);
}
@@ -101,8 +101,6 @@ public final class MockServerWebExchange extends DefaultServerWebExchange {
private @Nullable WebSessionManager sessionManager;
private @Nullable Boolean defaultHtmlEscape;
public Builder(MockServerHttpRequest request) {
this.request = request;
@@ -129,22 +127,12 @@ public final class MockServerWebExchange extends DefaultServerWebExchange {
return this;
}
/**
* Configure the default HTML escaping setting for the exchange.
* @param defaultHtmlEscape the default HTML escaping setting to use
* @since 7.0.6
*/
public Builder defaultHtmlEscape(boolean defaultHtmlEscape) {
this.defaultHtmlEscape = defaultHtmlEscape;
return this;
}
/**
* Build the {@code MockServerWebExchange} instance.
*/
public MockServerWebExchange build() {
return new MockServerWebExchange(this.request,
this.sessionManager != null ? this.sessionManager : new DefaultWebSessionManager(), this.defaultHtmlEscape);
this.sessionManager != null ? this.sessionManager : new DefaultWebSessionManager());
}
}
spring-webflux/src/main/java/org/springframework/web/reactive/function/server/DefaultServerRequestBuilder.java
-5
View File
@@ -434,11 +434,6 @@ class DefaultServerRequestBuilder implements ServerRequest.Builder {
return this.delegate.getApplicationContext();
}
@Override
public @Nullable Boolean getDefaultHtmlEscape() {
return this.delegate.getDefaultHtmlEscape();
}
@Override
public boolean isNotModified() {
return this.delegate.isNotModified();
spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java
+1 -1
View File
@@ -94,7 +94,7 @@ public class RequestContext {
tzaLocaleContext.getTimeZone() : null);
this.timeZone = (timeZone != null ? timeZone : TimeZone.getDefault());
this.defaultHtmlEscape = exchange.getDefaultHtmlEscape() != null ? exchange.getDefaultHtmlEscape() : false;
this.defaultHtmlEscape = exchange.getAttribute(ServerWebExchange.HTML_ESCAPE_ATTRIBUTE);
this.dataValueProcessor = dataValueProcessor;
}
spring-webflux/src/test/java/org/springframework/web/reactive/result/view/RequestContextTests.java
+6 -28
View File
@@ -23,6 +23,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.context.support.GenericApplicationContext;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.testfixture.http.server.reactive.MockServerHttpRequest;
import org.springframework.web.testfixture.server.MockServerWebExchange;
@@ -76,42 +77,19 @@ class RequestContextTests {
@Test
void defaultHtmlEscapeNotConfigured() {
RequestContext context = new RequestContext(this.exchange, this.model, this.applicationContext);
assertThat(context.getDefaultHtmlEscape()).isFalse();
assertThat(context.getDefaultHtmlEscape()).isNull();
assertThat(context.isDefaultHtmlEscape()).isFalse();
}
@Test
void defaultHtmlEscapeSetToTrue() {
void defaultHtmlEscape() {
MockServerWebExchange exchange = MockServerWebExchange.builder(
MockServerHttpRequest.get("/foo/path").contextPath("/foo"))
.defaultHtmlEscape(true)
.build();
MockServerHttpRequest.get("/foo/path").contextPath("/foo")).build();
exchange.getAttributes().put(ServerWebExchange.HTML_ESCAPE_ATTRIBUTE, true);
RequestContext context = new RequestContext(exchange, this.model, this.applicationContext);
assertThat(context.getDefaultHtmlEscape()).isTrue();
assertThat(context.isDefaultHtmlEscape()).isTrue();
}
@Test
void defaultHtmlEscapeSetToFalse() {
MockServerWebExchange exchange = MockServerWebExchange.builder(
MockServerHttpRequest.get("/foo/path").contextPath("/foo"))
.defaultHtmlEscape(false)
.build();
RequestContext context = new RequestContext(exchange, this.model, this.applicationContext);
assertThat(context.getDefaultHtmlEscape()).isFalse();
assertThat(context.isDefaultHtmlEscape()).isFalse();
}
@Test
void defaultHtmlEscapeOverriddenPerRequest() {
MockServerWebExchange exchange = MockServerWebExchange.builder(
MockServerHttpRequest.get("/foo/path").contextPath("/foo"))
.defaultHtmlEscape(true)
.build();
RequestContext context = new RequestContext(exchange, this.model, this.applicationContext);
context.setDefaultHtmlEscape(false);
assertThat(context.getDefaultHtmlEscape()).isFalse();
assertThat(context.isDefaultHtmlEscape()).isFalse();
}
}