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

Polish "Add missing attributes to FilterRegistration annotation"

Browse Source 
See gh-45005
This commit is contained in:
Moritz Halbritter
2025-04-10 12:21:32 +02:00
parent 17d579f374
commit 65de53066d
3 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/FilterRegistration.java
View File

@@ -104,10 +104,10 @@ public @interface FilterRegistration {
String[] servletNames() default {};
/**
* Servlet types that the filter will be registered against.
* @return the servlet types
* Servlet classes that the filter will be registered against.
* @return the servlet classes
*/
Class<?>[] servletRegistrationBeans() default {};
Class<?>[] servletClasses() default {};
/**
* URL patterns, as defined in the Servlet specification, that the filter will be

3
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/servlet/ServletContextInitializerBeans.java
View File

@@ -367,9 +367,8 @@ public class ServletContextInitializerBeans extends AbstractCollection<ServletCo
for (WebInitParam param : registration.initParameters()) {
bean.addInitParameter(param.name(), param.value());
}
this.beanFactory.getBeanProvider(ServletRegistrationBean.class).forEach((servletRegistrationBean) -> {
for (Class<?> servletClass : registration.servletRegistrationBeans()) {
for (Class<?> servletClass : registration.servletClasses()) {
if (servletClass.isInstance(servletRegistrationBean.getServlet())) {
bean.addServletRegistrationBeans(servletRegistrationBean);
}

16
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/servlet/ServletContextInitializerBeansTests.java
View File

@@ -18,6 +18,7 @@ package org.springframework.boot.web.servlet;
import java.util.Collection;
import java.util.EnumSet;
import java.util.Map;
import jakarta.servlet.DispatcherType;
import jakarta.servlet.Filter;
@@ -144,8 +145,8 @@ class ServletContextInitializerBeansTests {
assertThat(filterRegistrationBean.getServletNames()).containsExactly("test");
assertThat(filterRegistrationBean.determineDispatcherTypes()).containsExactly(DispatcherType.ERROR);
assertThat(filterRegistrationBean.getUrlPatterns()).containsExactly("/test/*");
assertThat(filterRegistrationBean.getInitParameters()).containsEntry("env", "test")
.containsEntry("debug", "true");
assertThat(filterRegistrationBean.getInitParameters())
.containsExactlyInAnyOrderEntriesOf(Map.of("env", "test", "debug", "true"));
Collection<ServletRegistrationBean<?>> servletRegistrationBeans = filterRegistrationBean
.getServletRegistrationBeans();
assertThat(servletRegistrationBeans).hasSize(1);
@@ -305,12 +306,11 @@ class ServletContextInitializerBeansTests {
static class FilterConfigurationWithAnnotation {
@Bean
@FilterRegistration(enabled = false, name = "test", asyncSupported = false,
dispatcherTypes = DispatcherType.ERROR, matchAfter = true, servletNames = "test",
urlPatterns = "/test/*",
initParameters = { @WebInitParam(name = "env", value = "test"),
@WebInitParam(name = "debug", value = "true") },
servletRegistrationBeans = { TestServlet.class })
@FilterRegistration(
enabled = false, name = "test", asyncSupported = false, dispatcherTypes = DispatcherType.ERROR,
matchAfter = true, servletNames = "test", urlPatterns = "/test/*", initParameters = {
@WebInitParam(name = "env", value = "test"), @WebInitParam(name = "debug", value = "true") },
servletClasses = { TestServlet.class })
TestFilter testFilter() {
return new TestFilter();
}