spring/spring-framework
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-framework.git synced 2026-09-22 22:19:03 +00:00
Code Issues Projects Releases Wiki Activity

Introduce queryParamPredicate in AbstractRequestLoggingFilter

Browse Source 
Closes gh-35603

Signed-off-by: Simone Conte <conte@adobe.com>
This commit is contained in:
Simone Conte
2025-10-11 13:29:05 +02:00
committed by Sam Brannen
parent 080bca0b23
commit 87a7507e3a
2 changed files with 51 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
spring-web/src/main/java/org/springframework/web/filter/AbstractRequestLoggingFilter.java
+47
View File
@@ -31,8 +31,11 @@ import org.jspecify.annotations.Nullable;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.util.Assert;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
import org.springframework.web.util.ContentCachingRequestWrapper;
import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.web.util.WebUtils;
/**
@@ -99,6 +102,8 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
private boolean includePayload = false;
private @Nullable Predicate<String> queryParamPredicate;
private @Nullable Predicate<String> headerPredicate;
private int maxPayloadLength = DEFAULT_MAX_PAYLOAD_LENGTH;
@@ -182,6 +187,30 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
return this.includePayload;
}
/**
* Configure a predicate for selecting which query params should be logged if
* {@link #setIncludeQueryString(boolean)} is set to {@code true}.
* <p>By default this is not set in which case all query params are logged
*
* <p>If there are multiple values for the same query param,
* the predicate will be applied once per query param name.
* As a result, the use of this predicate may result in a different query string
* than the one returned by {@link HttpServletRequest#getQueryString()}.
* @param queryParamPredicate the predicate to use
* @since 7.0
*/
public void setQueryParamPredicate(@Nullable Predicate<String> queryParamPredicate) {
this.queryParamPredicate = queryParamPredicate;
}
/**
* The configured {@link #setQueryParamPredicate(Predicate) queryParamPredicate}.
* @since 7.0
*/
protected @Nullable Predicate<String> getQueryParamPredicate() {
return this.queryParamPredicate;
}
/**
* Configure a predicate for selecting which headers should be logged if
* {@link #setIncludeHeaders(boolean)} is set to {@code true}.
@@ -326,6 +355,24 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
if (isIncludeQueryString()) {
String queryString = request.getQueryString();
if (queryString != null) {
if (getQueryParamPredicate() != null) {
MultiValueMap<String, String> queryParams = UriComponentsBuilder.fromUriString("?" + queryString)
.build()
.getQueryParams();
MultiValueMap<String, String> updatedQueryParams = new LinkedMultiValueMap<>(queryParams);
for (String name : queryParams.keySet()) {
if (!getQueryParamPredicate().test(name)) {
updatedQueryParams.set(name, "masked");
break;
}
}
queryString = UriComponentsBuilder.newInstance()
.queryParams(updatedQueryParams)
.build()
.getQuery();
}
msg.append('?').append(queryString);
}
}